3 * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
8 @brief Elementary Widget Library
13 @image html elementary.png
17 @section intro What is Elementary?
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
22 It is meant to make the programmers work almost brainless but give them lots
25 @li @ref Start - Go here to quickly get started with writing Apps
27 @section organization Organization
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers which hold the widgets.
34 @section license License
36 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
37 all files in the source tree.
39 @section ack Acknowledgements
40 There is a lot that goes into making a widget set, and they don't happen out of
41 nothing. It's like trying to make everyone everywhere happy, regardless of age,
42 gender, race or nationality - and that is really tough. So thanks to people and
43 organisations behind this, as listed in the @ref authors page.
48 * @defgroup Start Getting Started
50 * To write an Elementary app, you can get started with the following:
53 #include <Elementary.h>
55 elm_main(int argc, char **argv)
57 // create window(s) here and do any application init
58 elm_run(); // run main loop
59 elm_shutdown(); // after mainloop finishes running, shutdown
60 return 0; // exit 0 for exit code
65 * To use autotools (which helps in many ways in the long run, like being able
66 * to immediately create releases of your software directly from your tree
67 * and ensure everything needed to build it is there) you will need a
68 * configure.ac, Makefile.am and autogen.sh file.
73 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
75 AC_CONFIG_SRCDIR(configure.ac)
76 AM_CONFIG_HEADER(config.h)
78 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
79 PKG_CHECK_MODULES([ELEMENTARY], elementary)
86 AUTOMAKE_OPTIONS = 1.4 foreign
87 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
89 INCLUDES = -I$(top_srcdir)
93 myapp_SOURCES = main.c
94 myapp_LDADD = @ELEMENTARY_LIBS@
95 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
102 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
103 echo "Running autoheader..." ; autoheader || exit 1
104 echo "Running autoconf..." ; autoconf || exit 1
105 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
109 * To generate all the things needed to bootstrap just run:
115 * This will generate Makefile.in's, the confgure script and everything else.
116 * After this it works like all normal autotools projects:
123 * Note sudo was assumed to get root permissions, as this would install in
124 * /usr/local which is system-owned. Use any way you like to gain root, or
125 * specify a different prefix with configure:
128 ./confiugre --prefix=$HOME/mysoftware
131 * Also remember that autotools buys you some useful commands like:
136 * This uninstalls the software after it was installed with "make install".
137 * It is very useful to clear up what you built if you wish to clean the
144 * This firstly checks if your build tree is "clean" and ready for
145 * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
146 * ready to upload and distribute to the world, that contains the generated
147 * Makefile.in's and configure script. The users do not need to run
148 * autogen.sh - just configure and on. They don't need autotools installed.
149 * This tarball also builds cleanly, has all the sources it needs to build
150 * included (that is sources for your application, not libraries it depends
151 * on like Elementary). It builds cleanly in a buildroot and does not
152 * contain any files that are temporarily generated like binaries and other
153 * build-generated files, so the tarball is clean, and no need to worry
154 * about cleaning up your tree before packaging.
160 * This cleans up all build files (binaries, objects etc.) from the tree.
166 * This cleans out all files from the build and from configure's output too.
169 make maintainer-clean
172 * This deletes all the files autogen.sh will produce so the tree is clean
173 * to be put into a revision-control system (like CVS, SVN or GIT for example).
175 * There is a more advanced way of making use of the quicklaunch infrastructure
176 * in Elementary (which will not be covered here due to its more advanced
179 * Now let's actually create an interactive "Hello World" gui that you can
180 * click the ok button to exit. It's more code because this now does something
181 * much more significant, but it's still very simple:
184 #include <Elementary.h>
187 on_done(void *data, Evas_Object *obj, void *event_info)
189 // quit the mainloop (elm_run function will return)
194 elm_main(int argc, char **argv)
196 Evas_Object *win, *bg, *box, *lab, *btn;
198 // new window - do the usual and give it a name (hello) and title (Hello)
199 win = elm_win_util_standard_add("hello", "Hello");
200 // when the user clicks "close" on a window there is a request to delete
201 evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
203 // add a box object - default is vertical. a box holds children in a row,
204 // either horizontally or vertically. nothing more.
205 box = elm_box_add(win);
206 // make the box hotizontal
207 elm_box_horizontal_set(box, EINA_TRUE);
208 // add object as a resize object for the window (controls window minimum
209 // size as well as gets resized if window is resized)
210 elm_win_resize_object_add(win, box);
211 evas_object_show(box);
213 // add a label widget, set the text and put it in the pad frame
214 lab = elm_label_add(win);
215 // set default text of the label
216 elm_object_text_set(lab, "Hello out there world!");
217 // pack the label at the end of the box
218 elm_box_pack_end(box, lab);
219 evas_object_show(lab);
222 btn = elm_button_add(win);
223 // set default text of button to "OK"
224 elm_object_text_set(btn, "OK");
225 // pack the button at the end of the box
226 elm_box_pack_end(box, btn);
227 evas_object_show(btn);
228 // call on_done when button is clicked
229 evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
231 // now we are done, show the window
232 evas_object_show(win);
234 // run the mainloop and process events and callbacks
244 @page authors Authors
245 @author Carsten Haitzler <raster@@rasterman.com>
246 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
247 @author Cedric Bail <cedric.bail@@free.fr>
248 @author Vincent Torri <vtorri@@univ-evry.fr>
249 @author Daniel Kolesa <quaker66@@gmail.com>
250 @author Jaime Thomas <avi.thomas@@gmail.com>
251 @author Swisscom - http://www.swisscom.ch/
252 @author Christopher Michael <devilhorns@@comcast.net>
253 @author Marco Trevisan (TreviƱo) <mail@@3v1n0.net>
254 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
255 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
256 @author Brian Wang <brian.wang.0721@@gmail.com>
257 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
258 @author Samsung Electronics <tbd>
259 @author Samsung SAIT <tbd>
260 @author Brett Nash <nash@@nash.id.au>
261 @author Bruno Dilly <bdilly@@profusion.mobi>
262 @author Rafael Fonseca <rfonseca@@profusion.mobi>
263 @author Chuneon Park <hermet@@hermet.pe.kr>
264 @author Woohyun Jung <wh0705.jung@@samsung.com>
265 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
266 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
267 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
268 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
269 @author Gustavo Lima Chaves <glima@@profusion.mobi>
270 @author Fabiano FidĆŖncio <fidencio@@profusion.mobi>
271 @author Tiago FalcĆ£o <tiago@@profusion.mobi>
272 @author Otavio Pontes <otavio@@profusion.mobi>
273 @author Viktor Kojouharov <vkojouharov@@gmail.com>
274 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
275 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
276 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
277 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
278 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
279 @author Jihoon Kim <jihoon48.kim@@samsung.com>
280 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
281 @author Tom Hacohen <tom@@stosb.com>
282 @author Aharon Hillel <a.hillel@@partner.samsung.com>
283 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
284 @author Shinwoo Kim <kimcinoo@@gmail.com>
285 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
286 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
287 @author Sung W. Park <sungwoo@gmail.com>
288 @author Thierry el Borgi <thierry@substantiel.fr>
289 @author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
290 @author Chanwook Jung <joey.jung@samsung.com>
291 @author Hyoyoung Chang <hyoyoung.chang@samsung.com>
292 @author Guillaume "Kuri" Friloux <guillaume.friloux@asp64.com>
293 @author Kim Yunhan <spbear@gmail.com>
295 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
296 contact with the developers and maintainers.
304 * @brief Elementary's API
309 @ELM_UNIX_DEF@ ELM_UNIX
310 @ELM_WIN32_DEF@ ELM_WIN32
311 @ELM_WINCE_DEF@ ELM_WINCE
312 @ELM_EDBUS_DEF@ ELM_EDBUS
313 @ELM_EFREET_DEF@ ELM_EFREET
314 @ELM_ETHUMB_DEF@ ELM_ETHUMB
315 @ELM_WEB_DEF@ ELM_WEB
316 @ELM_EMAP_DEF@ ELM_EMAP
317 @ELM_DEBUG_DEF@ ELM_DEBUG
318 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
319 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
321 /* Standard headers for standard system calls etc. */
326 #include <sys/types.h>
327 #include <sys/stat.h>
328 #include <sys/time.h>
329 #include <sys/param.h>
342 # ifdef ELM_LIBINTL_H
343 # include <libintl.h>
354 #if defined (ELM_WIN32) || defined (ELM_WINCE)
357 # define alloca _alloca
368 #include <Ecore_Evas.h>
369 #include <Ecore_File.h>
370 #include <Ecore_IMF.h>
371 #include <Ecore_Con.h>
380 # include <Efreet_Mime.h>
381 # include <Efreet_Trash.h>
385 # include <Ethumb_Client.h>
397 # ifdef ELEMENTARY_BUILD
399 # define EAPI __declspec(dllexport)
402 # endif /* ! DLL_EXPORT */
404 # define EAPI __declspec(dllimport)
405 # endif /* ! EFL_EVAS_BUILD */
409 # define EAPI __attribute__ ((visibility("default")))
416 #endif /* ! _WIN32 */
421 # define EAPI_MAIN EAPI
424 /* allow usage from c++ */
429 #define ELM_VERSION_MAJOR @VMAJ@
430 #define ELM_VERSION_MINOR @VMIN@
432 typedef struct _Elm_Version
440 EAPI extern Elm_Version *elm_version;
443 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
444 #define ELM_PI 3.14159265358979323846
447 * @defgroup General General
449 * @brief General Elementary API. Functions that don't relate to
450 * Elementary objects specifically.
452 * Here are documented functions which init/shutdown the library,
453 * that apply to generic Elementary objects, that deal with
454 * configuration, et cetera.
456 * @ref general_functions_example_page "This" example contemplates
457 * some of these functions.
461 * @addtogroup General
466 * Defines couple of standard Evas_Object layers to be used
467 * with evas_object_layer_set().
469 * @note whenever extending with new values, try to keep some padding
470 * to siblings so there is room for further extensions.
472 typedef enum _Elm_Object_Layer
474 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
475 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
476 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
477 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
478 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
479 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
482 /**************************************************************************/
483 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
486 * Emitted when any Elementary's policy value is changed.
488 EAPI extern int ELM_EVENT_POLICY_CHANGED;
491 * @typedef Elm_Event_Policy_Changed
493 * Data on the event when an Elementary policy has changed
495 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
498 * @struct _Elm_Event_Policy_Changed
500 * Data on the event when an Elementary policy has changed
502 struct _Elm_Event_Policy_Changed
504 unsigned int policy; /**< the policy identifier */
505 int new_value; /**< value the policy had before the change */
506 int old_value; /**< new value the policy got */
510 * Policy identifiers.
512 typedef enum _Elm_Policy
514 ELM_POLICY_QUIT, /**< under which circumstances the application
515 * should quit automatically. @see
519 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
522 typedef enum _Elm_Policy_Quit
524 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
526 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
528 * window is closed */
529 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
531 typedef enum _Elm_Focus_Direction
535 } Elm_Focus_Direction;
537 typedef enum _Elm_Text_Format
539 ELM_TEXT_FORMAT_PLAIN_UTF8,
540 ELM_TEXT_FORMAT_MARKUP_UTF8
544 * Line wrapping types.
546 typedef enum _Elm_Wrap_Type
548 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
549 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
550 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
551 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
557 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
558 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
559 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
560 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
561 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
562 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
563 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
564 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
565 ELM_INPUT_PANEL_LAYOUT_INVALID
566 } Elm_Input_Panel_Layout;
570 ELM_AUTOCAPITAL_TYPE_NONE,
571 ELM_AUTOCAPITAL_TYPE_WORD,
572 ELM_AUTOCAPITAL_TYPE_SENTENCE,
573 ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
574 } Elm_Autocapital_Type;
577 * @typedef Elm_Object_Item
578 * An Elementary Object item handle.
581 typedef struct _Elm_Object_Item Elm_Object_Item;
585 * Called back when a widget's tooltip is activated and needs content.
586 * @param data user-data given to elm_object_tooltip_content_cb_set()
587 * @param obj owner widget.
589 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj);
592 * Called back when a widget's item tooltip is activated and needs content.
593 * @param data user-data given to elm_object_tooltip_content_cb_set()
594 * @param obj owner widget.
595 * @param item context dependent item. As an example, if tooltip was
596 * set on Elm_List_Item, then it is of this type.
598 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, void *item);
600 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
602 #ifndef ELM_LIB_QUICKLAUNCH
603 #define ELM_MAIN() int main(int argc, char **argv) {elm_init(argc, argv); return elm_main(argc, argv);} /**< macro to be used after the elm_main() function */
605 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
608 /**************************************************************************/
612 * Initialize Elementary
614 * @param[in] argc System's argument count value
615 * @param[in] argv System's pointer to array of argument strings
616 * @return The init counter value.
618 * This function initializes Elementary and increments a counter of
619 * the number of calls to it. It returns the new counter's value.
621 * @warning This call is exported only for use by the @c ELM_MAIN()
622 * macro. There is no need to use this if you use this macro (which
623 * is highly advisable). An elm_main() should contain the entry
624 * point code for your application, having the same prototype as
625 * elm_init(), and @b not being static (putting the @c EAPI symbol
626 * in front of its type declaration is advisable). The @c
627 * ELM_MAIN() call should be placed just after it.
630 * @dontinclude bg_example_01.c
634 * See the full @ref bg_example_01_c "example".
636 * @see elm_shutdown().
639 EAPI int elm_init(int argc, char **argv);
642 * Shut down Elementary
644 * @return The init counter value.
646 * This should be called at the end of your application, just
647 * before it ceases to do any more processing. This will clean up
648 * any permanent resources your application may have allocated via
649 * Elementary that would otherwise persist.
651 * @see elm_init() for an example
655 EAPI int elm_shutdown(void);
658 * Run Elementary's main loop
660 * This call should be issued just after all initialization is
661 * completed. This function will not return until elm_exit() is
662 * called. It will keep looping, running the main
663 * (event/processing) loop for Elementary.
665 * @see elm_init() for an example
669 EAPI void elm_run(void);
672 * Exit Elementary's main loop
674 * If this call is issued, it will flag the main loop to cease
675 * processing and return back to its parent function (usually your
676 * elm_main() function).
678 * @see elm_init() for an example. There, just after a request to
679 * close the window comes, the main loop will be left.
681 * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
682 * applications, you'll be able to get this function called automatically for you.
686 EAPI void elm_exit(void);
689 * Provide information in order to make Elementary determine the @b
690 * run time location of the software in question, so other data files
691 * such as images, sound files, executable utilities, libraries,
692 * modules and locale files can be found.
694 * @param mainfunc This is your application's main function name,
695 * whose binary's location is to be found. Providing @c NULL
696 * will make Elementary not to use it
697 * @param dom This will be used as the application's "domain", in the
698 * form of a prefix to any environment variables that may
699 * override prefix detection and the directory name, inside the
700 * standard share or data directories, where the software's
701 * data files will be looked for.
702 * @param checkfile This is an (optional) magic file's path to check
703 * for existence (and it must be located in the data directory,
704 * under the share directory provided above). Its presence will
705 * help determine the prefix found was correct. Pass @c NULL if
706 * the check is not to be done.
708 * This function allows one to re-locate the application somewhere
709 * else after compilation, if the developer wishes for easier
710 * distribution of pre-compiled binaries.
712 * The prefix system is designed to locate where the given software is
713 * installed (under a common path prefix) at run time and then report
714 * specific locations of this prefix and common directories inside
715 * this prefix like the binary, library, data and locale directories,
716 * through the @c elm_app_*_get() family of functions.
718 * Call elm_app_info_set() early on before you change working
719 * directory or anything about @c argv[0], so it gets accurate
722 * It will then try and trace back which file @p mainfunc comes from,
723 * if provided, to determine the application's prefix directory.
725 * The @p dom parameter provides a string prefix to prepend before
726 * environment variables, allowing a fallback to @b specific
727 * environment variables to locate the software. You would most
728 * probably provide a lowercase string there, because it will also
729 * serve as directory domain, explained next. For environment
730 * variables purposes, this string is made uppercase. For example if
731 * @c "myapp" is provided as the prefix, then the program would expect
732 * @c "MYAPP_PREFIX" as a master environment variable to specify the
733 * exact install prefix for the software, or more specific environment
734 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
735 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
736 * the user or scripts before launching. If not provided (@c NULL),
737 * environment variables will not be used to override compiled-in
738 * defaults or auto detections.
740 * The @p dom string also provides a subdirectory inside the system
741 * shared data directory for data files. For example, if the system
742 * directory is @c /usr/local/share, then this directory name is
743 * appended, creating @c /usr/local/share/myapp, if it @p was @c
744 * "myapp". It is expected that the application installs data files in
747 * The @p checkfile is a file name or path of something inside the
748 * share or data directory to be used to test that the prefix
749 * detection worked. For example, your app will install a wallpaper
750 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
751 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
754 * @see elm_app_compile_bin_dir_set()
755 * @see elm_app_compile_lib_dir_set()
756 * @see elm_app_compile_data_dir_set()
757 * @see elm_app_compile_locale_set()
758 * @see elm_app_prefix_dir_get()
759 * @see elm_app_bin_dir_get()
760 * @see elm_app_lib_dir_get()
761 * @see elm_app_data_dir_get()
762 * @see elm_app_locale_dir_get()
764 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
767 * Provide information on the @b fallback application's binaries
768 * directory, in scenarios where they get overriden by
769 * elm_app_info_set().
771 * @param dir The path to the default binaries directory (compile time
774 * @note Elementary will as well use this path to determine actual
775 * names of binaries' directory paths, maybe changing it to be @c
776 * something/local/bin instead of @c something/bin, only, for
779 * @warning You should call this function @b before
780 * elm_app_info_set().
782 EAPI void elm_app_compile_bin_dir_set(const char *dir);
785 * Provide information on the @b fallback application's libraries
786 * directory, on scenarios where they get overriden by
787 * elm_app_info_set().
789 * @param dir The path to the default libraries directory (compile
792 * @note Elementary will as well use this path to determine actual
793 * names of libraries' directory paths, maybe changing it to be @c
794 * something/lib32 or @c something/lib64 instead of @c something/lib,
797 * @warning You should call this function @b before
798 * elm_app_info_set().
800 EAPI void elm_app_compile_lib_dir_set(const char *dir);
803 * Provide information on the @b fallback application's data
804 * directory, on scenarios where they get overriden by
805 * elm_app_info_set().
807 * @param dir The path to the default data directory (compile time
810 * @note Elementary will as well use this path to determine actual
811 * names of data directory paths, maybe changing it to be @c
812 * something/local/share instead of @c something/share, only, for
815 * @warning You should call this function @b before
816 * elm_app_info_set().
818 EAPI void elm_app_compile_data_dir_set(const char *dir);
821 * Provide information on the @b fallback application's locale
822 * directory, on scenarios where they get overriden by
823 * elm_app_info_set().
825 * @param dir The path to the default locale directory (compile time
828 * @warning You should call this function @b before
829 * elm_app_info_set().
831 EAPI void elm_app_compile_locale_set(const char *dir);
834 * Retrieve the application's run time prefix directory, as set by
835 * elm_app_info_set() and the way (environment) the application was
838 * @return The directory prefix the application is actually using.
840 EAPI const char *elm_app_prefix_dir_get(void);
843 * Retrieve the application's run time binaries prefix directory, as
844 * set by elm_app_info_set() and the way (environment) the application
847 * @return The binaries directory prefix the application is actually
850 EAPI const char *elm_app_bin_dir_get(void);
853 * Retrieve the application's run time libraries prefix directory, as
854 * set by elm_app_info_set() and the way (environment) the application
857 * @return The libraries directory prefix the application is actually
860 EAPI const char *elm_app_lib_dir_get(void);
863 * Retrieve the application's run time data prefix directory, as
864 * set by elm_app_info_set() and the way (environment) the application
867 * @return The data directory prefix the application is actually
870 EAPI const char *elm_app_data_dir_get(void);
873 * Retrieve the application's run time locale prefix directory, as
874 * set by elm_app_info_set() and the way (environment) the application
877 * @return The locale directory prefix the application is actually
880 EAPI const char *elm_app_locale_dir_get(void);
882 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
883 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
884 EAPI int elm_quicklaunch_init(int argc, char **argv);
885 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
886 EAPI int elm_quicklaunch_sub_shutdown(void);
887 EAPI int elm_quicklaunch_shutdown(void);
888 EAPI void elm_quicklaunch_seed(void);
889 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
890 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
891 EAPI void elm_quicklaunch_cleanup(void);
892 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
893 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
895 EAPI Eina_Bool elm_need_efreet(void);
896 EAPI Eina_Bool elm_need_e_dbus(void);
899 * This must be called before any other function that deals with
900 * elm_thumb objects or ethumb_client instances.
904 EAPI Eina_Bool elm_need_ethumb(void);
907 * This must be called before any other function that deals with
908 * elm_web objects or ewk_view instances.
912 EAPI Eina_Bool elm_need_web(void);
915 * Set a new policy's value (for a given policy group/identifier).
917 * @param policy policy identifier, as in @ref Elm_Policy.
918 * @param value policy value, which depends on the identifier
920 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
922 * Elementary policies define applications' behavior,
923 * somehow. These behaviors are divided in policy groups (see
924 * #Elm_Policy enumeration). This call will emit the Ecore event
925 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
926 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
929 * @note Currently, we have only one policy identifier/group
930 * (#ELM_POLICY_QUIT), which has two possible values.
934 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
937 * Gets the policy value for given policy identifier.
939 * @param policy policy identifier, as in #Elm_Policy.
940 * @return The currently set policy value, for that
941 * identifier. Will be @c 0 if @p policy passed is invalid.
945 EAPI int elm_policy_get(unsigned int policy);
948 * Change the language of the current application
950 * The @p lang passed must be the full name of the locale to use, for
951 * example "en_US.utf8" or "es_ES@euro".
953 * Changing language with this function will make Elementary run through
954 * all its widgets, translating strings set with
955 * elm_object_domain_translatable_text_part_set(). This way, an entire
956 * UI can have its language changed without having to restart the program.
958 * For more complex cases, like having formatted strings that need
959 * translation, widgets will also emit a "language,changed" signal that
960 * the user can listen to to manually translate the text.
962 * @param lang Language to set, must be the full name of the locale
966 EAPI void elm_language_set(const char *lang);
969 * Set a label of an object
971 * @param obj The Elementary object
972 * @param part The text part name to set (NULL for the default label)
973 * @param label The new text of the label
975 * @note Elementary objects may have many labels (e.g. Action Slider)
976 * @deprecated Use elm_object_part_text_set() instead.
979 EINA_DEPRECATED EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
982 * Set a label of an object
984 * @param obj The Elementary object
985 * @param part The text part name to set (NULL for the default label)
986 * @param label The new text of the label
988 * @note Elementary objects may have many labels (e.g. Action Slider)
992 EAPI void elm_object_part_text_set(Evas_Object *obj, const char *part, const char *label);
994 #define elm_object_text_set(obj, label) elm_object_part_text_set((obj), NULL, (label))
997 * Get a label of an object
999 * @param obj The Elementary object
1000 * @param part The text part name to get (NULL for the default label)
1001 * @return text of the label or NULL for any error
1003 * @note Elementary objects may have many labels (e.g. Action Slider)
1004 * @deprecated Use elm_object_part_text_get() instead.
1007 EINA_DEPRECATED EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
1010 * Get a label of an object
1012 * @param obj The Elementary object
1013 * @param part The text part name to get (NULL for the default label)
1014 * @return text of the label or NULL for any error
1016 * @note Elementary objects may have many labels (e.g. Action Slider)
1020 EAPI const char *elm_object_part_text_get(const Evas_Object *obj, const char *part);
1022 #define elm_object_text_get(obj) elm_object_part_text_get((obj), NULL)
1025 * Set the text for an objects' part, marking it as translatable.
1027 * The string to set as @p text must be the original one. Do not pass the
1028 * return of @c gettext() here. Elementary will translate the string
1029 * internally and set it on the object using elm_object_part_text_set(),
1030 * also storing the original string so that it can be automatically
1031 * translated when the language is changed with elm_language_set().
1033 * The @p domain will be stored along to find the translation in the
1034 * correct catalog. It can be NULL, in which case it will use whatever
1035 * domain was set by the application with @c textdomain(). This is useful
1036 * in case you are building a library on top of Elementary that will have
1037 * its own translatable strings, that should not be mixed with those of
1038 * programs using the library.
1040 * @param obj The object containing the text part
1041 * @param part The name of the part to set
1042 * @param domain The translation domain to use
1043 * @param text The original, non-translated text to set
1047 EAPI void elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1049 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1051 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1054 * Gets the original string set as translatable for an object
1056 * When setting translated strings, the function elm_object_part_text_get()
1057 * will return the translation returned by @c gettext(). To get the
1058 * original string use this function.
1060 * @param obj The object
1061 * @param part The name of the part that was set
1063 * @return The original, untranslated string
1067 EAPI const char *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1069 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1072 * Set a content of an object
1074 * @param obj The Elementary object
1075 * @param part The content part name to set (NULL for the default content)
1076 * @param content The new content of the object
1078 * @note Elementary objects may have many contents
1079 * @deprecated Use elm_object_part_content_set instead.
1082 EINA_DEPRECATED EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1085 * Set a content of an object
1087 * @param obj The Elementary object
1088 * @param part The content part name to set (NULL for the default content)
1089 * @param content The new content of the object
1091 * @note Elementary objects may have many contents
1095 EAPI void elm_object_part_content_set(Evas_Object *obj, const char *part, Evas_Object *content);
1097 #define elm_object_content_set(obj, content) elm_object_part_content_set((obj), NULL, (content))
1100 * Get a content of an object
1102 * @param obj The Elementary object
1103 * @param item The content part name to get (NULL for the default content)
1104 * @return content of the object or NULL for any error
1106 * @note Elementary objects may have many contents
1107 * @deprecated Use elm_object_part_content_get instead.
1110 EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1113 * Get a content of an object
1115 * @param obj The Elementary object
1116 * @param item The content part name to get (NULL for the default content)
1117 * @return content of the object or NULL for any error
1119 * @note Elementary objects may have many contents
1123 EAPI Evas_Object *elm_object_part_content_get(const Evas_Object *obj, const char *part);
1125 #define elm_object_content_get(obj) elm_object_part_content_get((obj), NULL)
1128 * Unset a content of an object
1130 * @param obj The Elementary object
1131 * @param item The content part name to unset (NULL for the default content)
1133 * @note Elementary objects may have many contents
1134 * @deprecated Use elm_object_part_content_unset instead.
1137 EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1140 * Unset a content of an object
1142 * @param obj The Elementary object
1143 * @param item The content part name to unset (NULL for the default content)
1145 * @note Elementary objects may have many contents
1149 EAPI Evas_Object *elm_object_part_content_unset(Evas_Object *obj, const char *part);
1151 #define elm_object_content_unset(obj) elm_object_part_content_unset((obj), NULL)
1154 * Get the widget object's handle which contains a given item
1156 * @param item The Elementary object item
1157 * @return The widget object
1159 * @note This returns the widget object itself that an item belongs to.
1163 EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1166 * Set a content of an object item
1168 * @param it The Elementary object item
1169 * @param part The content part name to set (NULL for the default content)
1170 * @param content The new content of the object item
1172 * @note Elementary object items may have many contents
1176 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1178 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1181 * Get a content of an object item
1183 * @param it The Elementary object item
1184 * @param part The content part name to unset (NULL for the default content)
1185 * @return content of the object item or NULL for any error
1187 * @note Elementary object items may have many contents
1191 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1193 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1196 * Unset a content of an object item
1198 * @param it The Elementary object item
1199 * @param part The content part name to unset (NULL for the default content)
1201 * @note Elementary object items may have many contents
1205 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1207 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1210 * Set a label of an object item
1212 * @param it The Elementary object item
1213 * @param part The text part name to set (NULL for the default label)
1214 * @param label The new text of the label
1216 * @note Elementary object items may have many labels
1220 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1222 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1225 * Get a label of an object item
1227 * @param it The Elementary object item
1228 * @param part The text part name to get (NULL for the default label)
1229 * @return text of the label or NULL for any error
1231 * @note Elementary object items may have many labels
1235 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1238 * Set the text to read out when in accessibility mode
1240 * @param obj The object which is to be described
1241 * @param txt The text that describes the widget to people with poor or no vision
1245 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1248 * Set the text to read out when in accessibility mode
1250 * @param it The object item which is to be described
1251 * @param txt The text that describes the widget to people with poor or no vision
1255 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1258 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1261 * Set the text to read out when in accessibility mode
1263 * @param obj The object which is to be described
1264 * @param txt The text that describes the widget to people with poor or no vision
1268 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1271 * Set the text to read out when in accessibility mode
1273 * @param it The object item which is to be described
1274 * @param txt The text that describes the widget to people with poor or no vision
1278 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1281 * Get the data associated with an object item
1282 * @param it The Elementary object item
1283 * @return The data associated with @p it
1287 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1290 * Set the data associated with an object item
1291 * @param it The Elementary object item
1292 * @param data The data to be associated with @p it
1296 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1299 * Send a signal to the edje object of the widget item.
1301 * This function sends a signal to the edje object of the obj item. An
1302 * edje program can respond to a signal by specifying matching
1303 * 'signal' and 'source' fields.
1305 * @param it The Elementary object item
1306 * @param emission The signal's name.
1307 * @param source The signal's source.
1310 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1317 * @defgroup Caches Caches
1319 * These are functions which let one fine-tune some cache values for
1320 * Elementary applications, thus allowing for performance adjustments.
1326 * @brief Flush all caches.
1328 * Frees all data that was in cache and is not currently being used to reduce
1329 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1330 * to calling all of the following functions:
1331 * @li edje_file_cache_flush()
1332 * @li edje_collection_cache_flush()
1333 * @li eet_clearcache()
1334 * @li evas_image_cache_flush()
1335 * @li evas_font_cache_flush()
1336 * @li evas_render_dump()
1337 * @note Evas caches are flushed for every canvas associated with a window.
1341 EAPI void elm_all_flush(void);
1344 * Get the configured cache flush interval time
1346 * This gets the globally configured cache flush interval time, in
1349 * @return The cache flush interval time
1352 * @see elm_all_flush()
1354 EAPI int elm_cache_flush_interval_get(void);
1357 * Set the configured cache flush interval time
1359 * This sets the globally configured cache flush interval time, in ticks
1361 * @param size The cache flush interval time
1364 * @see elm_all_flush()
1366 EAPI void elm_cache_flush_interval_set(int size);
1369 * Set the configured cache flush interval time for all applications on the
1372 * This sets the globally configured cache flush interval time -- in ticks
1373 * -- for all applications on the display.
1375 * @param size The cache flush interval time
1378 EAPI void elm_cache_flush_interval_all_set(int size);
1381 * Get the configured cache flush enabled state
1383 * This gets the globally configured cache flush state - if it is enabled
1384 * or not. When cache flushing is enabled, elementary will regularly
1385 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1386 * memory and allow usage to re-seed caches and data in memory where it
1387 * can do so. An idle application will thus minimise its memory usage as
1388 * data will be freed from memory and not be re-loaded as it is idle and
1389 * not rendering or doing anything graphically right now.
1391 * @return The cache flush state
1394 * @see elm_all_flush()
1396 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1399 * Set the configured cache flush enabled state
1401 * This sets the globally configured cache flush enabled state.
1403 * @param size The cache flush enabled state
1406 * @see elm_all_flush()
1408 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1411 * Set the configured cache flush enabled state for all applications on the
1414 * This sets the globally configured cache flush enabled state for all
1415 * applications on the display.
1417 * @param size The cache flush enabled state
1420 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1423 * Get the configured font cache size
1425 * This gets the globally configured font cache size, in bytes.
1427 * @return The font cache size
1430 EAPI int elm_font_cache_get(void);
1433 * Set the configured font cache size
1435 * This sets the globally configured font cache size, in bytes
1437 * @param size The font cache size
1440 EAPI void elm_font_cache_set(int size);
1443 * Set the configured font cache size for all applications on the
1446 * This sets the globally configured font cache size -- in bytes
1447 * -- for all applications on the display.
1449 * @param size The font cache size
1452 EAPI void elm_font_cache_all_set(int size);
1455 * Get the configured image cache size
1457 * This gets the globally configured image cache size, in bytes
1459 * @return The image cache size
1462 EAPI int elm_image_cache_get(void);
1465 * Set the configured image cache size
1467 * This sets the globally configured image cache size, in bytes
1469 * @param size The image cache size
1472 EAPI void elm_image_cache_set(int size);
1475 * Set the configured image cache size for all applications on the
1478 * This sets the globally configured image cache size -- in bytes
1479 * -- for all applications on the display.
1481 * @param size The image cache size
1484 EAPI void elm_image_cache_all_set(int size);
1487 * Get the configured edje file cache size.
1489 * This gets the globally configured edje file cache size, in number
1492 * @return The edje file cache size
1495 EAPI int elm_edje_file_cache_get(void);
1498 * Set the configured edje file cache size
1500 * This sets the globally configured edje file cache size, in number
1503 * @param size The edje file cache size
1506 EAPI void elm_edje_file_cache_set(int size);
1509 * Set the configured edje file cache size for all applications on the
1512 * This sets the globally configured edje file cache size -- in number
1513 * of files -- for all applications on the display.
1515 * @param size The edje file cache size
1518 EAPI void elm_edje_file_cache_all_set(int size);
1521 * Get the configured edje collections (groups) cache size.
1523 * This gets the globally configured edje collections cache size, in
1524 * number of collections.
1526 * @return The edje collections cache size
1529 EAPI int elm_edje_collection_cache_get(void);
1532 * Set the configured edje collections (groups) cache size
1534 * This sets the globally configured edje collections cache size, in
1535 * number of collections.
1537 * @param size The edje collections cache size
1540 EAPI void elm_edje_collection_cache_set(int size);
1543 * Set the configured edje collections (groups) cache size for all
1544 * applications on the display
1546 * This sets the globally configured edje collections cache size -- in
1547 * number of collections -- for all applications on the display.
1549 * @param size The edje collections cache size
1552 EAPI void elm_edje_collection_cache_all_set(int size);
1559 * @defgroup Scaling Widget Scaling
1561 * Different widgets can be scaled independently. These functions
1562 * allow you to manipulate this scaling on a per-widget basis. The
1563 * object and all its children get their scaling factors multiplied
1564 * by the scale factor set. This is multiplicative, in that if a
1565 * child also has a scale size set it is in turn multiplied by its
1566 * parent's scale size. @c 1.0 means ādon't scaleā, @c 2.0 is
1567 * double size, @c 0.5 is half, etc.
1569 * @ref general_functions_example_page "This" example contemplates
1570 * some of these functions.
1574 * Get the global scaling factor
1576 * This gets the globally configured scaling factor that is applied to all
1579 * @return The scaling factor
1582 EAPI double elm_scale_get(void);
1585 * Set the global scaling factor
1587 * This sets the globally configured scaling factor that is applied to all
1590 * @param scale The scaling factor to set
1593 EAPI void elm_scale_set(double scale);
1596 * Set the global scaling factor for all applications on the display
1598 * This sets the globally configured scaling factor that is applied to all
1599 * objects for all applications.
1600 * @param scale The scaling factor to set
1603 EAPI void elm_scale_all_set(double scale);
1606 * Set the scaling factor for a given Elementary object
1608 * @param obj The Elementary to operate on
1609 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1614 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1617 * Get the scaling factor for a given Elementary object
1619 * @param obj The object
1620 * @return The scaling factor set by elm_object_scale_set()
1624 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1627 * @defgroup Password_last_show Password last input show
1629 * Last show feature of password mode enables user to view
1630 * the last input entered for few seconds before masking it.
1631 * These functions allow to set this feature in password mode
1632 * of entry widget and also allow to manipulate the duration
1633 * for which the input has to be visible.
1639 * Get show last setting of password mode.
1641 * This gets the show last input setting of password mode which might be
1642 * enabled or disabled.
1644 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1646 * @ingroup Password_last_show
1648 EAPI Eina_Bool elm_password_show_last_get(void);
1651 * Set show last setting in password mode.
1653 * This enables or disables show last setting of password mode.
1655 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1656 * @see elm_password_show_last_timeout_set()
1657 * @ingroup Password_last_show
1659 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1662 * Get's the timeout value in last show password mode.
1664 * This gets the time out value for which the last input entered in password
1665 * mode will be visible.
1667 * @return The timeout value of last show password mode.
1668 * @ingroup Password_last_show
1670 EAPI double elm_password_show_last_timeout_get(void);
1673 * Set's the timeout value in last show password mode.
1675 * This sets the time out value for which the last input entered in password
1676 * mode will be visible.
1678 * @param password_show_last_timeout The timeout value.
1679 * @see elm_password_show_last_set()
1680 * @ingroup Password_last_show
1682 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1689 * @defgroup UI-Mirroring Selective Widget mirroring
1691 * These functions allow you to set ui-mirroring on specific
1692 * widgets or the whole interface. Widgets can be in one of two
1693 * modes, automatic and manual. Automatic means they'll be changed
1694 * according to the system mirroring mode and manual means only
1695 * explicit changes will matter. You are not supposed to change
1696 * mirroring state of a widget set to automatic, will mostly work,
1697 * but the behavior is not really defined.
1702 EAPI Eina_Bool elm_mirrored_get(void);
1703 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1706 * Get the system mirrored mode. This determines the default mirrored mode
1709 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1711 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1714 * Set the system mirrored mode. This determines the default mirrored mode
1717 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1719 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1722 * Returns the widget's mirrored mode setting.
1724 * @param obj The widget.
1725 * @return mirrored mode setting of the object.
1728 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1731 * Sets the widget's mirrored mode setting.
1732 * When widget in automatic mode, it follows the system mirrored mode set by
1733 * elm_mirrored_set().
1734 * @param obj The widget.
1735 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1737 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1744 * Set the style to use by a widget
1746 * Sets the style name that will define the appearance of a widget. Styles
1747 * vary from widget to widget and may also be defined by other themes
1748 * by means of extensions and overlays.
1750 * @param obj The Elementary widget to style
1751 * @param style The style name to use
1753 * @see elm_theme_extension_add()
1754 * @see elm_theme_extension_del()
1755 * @see elm_theme_overlay_add()
1756 * @see elm_theme_overlay_del()
1760 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1762 * Get the style used by the widget
1764 * This gets the style being used for that widget. Note that the string
1765 * pointer is only valid as longas the object is valid and the style doesn't
1768 * @param obj The Elementary widget to query for its style
1769 * @return The style name used
1771 * @see elm_object_style_set()
1775 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1778 * @defgroup Styles Styles
1780 * Widgets can have different styles of look. These generic API's
1781 * set styles of widgets, if they support them (and if the theme(s)
1784 * @ref general_functions_example_page "This" example contemplates
1785 * some of these functions.
1789 * Set the disabled state of an Elementary object.
1791 * @param obj The Elementary object to operate on
1792 * @param disabled The state to put in in: @c EINA_TRUE for
1793 * disabled, @c EINA_FALSE for enabled
1795 * Elementary objects can be @b disabled, in which state they won't
1796 * receive input and, in general, will be themed differently from
1797 * their normal state, usually greyed out. Useful for contexts
1798 * where you don't want your users to interact with some of the
1799 * parts of you interface.
1801 * This sets the state for the widget, either disabling it or
1806 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1809 * Get the disabled state of an Elementary object.
1811 * @param obj The Elementary object to operate on
1812 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1813 * if it's enabled (or on errors)
1815 * This gets the state of the widget, which might be enabled or disabled.
1819 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1822 * @defgroup WidgetNavigation Widget Tree Navigation.
1824 * How to check if an Evas Object is an Elementary widget? How to
1825 * get the first elementary widget that is parent of the given
1826 * object? These are all covered in widget tree navigation.
1828 * @ref general_functions_example_page "This" example contemplates
1829 * some of these functions.
1833 * Check if the given Evas Object is an Elementary widget.
1835 * @param obj the object to query.
1836 * @return @c EINA_TRUE if it is an elementary widget variant,
1837 * @c EINA_FALSE otherwise
1838 * @ingroup WidgetNavigation
1840 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1843 * Get the first parent of the given object that is an Elementary
1846 * @param obj the Elementary object to query parent from.
1847 * @return the parent object that is an Elementary widget, or @c
1848 * NULL, if it was not found.
1850 * Use this to query for an object's parent widget.
1852 * @note Most of Elementary users wouldn't be mixing non-Elementary
1853 * smart objects in the objects tree of an application, as this is
1854 * an advanced usage of Elementary with Evas. So, except for the
1855 * application's window, which is the root of that tree, all other
1856 * objects would have valid Elementary widget parents.
1858 * @ingroup WidgetNavigation
1860 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1863 * Get the top level parent of an Elementary widget.
1865 * @param obj The object to query.
1866 * @return The top level Elementary widget, or @c NULL if parent cannot be
1868 * @ingroup WidgetNavigation
1870 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1873 * Get the string that represents this Elementary widget.
1875 * @note Elementary is weird and exposes itself as a single
1876 * Evas_Object_Smart_Class of type "elm_widget", so
1877 * evas_object_type_get() always return that, making debug and
1878 * language bindings hard. This function tries to mitigate this
1879 * problem, but the solution is to change Elementary to use
1880 * proper inheritance.
1882 * @param obj the object to query.
1883 * @return Elementary widget name, or @c NULL if not a valid widget.
1884 * @ingroup WidgetNavigation
1886 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1889 * @defgroup Config Elementary Config
1891 * Elementary configuration is formed by a set options bounded to a
1892 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1893 * "finger size", etc. These are functions with which one syncronizes
1894 * changes made to those values to the configuration storing files, de
1895 * facto. You most probably don't want to use the functions in this
1896 * group unlees you're writing an elementary configuration manager.
1902 * Save back Elementary's configuration, so that it will persist on
1905 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1908 * This function will take effect -- thus, do I/O -- immediately. Use
1909 * it when you want to apply all configuration changes at once. The
1910 * current configuration set will get saved onto the current profile
1911 * configuration file.
1914 EAPI Eina_Bool elm_config_save(void);
1917 * Reload Elementary's configuration, bounded to current selected
1920 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1923 * Useful when you want to force reloading of configuration values for
1924 * a profile. If one removes user custom configuration directories,
1925 * for example, it will force a reload with system values instead.
1928 EAPI void elm_config_reload(void);
1935 * @defgroup Profile Elementary Profile
1937 * Profiles are pre-set options that affect the whole look-and-feel of
1938 * Elementary-based applications. There are, for example, profiles
1939 * aimed at desktop computer applications and others aimed at mobile,
1940 * touchscreen-based ones. You most probably don't want to use the
1941 * functions in this group unlees you're writing an elementary
1942 * configuration manager.
1948 * Get Elementary's profile in use.
1950 * This gets the global profile that is applied to all Elementary
1953 * @return The profile's name
1956 EAPI const char *elm_profile_current_get(void);
1959 * Get an Elementary's profile directory path in the filesystem. One
1960 * may want to fetch a system profile's dir or an user one (fetched
1963 * @param profile The profile's name
1964 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1965 * or a system one (@c EINA_FALSE)
1966 * @return The profile's directory path.
1969 * @note You must free it with elm_profile_dir_free().
1971 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1974 * Free an Elementary's profile directory path, as returned by
1975 * elm_profile_dir_get().
1977 * @param p_dir The profile's path
1981 EAPI void elm_profile_dir_free(const char *p_dir);
1984 * Get Elementary's list of available profiles.
1986 * @return The profiles list. List node data are the profile name
1990 * @note One must free this list, after usage, with the function
1991 * elm_profile_list_free().
1993 EAPI Eina_List *elm_profile_list_get(void);
1996 * Free Elementary's list of available profiles.
1998 * @param l The profiles list, as returned by elm_profile_list_get().
2002 EAPI void elm_profile_list_free(Eina_List *l);
2005 * Set Elementary's profile.
2007 * This sets the global profile that is applied to Elementary
2008 * applications. Just the process the call comes from will be
2011 * @param profile The profile's name
2015 EAPI void elm_profile_set(const char *profile);
2018 * Set Elementary's profile.
2020 * This sets the global profile that is applied to all Elementary
2021 * applications. All running Elementary windows will be affected.
2023 * @param profile The profile's name
2027 EAPI void elm_profile_all_set(const char *profile);
2034 * @defgroup Engine Elementary Engine
2036 * These are functions setting and querying which rendering engine
2037 * Elementary will use for drawing its windows' pixels.
2039 * The following are the available engines:
2040 * @li "software_x11"
2043 * @li "software_16_x11"
2044 * @li "software_8_x11"
2047 * @li "software_gdi"
2048 * @li "software_16_wince_gdi"
2050 * @li "software_16_sdl"
2054 * @li "opengl_cocoa"
2061 * @brief Get Elementary's rendering engine in use.
2063 * @return The rendering engine's name
2064 * @note there's no need to free the returned string, here.
2066 * This gets the global rendering engine that is applied to all Elementary
2069 * @see elm_engine_set()
2071 EAPI const char *elm_engine_current_get(void);
2074 * @brief Set Elementary's rendering engine for use.
2076 * @param engine The rendering engine's name
2078 * This sets global rendering engine that is applied to all Elementary
2079 * applications. Note that it will take effect only to Elementary windows
2080 * created after this is called.
2082 * @see elm_win_add()
2084 EAPI void elm_engine_set(const char *engine);
2091 * @defgroup Fonts Elementary Fonts
2093 * These are functions dealing with font rendering, selection and the
2094 * like for Elementary applications. One might fetch which system
2095 * fonts are there to use and set custom fonts for individual classes
2096 * of UI items containing text (text classes).
2101 typedef struct _Elm_Text_Class
2107 typedef struct _Elm_Font_Overlay
2109 const char *text_class;
2111 Evas_Font_Size size;
2114 typedef struct _Elm_Font_Properties
2118 } Elm_Font_Properties;
2121 * Get Elementary's list of supported text classes.
2123 * @return The text classes list, with @c Elm_Text_Class blobs as data.
2126 * Release the list with elm_text_classes_list_free().
2128 EAPI const Eina_List *elm_text_classes_list_get(void);
2131 * Free Elementary's list of supported text classes.
2135 * @see elm_text_classes_list_get().
2137 EAPI void elm_text_classes_list_free(const Eina_List *list);
2140 * Get Elementary's list of font overlays, set with
2141 * elm_font_overlay_set().
2143 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2148 * For each text class, one can set a <b>font overlay</b> for it,
2149 * overriding the default font properties for that class coming from
2150 * the theme in use. There is no need to free this list.
2152 * @see elm_font_overlay_set() and elm_font_overlay_unset().
2154 EAPI const Eina_List *elm_font_overlay_list_get(void);
2157 * Set a font overlay for a given Elementary text class.
2159 * @param text_class Text class name
2160 * @param font Font name and style string
2161 * @param size Font size
2165 * @p font has to be in the format returned by
2166 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2167 * and elm_font_overlay_unset().
2169 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2172 * Unset a font overlay for a given Elementary text class.
2174 * @param text_class Text class name
2178 * This will bring back text elements belonging to text class
2179 * @p text_class back to their default font settings.
2181 EAPI void elm_font_overlay_unset(const char *text_class);
2184 * Apply the changes made with elm_font_overlay_set() and
2185 * elm_font_overlay_unset() on the current Elementary window.
2189 * This applies all font overlays set to all objects in the UI.
2191 EAPI void elm_font_overlay_apply(void);
2194 * Apply the changes made with elm_font_overlay_set() and
2195 * elm_font_overlay_unset() on all Elementary application windows.
2199 * This applies all font overlays set to all objects in the UI.
2201 EAPI void elm_font_overlay_all_apply(void);
2204 * Translate a font (family) name string in fontconfig's font names
2205 * syntax into an @c Elm_Font_Properties struct.
2207 * @param font The font name and styles string
2208 * @return the font properties struct
2212 * @note The reverse translation can be achived with
2213 * elm_font_fontconfig_name_get(), for one style only (single font
2214 * instance, not family).
2216 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2219 * Free font properties return by elm_font_properties_get().
2221 * @param efp the font properties struct
2225 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2228 * Translate a font name, bound to a style, into fontconfig's font names
2231 * @param name The font (family) name
2232 * @param style The given style (may be @c NULL)
2234 * @return the font name and style string
2238 * @note The reverse translation can be achived with
2239 * elm_font_properties_get(), for one style only (single font
2240 * instance, not family).
2242 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2245 * Free the font string return by elm_font_fontconfig_name_get().
2247 * @param efp the font properties struct
2251 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2254 * Create a font hash table of available system fonts.
2256 * One must call it with @p list being the return value of
2257 * evas_font_available_list(). The hash will be indexed by font
2258 * (family) names, being its values @c Elm_Font_Properties blobs.
2260 * @param list The list of available system fonts, as returned by
2261 * evas_font_available_list().
2262 * @return the font hash.
2266 * @note The user is supposed to get it populated at least with 3
2267 * default font families (Sans, Serif, Monospace), which should be
2268 * present on most systems.
2270 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2273 * Free the hash return by elm_font_available_hash_add().
2275 * @param hash the hash to be freed.
2279 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2286 * @defgroup Fingers Fingers
2288 * Elementary is designed to be finger-friendly for touchscreens,
2289 * and so in addition to scaling for display resolution, it can
2290 * also scale based on finger "resolution" (or size). You can then
2291 * customize the granularity of the areas meant to receive clicks
2294 * Different profiles may have pre-set values for finger sizes.
2296 * @ref general_functions_example_page "This" example contemplates
2297 * some of these functions.
2303 * Get the configured "finger size"
2305 * @return The finger size
2307 * This gets the globally configured finger size, <b>in pixels</b>
2311 EAPI Evas_Coord elm_finger_size_get(void);
2314 * Set the configured finger size
2316 * This sets the globally configured finger size in pixels
2318 * @param size The finger size
2321 EAPI void elm_finger_size_set(Evas_Coord size);
2324 * Set the configured finger size for all applications on the display
2326 * This sets the globally configured finger size in pixels for all
2327 * applications on the display
2329 * @param size The finger size
2332 EAPI void elm_finger_size_all_set(Evas_Coord size);
2339 * @defgroup Focus Focus
2341 * An Elementary application has, at all times, one (and only one)
2342 * @b focused object. This is what determines where the input
2343 * events go to within the application's window. Also, focused
2344 * objects can be decorated differently, in order to signal to the
2345 * user where the input is, at a given moment.
2347 * Elementary applications also have the concept of <b>focus
2348 * chain</b>: one can cycle through all the windows' focusable
2349 * objects by input (tab key) or programmatically. The default
2350 * focus chain for an application is the one define by the order in
2351 * which the widgets where added in code. One will cycle through
2352 * top level widgets, and, for each one containg sub-objects, cycle
2353 * through them all, before returning to the level
2354 * above. Elementary also allows one to set @b custom focus chains
2355 * for their applications.
2357 * Besides the focused decoration a widget may exhibit, when it
2358 * gets focus, Elementary has a @b global focus highlight object
2359 * that can be enabled for a window. If one chooses to do so, this
2360 * extra highlight effect will surround the current focused object,
2363 * @note Some Elementary widgets are @b unfocusable, after
2364 * creation, by their very nature: they are not meant to be
2365 * interacted with input events, but are there just for visual
2368 * @ref general_functions_example_page "This" example contemplates
2369 * some of these functions.
2373 * Get the enable status of the focus highlight
2375 * This gets whether the highlight on focused objects is enabled or not
2378 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2381 * Set the enable status of the focus highlight
2383 * Set whether to show or not the highlight on focused objects
2384 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2387 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2390 * Get the enable status of the highlight animation
2392 * Get whether the focus highlight, if enabled, will animate its switch from
2393 * one object to the next
2396 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2399 * Set the enable status of the highlight animation
2401 * Set whether the focus highlight, if enabled, will animate its switch from
2402 * one object to the next
2403 * @param animate Enable animation if EINA_TRUE, disable otherwise
2406 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2409 * Get the whether an Elementary object has the focus or not.
2411 * @param obj The Elementary object to get the information from
2412 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2413 * not (and on errors).
2415 * @see elm_object_focus_set()
2419 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2422 * Set/unset focus to a given Elementary object.
2424 * @param obj The Elementary object to operate on.
2425 * @param enable @c EINA_TRUE Set focus to a given object,
2426 * @c EINA_FALSE Unset focus to a given object.
2428 * @note When you set focus to this object, if it can handle focus, will
2429 * take the focus away from the one who had it previously and will, for
2430 * now on, be the one receiving input events. Unsetting focus will remove
2431 * the focus from @p obj, passing it back to the previous element in the
2434 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2438 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2441 * Make a given Elementary object the focused one.
2443 * @param obj The Elementary object to make focused.
2445 * @note This object, if it can handle focus, will take the focus
2446 * away from the one who had it previously and will, for now on, be
2447 * the one receiving input events.
2449 * @see elm_object_focus_get()
2453 EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2456 * Remove the focus from an Elementary object
2458 * @param obj The Elementary to take focus from
2460 * This removes the focus from @p obj, passing it back to the
2461 * previous element in the focus chain list.
2463 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2467 EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2470 * Set the ability for an Element object to be focused
2472 * @param obj The Elementary object to operate on
2473 * @param enable @c EINA_TRUE if the object can be focused, @c
2474 * EINA_FALSE if not (and on errors)
2476 * This sets whether the object @p obj is able to take focus or
2477 * not. Unfocusable objects do nothing when programmatically
2478 * focused, being the nearest focusable parent object the one
2479 * really getting focus. Also, when they receive mouse input, they
2480 * will get the event, but not take away the focus from where it
2485 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2488 * Get whether an Elementary object is focusable or not
2490 * @param obj The Elementary object to operate on
2491 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2492 * EINA_FALSE if not (and on errors)
2494 * @note Objects which are meant to be interacted with by input
2495 * events are created able to be focused, by default. All the
2500 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2503 * Set custom focus chain.
2505 * This function overwrites any previous custom focus chain within
2506 * the list of objects. The previous list will be deleted and this list
2507 * will be managed by elementary. After it is set, don't modify it.
2509 * @note On focus cycle, only will be evaluated children of this container.
2511 * @param obj The container object
2512 * @param objs Chain of objects to pass focus
2515 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2518 * Unset a custom focus chain on a given Elementary widget
2520 * @param obj The container object to remove focus chain from
2522 * Any focus chain previously set on @p obj (for its child objects)
2523 * is removed entirely after this call.
2527 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2530 * Get custom focus chain
2532 * @param obj The container object
2535 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2538 * Append object to custom focus chain.
2540 * @note If relative_child equal to NULL or not in custom chain, the object
2541 * will be added in end.
2543 * @note On focus cycle, only will be evaluated children of this container.
2545 * @param obj The container object
2546 * @param child The child to be added in custom chain
2547 * @param relative_child The relative object to position the child
2550 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2553 * Prepend object to custom focus chain.
2555 * @note If relative_child equal to NULL or not in custom chain, the object
2556 * will be added in begin.
2558 * @note On focus cycle, only will be evaluated children of this container.
2560 * @param obj The container object
2561 * @param child The child to be added in custom chain
2562 * @param relative_child The relative object to position the child
2565 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2568 * Give focus to next object in object tree.
2570 * Give focus to next object in focus chain of one object sub-tree.
2571 * If the last object of chain already have focus, the focus will go to the
2572 * first object of chain.
2574 * @param obj The object root of sub-tree
2575 * @param dir Direction to cycle the focus
2579 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2582 * Give focus to near object in one direction.
2584 * Give focus to near object in direction of one object.
2585 * If none focusable object in given direction, the focus will not change.
2587 * @param obj The reference object
2588 * @param x Horizontal component of direction to focus
2589 * @param y Vertical component of direction to focus
2593 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2596 * Make the elementary object and its children to be unfocusable
2599 * @param obj The Elementary object to operate on
2600 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2601 * @c EINA_FALSE for focusable.
2603 * This sets whether the object @p obj and its children objects
2604 * are able to take focus or not. If the tree is set as unfocusable,
2605 * newest focused object which is not in this tree will get focus.
2606 * This API can be helpful for an object to be deleted.
2607 * When an object will be deleted soon, it and its children may not
2608 * want to get focus (by focus reverting or by other focus controls).
2609 * Then, just use this API before deleting.
2611 * @see elm_object_tree_unfocusable_get()
2615 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2618 * Get whether an Elementary object and its children are unfocusable or not.
2620 * @param obj The Elementary object to get the information from
2621 * @return @c EINA_TRUE, if the tree is unfocussable,
2622 * @c EINA_FALSE if not (and on errors).
2624 * @see elm_object_tree_unfocusable_set()
2628 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2631 * @defgroup Scrolling Scrolling
2633 * These are functions setting how scrollable views in Elementary
2634 * widgets should behave on user interaction.
2640 * Get whether scrollers should bounce when they reach their
2641 * viewport's edge during a scroll.
2643 * @return the thumb scroll bouncing state
2645 * This is the default behavior for touch screens, in general.
2646 * @ingroup Scrolling
2648 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2651 * Set whether scrollers should bounce when they reach their
2652 * viewport's edge during a scroll.
2654 * @param enabled the thumb scroll bouncing state
2656 * @see elm_thumbscroll_bounce_enabled_get()
2657 * @ingroup Scrolling
2659 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2662 * Set whether scrollers should bounce when they reach their
2663 * viewport's edge during a scroll, for all Elementary application
2666 * @param enabled the thumb scroll bouncing state
2668 * @see elm_thumbscroll_bounce_enabled_get()
2669 * @ingroup Scrolling
2671 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2674 * Get the amount of inertia a scroller will impose at bounce
2677 * @return the thumb scroll bounce friction
2679 * @ingroup Scrolling
2681 EAPI double elm_scroll_bounce_friction_get(void);
2684 * Set the amount of inertia a scroller will impose at bounce
2687 * @param friction the thumb scroll bounce friction
2689 * @see elm_thumbscroll_bounce_friction_get()
2690 * @ingroup Scrolling
2692 EAPI void elm_scroll_bounce_friction_set(double friction);
2695 * Set the amount of inertia a scroller will impose at bounce
2696 * animations, for all Elementary application windows.
2698 * @param friction the thumb scroll bounce friction
2700 * @see elm_thumbscroll_bounce_friction_get()
2701 * @ingroup Scrolling
2703 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2706 * Get the amount of inertia a <b>paged</b> scroller will impose at
2707 * page fitting animations.
2709 * @return the page scroll friction
2711 * @ingroup Scrolling
2713 EAPI double elm_scroll_page_scroll_friction_get(void);
2716 * Set the amount of inertia a <b>paged</b> scroller will impose at
2717 * page fitting animations.
2719 * @param friction the page scroll friction
2721 * @see elm_thumbscroll_page_scroll_friction_get()
2722 * @ingroup Scrolling
2724 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2727 * Set the amount of inertia a <b>paged</b> scroller will impose at
2728 * page fitting animations, for all Elementary application windows.
2730 * @param friction the page scroll friction
2732 * @see elm_thumbscroll_page_scroll_friction_get()
2733 * @ingroup Scrolling
2735 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2738 * Get the amount of inertia a scroller will impose at region bring
2741 * @return the bring in scroll friction
2743 * @ingroup Scrolling
2745 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2748 * Set the amount of inertia a scroller will impose at region bring
2751 * @param friction the bring in scroll friction
2753 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2754 * @ingroup Scrolling
2756 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2759 * Set the amount of inertia a scroller will impose at region bring
2760 * animations, for all Elementary application windows.
2762 * @param friction the bring in scroll friction
2764 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2765 * @ingroup Scrolling
2767 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2770 * Get the amount of inertia scrollers will impose at animations
2771 * triggered by Elementary widgets' zooming API.
2773 * @return the zoom friction
2775 * @ingroup Scrolling
2777 EAPI double elm_scroll_zoom_friction_get(void);
2780 * Set the amount of inertia scrollers will impose at animations
2781 * triggered by Elementary widgets' zooming API.
2783 * @param friction the zoom friction
2785 * @see elm_thumbscroll_zoom_friction_get()
2786 * @ingroup Scrolling
2788 EAPI void elm_scroll_zoom_friction_set(double friction);
2791 * Set the amount of inertia scrollers will impose at animations
2792 * triggered by Elementary widgets' zooming API, for all Elementary
2793 * application windows.
2795 * @param friction the zoom friction
2797 * @see elm_thumbscroll_zoom_friction_get()
2798 * @ingroup Scrolling
2800 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2803 * Get whether scrollers should be draggable from any point in their
2806 * @return the thumb scroll state
2808 * @note This is the default behavior for touch screens, in general.
2809 * @note All other functions namespaced with "thumbscroll" will only
2810 * have effect if this mode is enabled.
2812 * @ingroup Scrolling
2814 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2817 * Set whether scrollers should be draggable from any point in their
2820 * @param enabled the thumb scroll state
2822 * @see elm_thumbscroll_enabled_get()
2823 * @ingroup Scrolling
2825 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2828 * Set whether scrollers should be draggable from any point in their
2829 * views, for all Elementary application windows.
2831 * @param enabled the thumb scroll state
2833 * @see elm_thumbscroll_enabled_get()
2834 * @ingroup Scrolling
2836 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2839 * Get the number of pixels one should travel while dragging a
2840 * scroller's view to actually trigger scrolling.
2842 * @return the thumb scroll threshould
2844 * One would use higher values for touch screens, in general, because
2845 * of their inherent imprecision.
2846 * @ingroup Scrolling
2848 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2851 * Set the number of pixels one should travel while dragging a
2852 * scroller's view to actually trigger scrolling.
2854 * @param threshold the thumb scroll threshould
2856 * @see elm_thumbscroll_threshould_get()
2857 * @ingroup Scrolling
2859 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2862 * Set the number of pixels one should travel while dragging a
2863 * scroller's view to actually trigger scrolling, for all Elementary
2864 * application windows.
2866 * @param threshold the thumb scroll threshould
2868 * @see elm_thumbscroll_threshould_get()
2869 * @ingroup Scrolling
2871 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2874 * Get the minimum speed of mouse cursor movement which will trigger
2875 * list self scrolling animation after a mouse up event
2878 * @return the thumb scroll momentum threshould
2880 * @ingroup Scrolling
2882 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2885 * Set the minimum speed of mouse cursor movement which will trigger
2886 * list self scrolling animation after a mouse up event
2889 * @param threshold the thumb scroll momentum threshould
2891 * @see elm_thumbscroll_momentum_threshould_get()
2892 * @ingroup Scrolling
2894 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2897 * Set the minimum speed of mouse cursor movement which will trigger
2898 * list self scrolling animation after a mouse up event
2899 * (pixels/second), for all Elementary application windows.
2901 * @param threshold the thumb scroll momentum threshould
2903 * @see elm_thumbscroll_momentum_threshould_get()
2904 * @ingroup Scrolling
2906 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2909 * Get the amount of inertia a scroller will impose at self scrolling
2912 * @return the thumb scroll friction
2914 * @ingroup Scrolling
2916 EAPI double elm_scroll_thumbscroll_friction_get(void);
2919 * Set the amount of inertia a scroller will impose at self scrolling
2922 * @param friction the thumb scroll friction
2924 * @see elm_thumbscroll_friction_get()
2925 * @ingroup Scrolling
2927 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
2930 * Set the amount of inertia a scroller will impose at self scrolling
2931 * animations, for all Elementary application windows.
2933 * @param friction the thumb scroll friction
2935 * @see elm_thumbscroll_friction_get()
2936 * @ingroup Scrolling
2938 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
2941 * Get the amount of lag between your actual mouse cursor dragging
2942 * movement and a scroller's view movement itself, while pushing it
2943 * into bounce state manually.
2945 * @return the thumb scroll border friction
2947 * @ingroup Scrolling
2949 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
2952 * Set the amount of lag between your actual mouse cursor dragging
2953 * movement and a scroller's view movement itself, while pushing it
2954 * into bounce state manually.
2956 * @param friction the thumb scroll border friction. @c 0.0 for
2957 * perfect synchrony between two movements, @c 1.0 for maximum
2960 * @see elm_thumbscroll_border_friction_get()
2961 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2963 * @ingroup Scrolling
2965 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
2968 * Set the amount of lag between your actual mouse cursor dragging
2969 * movement and a scroller's view movement itself, while pushing it
2970 * into bounce state manually, for all Elementary application windows.
2972 * @param friction the thumb scroll border friction. @c 0.0 for
2973 * perfect synchrony between two movements, @c 1.0 for maximum
2976 * @see elm_thumbscroll_border_friction_get()
2977 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2979 * @ingroup Scrolling
2981 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
2984 * Get the sensitivity amount which is be multiplied by the length of
2987 * @return the thumb scroll sensitivity friction
2989 * @ingroup Scrolling
2991 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
2994 * Set the sensitivity amount which is be multiplied by the length of
2997 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2998 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3001 * @see elm_thumbscroll_sensitivity_friction_get()
3002 * @note parameter value will get bound to 0.1 - 1.0 interval, always
3004 * @ingroup Scrolling
3006 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
3009 * Set the sensitivity amount which is be multiplied by the length of
3010 * mouse dragging, for all Elementary application windows.
3012 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3013 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3016 * @see elm_thumbscroll_sensitivity_friction_get()
3017 * @note parameter value will get bound to 0.1 - 1.0 interval, always
3019 * @ingroup Scrolling
3021 EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
3028 * @defgroup Scrollhints Scrollhints
3030 * Objects when inside a scroller can scroll, but this may not always be
3031 * desirable in certain situations. This allows an object to hint to itself
3032 * and parents to "not scroll" in one of 2 ways. If any child object of a
3033 * scroller has pushed a scroll freeze or hold then it affects all parent
3034 * scrollers until all children have released them.
3036 * 1. To hold on scrolling. This means just flicking and dragging may no
3037 * longer scroll, but pressing/dragging near an edge of the scroller will
3038 * still scroll. This is automatically used by the entry object when
3041 * 2. To totally freeze scrolling. This means it stops. until
3048 * Push the scroll hold by 1
3050 * This increments the scroll hold count by one. If it is more than 0 it will
3051 * take effect on the parents of the indicated object.
3053 * @param obj The object
3054 * @ingroup Scrollhints
3056 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3059 * Pop the scroll hold by 1
3061 * This decrements the scroll hold count by one. If it is more than 0 it will
3062 * take effect on the parents of the indicated object.
3064 * @param obj The object
3065 * @ingroup Scrollhints
3067 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3070 * Push the scroll freeze by 1
3072 * This increments the scroll freeze count by one. If it is more
3073 * than 0 it will take effect on the parents of the indicated
3076 * @param obj The object
3077 * @ingroup Scrollhints
3079 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3082 * Pop the scroll freeze by 1
3084 * This decrements the scroll freeze count by one. If it is more
3085 * than 0 it will take effect on the parents of the indicated
3088 * @param obj The object
3089 * @ingroup Scrollhints
3091 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3094 * Lock the scrolling of the given widget (and thus all parents)
3096 * This locks the given object from scrolling in the X axis (and implicitly
3097 * also locks all parent scrollers too from doing the same).
3099 * @param obj The object
3100 * @param lock The lock state (1 == locked, 0 == unlocked)
3101 * @ingroup Scrollhints
3103 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3106 * Lock the scrolling of the given widget (and thus all parents)
3108 * This locks the given object from scrolling in the Y axis (and implicitly
3109 * also locks all parent scrollers too from doing the same).
3111 * @param obj The object
3112 * @param lock The lock state (1 == locked, 0 == unlocked)
3113 * @ingroup Scrollhints
3115 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3118 * Get the scrolling lock of the given widget
3120 * This gets the lock for X axis scrolling.
3122 * @param obj The object
3123 * @ingroup Scrollhints
3125 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3128 * Get the scrolling lock of the given widget
3130 * This gets the lock for X axis scrolling.
3132 * @param obj The object
3133 * @ingroup Scrollhints
3135 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3142 * Send a signal to the widget edje object.
3144 * This function sends a signal to the edje object of the obj. An
3145 * edje program can respond to a signal by specifying matching
3146 * 'signal' and 'source' fields.
3148 * @param obj The object
3149 * @param emission The signal's name.
3150 * @param source The signal's source.
3153 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3156 * Add a callback for a signal emitted by widget edje object.
3158 * This function connects a callback function to a signal emitted by the
3159 * edje object of the obj.
3160 * Globs can occur in either the emission or source name.
3162 * @param obj The object
3163 * @param emission The signal's name.
3164 * @param source The signal's source.
3165 * @param func The callback function to be executed when the signal is
3167 * @param data A pointer to data to pass in to the callback function.
3170 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);
3173 * Remove a signal-triggered callback from a widget edje object.
3175 * This function removes a callback, previoulsy attached to a
3176 * signal emitted by the edje object of the obj. The parameters
3177 * emission, source and func must match exactly those passed to a
3178 * previous call to elm_object_signal_callback_add(). The data
3179 * pointer that was passed to this call will be returned.
3181 * @param obj The object
3182 * @param emission The signal's name.
3183 * @param source The signal's source.
3184 * @param func The callback function to be executed when the signal is
3186 * @return The data pointer
3189 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);
3192 * Add a callback for input events (key up, key down, mouse wheel)
3193 * on a given Elementary widget
3195 * @param obj The widget to add an event callback on
3196 * @param func The callback function to be executed when the event
3198 * @param data Data to pass in to @p func
3200 * Every widget in an Elementary interface set to receive focus,
3201 * with elm_object_focus_allow_set(), will propagate @b all of its
3202 * key up, key down and mouse wheel input events up to its parent
3203 * object, and so on. All of the focusable ones in this chain which
3204 * had an event callback set, with this call, will be able to treat
3205 * those events. There are two ways of making the propagation of
3206 * these event upwards in the tree of widgets to @b cease:
3207 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3208 * the event was @b not processed, so the propagation will go on.
3209 * - The @c event_info pointer passed to @p func will contain the
3210 * event's structure and, if you OR its @c event_flags inner
3211 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3212 * one has already handled it, thus killing the event's
3215 * @note Your event callback will be issued on those events taking
3216 * place only if no other child widget of @obj has consumed the
3219 * @note Not to be confused with @c
3220 * evas_object_event_callback_add(), which will add event callbacks
3221 * per type on general Evas objects (no event propagation
3222 * infrastructure taken in account).
3224 * @note Not to be confused with @c
3225 * elm_object_signal_callback_add(), which will add callbacks to @b
3226 * signals coming from a widget's theme, not input events.
3228 * @note Not to be confused with @c
3229 * edje_object_signal_callback_add(), which does the same as
3230 * elm_object_signal_callback_add(), but directly on an Edje
3233 * @note Not to be confused with @c
3234 * evas_object_smart_callback_add(), which adds callbacks to smart
3235 * objects' <b>smart events</b>, and not input events.
3237 * @see elm_object_event_callback_del()
3241 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3244 * Remove an event callback from a widget.
3246 * This function removes a callback, previoulsy attached to event emission
3248 * The parameters func and data must match exactly those passed to
3249 * a previous call to elm_object_event_callback_add(). The data pointer that
3250 * was passed to this call will be returned.
3252 * @param obj The object
3253 * @param func The callback function to be executed when the event is
3255 * @param data Data to pass in to the callback function.
3256 * @return The data pointer
3259 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3262 * Adjust size of an element for finger usage.
3264 * @param times_w How many fingers should fit horizontally
3265 * @param w Pointer to the width size to adjust
3266 * @param times_h How many fingers should fit vertically
3267 * @param h Pointer to the height size to adjust
3269 * This takes width and height sizes (in pixels) as input and a
3270 * size multiple (which is how many fingers you want to place
3271 * within the area, being "finger" the size set by
3272 * elm_finger_size_set()), and adjusts the size to be large enough
3273 * to accommodate the resulting size -- if it doesn't already
3274 * accommodate it. On return the @p w and @p h sizes pointed to by
3275 * these parameters will be modified, on those conditions.
3277 * @note This is kind of a low level Elementary call, most useful
3278 * on size evaluation times for widgets. An external user wouldn't
3279 * be calling, most of the time.
3283 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3286 * Get the duration for occuring long press event.
3288 * @return Timeout for long press event
3289 * @ingroup Longpress
3291 EAPI double elm_longpress_timeout_get(void);
3294 * Set the duration for occuring long press event.
3296 * @param lonpress_timeout Timeout for long press event
3297 * @ingroup Longpress
3299 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3302 * @defgroup Debug Debug
3303 * don't use it unless you are sure
3309 * Print Tree object hierarchy in stdout
3311 * @param obj The root object
3314 EAPI void elm_object_tree_dump(const Evas_Object *top);
3315 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3317 EAPI void elm_autocapitalization_allow_all_set(Eina_Bool autocap);
3318 EAPI void elm_autoperiod_allow_all_set(Eina_Bool autoperiod);
3320 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3322 * @param obj The root object
3323 * @param file The path of output file
3326 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3333 * @defgroup Theme Theme
3335 * Elementary uses Edje to theme its widgets, naturally. But for the most
3336 * part this is hidden behind a simpler interface that lets the user set
3337 * extensions and choose the style of widgets in a much easier way.
3339 * Instead of thinking in terms of paths to Edje files and their groups
3340 * each time you want to change the appearance of a widget, Elementary
3341 * works so you can add any theme file with extensions or replace the
3342 * main theme at one point in the application, and then just set the style
3343 * of widgets with elm_object_style_set() and related functions. Elementary
3344 * will then look in its list of themes for a matching group and apply it,
3345 * and when the theme changes midway through the application, all widgets
3346 * will be updated accordingly.
3348 * There are three concepts you need to know to understand how Elementary
3349 * theming works: default theme, extensions and overlays.
3351 * Default theme, obviously enough, is the one that provides the default
3352 * look of all widgets. End users can change the theme used by Elementary
3353 * by setting the @c ELM_THEME environment variable before running an
3354 * application, or globally for all programs using the @c elementary_config
3355 * utility. Applications can change the default theme using elm_theme_set(),
3356 * but this can go against the user wishes, so it's not an adviced practice.
3358 * Ideally, applications should find everything they need in the already
3359 * provided theme, but there may be occasions when that's not enough and
3360 * custom styles are required to correctly express the idea. For this
3361 * cases, Elementary has extensions.
3363 * Extensions allow the application developer to write styles of its own
3364 * to apply to some widgets. This requires knowledge of how each widget
3365 * is themed, as extensions will always replace the entire group used by
3366 * the widget, so important signals and parts need to be there for the
3367 * object to behave properly (see documentation of Edje for details).
3368 * Once the theme for the extension is done, the application needs to add
3369 * it to the list of themes Elementary will look into, using
3370 * elm_theme_extension_add(), and set the style of the desired widgets as
3371 * he would normally with elm_object_style_set().
3373 * Overlays, on the other hand, can replace the look of all widgets by
3374 * overriding the default style. Like extensions, it's up to the application
3375 * developer to write the theme for the widgets it wants, the difference
3376 * being that when looking for the theme, Elementary will check first the
3377 * list of overlays, then the set theme and lastly the list of extensions,
3378 * so with overlays it's possible to replace the default view and every
3379 * widget will be affected. This is very much alike to setting the whole
3380 * theme for the application and will probably clash with the end user
3381 * options, not to mention the risk of ending up with not matching styles
3382 * across the program. Unless there's a very special reason to use them,
3383 * overlays should be avoided for the resons exposed before.
3385 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3386 * keeps one default internally and every function that receives one of
3387 * these can be called with NULL to refer to this default (except for
3388 * elm_theme_free()). It's possible to create a new instance of a
3389 * ::Elm_Theme to set other theme for a specific widget (and all of its
3390 * children), but this is as discouraged, if not even more so, than using
3391 * overlays. Don't use this unless you really know what you are doing.
3393 * But to be less negative about things, you can look at the following
3395 * @li @ref theme_example_01 "Using extensions"
3396 * @li @ref theme_example_02 "Using overlays"
3401 * @typedef Elm_Theme
3403 * Opaque handler for the list of themes Elementary looks for when
3404 * rendering widgets.
3406 * Stay out of this unless you really know what you are doing. For most
3407 * cases, sticking to the default is all a developer needs.
3409 typedef struct _Elm_Theme Elm_Theme;
3412 * Create a new specific theme
3414 * This creates an empty specific theme that only uses the default theme. A
3415 * specific theme has its own private set of extensions and overlays too
3416 * (which are empty by default). Specific themes do not fall back to themes
3417 * of parent objects. They are not intended for this use. Use styles, overlays
3418 * and extensions when needed, but avoid specific themes unless there is no
3419 * other way (example: you want to have a preview of a new theme you are
3420 * selecting in a "theme selector" window. The preview is inside a scroller
3421 * and should display what the theme you selected will look like, but not
3422 * actually apply it yet. The child of the scroller will have a specific
3423 * theme set to show this preview before the user decides to apply it to all
3426 EAPI Elm_Theme *elm_theme_new(void);
3428 * Free a specific theme
3430 * @param th The theme to free
3432 * This frees a theme created with elm_theme_new().
3434 EAPI void elm_theme_free(Elm_Theme *th);
3436 * Copy the theme fom the source to the destination theme
3438 * @param th The source theme to copy from
3439 * @param thdst The destination theme to copy data to
3441 * This makes a one-time static copy of all the theme config, extensions
3442 * and overlays from @p th to @p thdst. If @p th references a theme, then
3443 * @p thdst is also set to reference it, with all the theme settings,
3444 * overlays and extensions that @p th had.
3446 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3448 * Tell the source theme to reference the ref theme
3450 * @param th The theme that will do the referencing
3451 * @param thref The theme that is the reference source
3453 * This clears @p th to be empty and then sets it to refer to @p thref
3454 * so @p th acts as an override to @p thref, but where its overrides
3455 * don't apply, it will fall through to @p thref for configuration.
3457 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3459 * Return the theme referred to
3461 * @param th The theme to get the reference from
3462 * @return The referenced theme handle
3464 * This gets the theme set as the reference theme by elm_theme_ref_set().
3465 * If no theme is set as a reference, NULL is returned.
3467 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3469 * Return the default theme
3471 * @return The default theme handle
3473 * This returns the internal default theme setup handle that all widgets
3474 * use implicitly unless a specific theme is set. This is also often use
3475 * as a shorthand of NULL.
3477 EAPI Elm_Theme *elm_theme_default_get(void);
3479 * Prepends a theme overlay to the list of overlays
3481 * @param th The theme to add to, or if NULL, the default theme
3482 * @param item The Edje file path to be used
3484 * Use this if your application needs to provide some custom overlay theme
3485 * (An Edje file that replaces some default styles of widgets) where adding
3486 * new styles, or changing system theme configuration is not possible. Do
3487 * NOT use this instead of a proper system theme configuration. Use proper
3488 * configuration files, profiles, environment variables etc. to set a theme
3489 * so that the theme can be altered by simple confiugration by a user. Using
3490 * this call to achieve that effect is abusing the API and will create lots
3493 * @see elm_theme_extension_add()
3495 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3497 * Delete a theme overlay from the list of overlays
3499 * @param th The theme to delete from, or if NULL, the default theme
3500 * @param item The name of the theme overlay
3502 * @see elm_theme_overlay_add()
3504 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3506 * Appends a theme extension to the list of extensions.
3508 * @param th The theme to add to, or if NULL, the default theme
3509 * @param item The Edje file path to be used
3511 * This is intended when an application needs more styles of widgets or new
3512 * widget themes that the default does not provide (or may not provide). The
3513 * application has "extended" usage by coming up with new custom style names
3514 * for widgets for specific uses, but as these are not "standard", they are
3515 * not guaranteed to be provided by a default theme. This means the
3516 * application is required to provide these extra elements itself in specific
3517 * Edje files. This call adds one of those Edje files to the theme search
3518 * path to be search after the default theme. The use of this call is
3519 * encouraged when default styles do not meet the needs of the application.
3520 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3522 * @see elm_object_style_set()
3524 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3526 * Deletes a theme extension from the list of extensions.
3528 * @param th The theme to delete from, or if NULL, the default theme
3529 * @param item The name of the theme extension
3531 * @see elm_theme_extension_add()
3533 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3535 * Set the theme search order for the given theme
3537 * @param th The theme to set the search order, or if NULL, the default theme
3538 * @param theme Theme search string
3540 * This sets the search string for the theme in path-notation from first
3541 * theme to search, to last, delimited by the : character. Example:
3543 * "shiny:/path/to/file.edj:default"
3545 * See the ELM_THEME environment variable for more information.
3547 * @see elm_theme_get()
3548 * @see elm_theme_list_get()
3550 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3552 * Return the theme search order
3554 * @param th The theme to get the search order, or if NULL, the default theme
3555 * @return The internal search order path
3557 * This function returns a colon separated string of theme elements as
3558 * returned by elm_theme_list_get().
3560 * @see elm_theme_set()
3561 * @see elm_theme_list_get()
3563 EAPI const char *elm_theme_get(Elm_Theme *th);
3565 * Return a list of theme elements to be used in a theme.
3567 * @param th Theme to get the list of theme elements from.
3568 * @return The internal list of theme elements
3570 * This returns the internal list of theme elements (will only be valid as
3571 * long as the theme is not modified by elm_theme_set() or theme is not
3572 * freed by elm_theme_free(). This is a list of strings which must not be
3573 * altered as they are also internal. If @p th is NULL, then the default
3574 * theme element list is returned.
3576 * A theme element can consist of a full or relative path to a .edj file,
3577 * or a name, without extension, for a theme to be searched in the known
3578 * theme paths for Elemementary.
3580 * @see elm_theme_set()
3581 * @see elm_theme_get()
3583 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3585 * Return the full patrh for a theme element
3587 * @param f The theme element name
3588 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3589 * @return The full path to the file found.
3591 * This returns a string you should free with free() on success, NULL on
3592 * failure. This will search for the given theme element, and if it is a
3593 * full or relative path element or a simple searchable name. The returned
3594 * path is the full path to the file, if searched, and the file exists, or it
3595 * is simply the full path given in the element or a resolved path if
3596 * relative to home. The @p in_search_path boolean pointed to is set to
3597 * EINA_TRUE if the file was a searchable file andis in the search path,
3598 * and EINA_FALSE otherwise.
3600 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3602 * Flush the current theme.
3604 * @param th Theme to flush
3606 * This flushes caches that let elementary know where to find theme elements
3607 * in the given theme. If @p th is NULL, then the default theme is flushed.
3608 * Call this function if source theme data has changed in such a way as to
3609 * make any caches Elementary kept invalid.
3611 EAPI void elm_theme_flush(Elm_Theme *th);
3613 * This flushes all themes (default and specific ones).
3615 * This will flush all themes in the current application context, by calling
3616 * elm_theme_flush() on each of them.
3618 EAPI void elm_theme_full_flush(void);
3620 * Set the theme for all elementary using applications on the current display
3622 * @param theme The name of the theme to use. Format same as the ELM_THEME
3623 * environment variable.
3625 EAPI void elm_theme_all_set(const char *theme);
3627 * Return a list of theme elements in the theme search path
3629 * @return A list of strings that are the theme element names.
3631 * This lists all available theme files in the standard Elementary search path
3632 * for theme elements, and returns them in alphabetical order as theme
3633 * element names in a list of strings. Free this with
3634 * elm_theme_name_available_list_free() when you are done with the list.
3636 EAPI Eina_List *elm_theme_name_available_list_new(void);
3638 * Free the list returned by elm_theme_name_available_list_new()
3640 * This frees the list of themes returned by
3641 * elm_theme_name_available_list_new(). Once freed the list should no longer
3642 * be used. a new list mys be created.
3644 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3646 * Set a specific theme to be used for this object and its children
3648 * @param obj The object to set the theme on
3649 * @param th The theme to set
3651 * This sets a specific theme that will be used for the given object and any
3652 * child objects it has. If @p th is NULL then the theme to be used is
3653 * cleared and the object will inherit its theme from its parent (which
3654 * ultimately will use the default theme if no specific themes are set).
3656 * Use special themes with great care as this will annoy users and make
3657 * configuration difficult. Avoid any custom themes at all if it can be
3660 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3662 * Get the specific theme to be used
3664 * @param obj The object to get the specific theme from
3665 * @return The specifc theme set.
3667 * This will return a specific theme set, or NULL if no specific theme is
3668 * set on that object. It will not return inherited themes from parents, only
3669 * the specific theme set for that specific object. See elm_object_theme_set()
3670 * for more information.
3672 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3675 * Get a data item from a theme
3677 * @param th The theme, or NULL for default theme
3678 * @param key The data key to search with
3679 * @return The data value, or NULL on failure
3681 * This function is used to return data items from edc in @p th, an overlay, or an extension.
3682 * It works the same way as edje_file_data_get() except that the return is stringshared.
3684 EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3690 /** @defgroup Win Win
3692 * @image html img/widget/win/preview-00.png
3693 * @image latex img/widget/win/preview-00.eps
3695 * The window class of Elementary. Contains functions to manipulate
3696 * windows. The Evas engine used to render the window contents is specified
3697 * in the system or user elementary config files (whichever is found last),
3698 * and can be overridden with the ELM_ENGINE environment variable for
3699 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3700 * compilation setup and modules actually installed at runtime) are (listed
3701 * in order of best supported and most likely to be complete and work to
3704 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3705 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3707 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3709 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3711 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3713 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3714 * rendering using SDL as the buffer)
3715 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3716 * GDI with software)
3717 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3718 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3719 * grayscale using dedicated 8bit software engine in X11)
3720 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3721 * X11 using 16bit software engine)
3722 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3723 * (Windows CE rendering via GDI with 16bit software renderer)
3724 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3725 * buffer with 16bit software renderer)
3726 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3727 * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3728 * @li "psl1ght" (PS3 rendering using PSL1GHT)
3730 * All engines use a simple string to select the engine to render, EXCEPT
3731 * the "shot" engine. This actually encodes the output of the virtual
3732 * screenshot and how long to delay in the engine string. The engine string
3733 * is encoded in the following way:
3735 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3737 * Where options are separated by a ":" char if more than one option is
3738 * given, with delay, if provided being the first option and file the last
3739 * (order is important). The delay specifies how long to wait after the
3740 * window is shown before doing the virtual "in memory" rendering and then
3741 * save the output to the file specified by the file option (and then exit).
3742 * If no delay is given, the default is 0.5 seconds. If no file is given the
3743 * default output file is "out.png". Repeat option is for continous
3744 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3745 * fixed to "out001.png" Some examples of using the shot engine:
3747 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3748 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3749 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3750 * ELM_ENGINE="shot:delay=2.0" elementary_test
3751 * ELM_ENGINE="shot:" elementary_test
3753 * Signals that you can add callbacks for are:
3755 * @li "delete,request": the user requested to close the window. See
3756 * elm_win_autodel_set().
3757 * @li "focus,in": window got focus
3758 * @li "focus,out": window lost focus
3759 * @li "moved": window that holds the canvas was moved
3762 * @li @ref win_example_01
3767 * Defines the types of window that can be created
3769 * These are hints set on the window so that a running Window Manager knows
3770 * how the window should be handled and/or what kind of decorations it
3773 * Currently, only the X11 backed engines use them.
3775 typedef enum _Elm_Win_Type
3777 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3778 window. Almost every window will be created with this
3780 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3781 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3782 window holding desktop icons. */
3783 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3784 be kept on top of any other window by the Window
3786 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3788 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3789 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3791 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3792 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3793 entry in a menubar is clicked. Typically used
3794 with elm_win_override_set(). This hint exists
3795 for completion only, as the EFL way of
3796 implementing a menu would not normally use a
3797 separate window for its contents. */
3798 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3799 triggered by right-clicking an object. */
3800 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3801 explanatory text that typically appear after the
3802 mouse cursor hovers over an object for a while.
3803 Typically used with elm_win_override_set() and also
3804 not very commonly used in the EFL. */
3805 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3806 battery life or a new E-Mail received. */
3807 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3808 usually used in the EFL. */
3809 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3810 object being dragged across different windows, or even
3811 applications. Typically used with
3812 elm_win_override_set(). */
3813 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3814 buffer. No actual window is created for this
3815 type, instead the window and all of its
3816 contents will be rendered to an image buffer.
3817 This allows to have children window inside a
3818 parent one just like any other object would
3819 be, and do other things like applying @c
3820 Evas_Map effects to it. This is the only type
3821 of window that requires the @c parent
3822 parameter of elm_win_add() to be a valid @c
3827 * The differents layouts that can be requested for the virtual keyboard.
3829 * When the application window is being managed by Illume, it may request
3830 * any of the following layouts for the virtual keyboard.
3832 typedef enum _Elm_Win_Keyboard_Mode
3834 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3835 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3836 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3837 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3838 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3839 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3840 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3841 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3842 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3843 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3844 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3845 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3846 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3847 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3848 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3849 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3850 } Elm_Win_Keyboard_Mode;
3853 * Available commands that can be sent to the Illume manager.
3855 * When running under an Illume session, a window may send commands to the
3856 * Illume manager to perform different actions.
3858 typedef enum _Elm_Illume_Command
3860 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3862 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3864 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3866 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3867 } Elm_Illume_Command;
3870 * Adds a window object. If this is the first window created, pass NULL as
3873 * @param parent Parent object to add the window to, or NULL
3874 * @param name The name of the window
3875 * @param type The window type, one of #Elm_Win_Type.
3877 * The @p parent paramter can be @c NULL for every window @p type except
3878 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3879 * which the image object will be created.
3881 * @return The created object, or NULL on failure
3883 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3885 * Adds a window object with standard setup
3887 * @param name The name of the window
3888 * @param title The title for the window
3890 * This creates a window like elm_win_add() but also puts in a standard
3891 * background with elm_bg_add(), as well as setting the window title to
3892 * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
3893 * as the parent widget.
3895 * @return The created object, or NULL on failure
3897 * @see elm_win_add()
3899 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
3901 * Add @p subobj as a resize object of window @p obj.
3904 * Setting an object as a resize object of the window means that the
3905 * @p subobj child's size and position will be controlled by the window
3906 * directly. That is, the object will be resized to match the window size
3907 * and should never be moved or resized manually by the developer.
3909 * In addition, resize objects of the window control what the minimum size
3910 * of it will be, as well as whether it can or not be resized by the user.
3912 * For the end user to be able to resize a window by dragging the handles
3913 * or borders provided by the Window Manager, or using any other similar
3914 * mechanism, all of the resize objects in the window should have their
3915 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3917 * @param obj The window object
3918 * @param subobj The resize object to add
3920 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3922 * Delete @p subobj as a resize object of window @p obj.
3924 * This function removes the object @p subobj from the resize objects of
3925 * the window @p obj. It will not delete the object itself, which will be
3926 * left unmanaged and should be deleted by the developer, manually handled
3927 * or set as child of some other container.
3929 * @param obj The window object
3930 * @param subobj The resize object to add
3932 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3934 * Set the title of the window
3936 * @param obj The window object
3937 * @param title The title to set
3939 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3941 * Get the title of the window
3943 * The returned string is an internal one and should not be freed or
3944 * modified. It will also be rendered invalid if a new title is set or if
3945 * the window is destroyed.
3947 * @param obj The window object
3950 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3952 * Set the window's autodel state.
3954 * When closing the window in any way outside of the program control, like
3955 * pressing the X button in the titlebar or using a command from the
3956 * Window Manager, a "delete,request" signal is emitted to indicate that
3957 * this event occurred and the developer can take any action, which may
3958 * include, or not, destroying the window object.
3960 * When the @p autodel parameter is set, the window will be automatically
3961 * destroyed when this event occurs, after the signal is emitted.
3962 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3963 * and is up to the program to do so when it's required.
3965 * @param obj The window object
3966 * @param autodel If true, the window will automatically delete itself when
3969 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3971 * Get the window's autodel state.
3973 * @param obj The window object
3974 * @return If the window will automatically delete itself when closed
3976 * @see elm_win_autodel_set()
3978 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3980 * Activate a window object.
3982 * This function sends a request to the Window Manager to activate the
3983 * window pointed by @p obj. If honored by the WM, the window will receive
3984 * the keyboard focus.
3986 * @note This is just a request that a Window Manager may ignore, so calling
3987 * this function does not ensure in any way that the window will be the
3988 * active one after it.
3990 * @param obj The window object
3992 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3994 * Lower a window object.
3996 * Places the window pointed by @p obj at the bottom of the stack, so that
3997 * no other window is covered by it.
3999 * If elm_win_override_set() is not set, the Window Manager may ignore this
4002 * @param obj The window object
4004 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
4006 * Raise a window object.
4008 * Places the window pointed by @p obj at the top of the stack, so that it's
4009 * not covered by any other window.
4011 * If elm_win_override_set() is not set, the Window Manager may ignore this
4014 * @param obj The window object
4016 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
4018 * Set the borderless state of a window.
4020 * This function requests the Window Manager to not draw any decoration
4021 * around the window.
4023 * @param obj The window object
4024 * @param borderless If true, the window is borderless
4026 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
4028 * Get the borderless state of a window.
4030 * @param obj The window object
4031 * @return If true, the window is borderless
4033 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4035 * Set the shaped state of a window.
4037 * Shaped windows, when supported, will render the parts of the window that
4038 * has no content, transparent.
4040 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
4041 * background object or cover the entire window in any other way, or the
4042 * parts of the canvas that have no data will show framebuffer artifacts.
4044 * @param obj The window object
4045 * @param shaped If true, the window is shaped
4047 * @see elm_win_alpha_set()
4049 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
4051 * Get the shaped state of a window.
4053 * @param obj The window object
4054 * @return If true, the window is shaped
4056 * @see elm_win_shaped_set()
4058 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4060 * Set the alpha channel state of a window.
4062 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
4063 * possibly making parts of the window completely or partially transparent.
4064 * This is also subject to the underlying system supporting it, like for
4065 * example, running under a compositing manager. If no compositing is
4066 * available, enabling this option will instead fallback to using shaped
4067 * windows, with elm_win_shaped_set().
4069 * @param obj The window object
4070 * @param alpha If true, the window has an alpha channel
4072 * @see elm_win_alpha_set()
4074 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
4076 * Get the transparency state of a window.
4078 * @param obj The window object
4079 * @return If true, the window is transparent
4081 * @see elm_win_transparent_set()
4083 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4085 * Set the transparency state of a window.
4087 * Use elm_win_alpha_set() instead.
4089 * @param obj The window object
4090 * @param transparent If true, the window is transparent
4092 * @see elm_win_alpha_set()
4094 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4096 * Get the alpha channel state of a window.
4098 * @param obj The window object
4099 * @return If true, the window has an alpha channel
4101 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4103 * Set the override state of a window.
4105 * A window with @p override set to EINA_TRUE will not be managed by the
4106 * Window Manager. This means that no decorations of any kind will be shown
4107 * for it, moving and resizing must be handled by the application, as well
4108 * as the window visibility.
4110 * This should not be used for normal windows, and even for not so normal
4111 * ones, it should only be used when there's a good reason and with a lot
4112 * of care. Mishandling override windows may result situations that
4113 * disrupt the normal workflow of the end user.
4115 * @param obj The window object
4116 * @param override If true, the window is overridden
4118 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4120 * Get the override state of a window.
4122 * @param obj The window object
4123 * @return If true, the window is overridden
4125 * @see elm_win_override_set()
4127 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4129 * Set the fullscreen state of a window.
4131 * @param obj The window object
4132 * @param fullscreen If true, the window is fullscreen
4134 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4136 * Get the fullscreen state of a window.
4138 * @param obj The window object
4139 * @return If true, the window is fullscreen
4141 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4143 * Set the maximized state of a window.
4145 * @param obj The window object
4146 * @param maximized If true, the window is maximized
4148 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4150 * Get the maximized state of a window.
4152 * @param obj The window object
4153 * @return If true, the window is maximized
4155 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4157 * Set the iconified state of a window.
4159 * @param obj The window object
4160 * @param iconified If true, the window is iconified
4162 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4164 * Get the iconified state of a window.
4166 * @param obj The window object
4167 * @return If true, the window is iconified
4169 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4171 * Set the layer of the window.
4173 * What this means exactly will depend on the underlying engine used.
4175 * In the case of X11 backed engines, the value in @p layer has the
4176 * following meanings:
4177 * @li < 3: The window will be placed below all others.
4178 * @li > 5: The window will be placed above all others.
4179 * @li other: The window will be placed in the default layer.
4181 * @param obj The window object
4182 * @param layer The layer of the window
4184 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4186 * Get the layer of the window.
4188 * @param obj The window object
4189 * @return The layer of the window
4191 * @see elm_win_layer_set()
4193 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4195 * Set the rotation of the window.
4197 * Most engines only work with multiples of 90.
4199 * This function is used to set the orientation of the window @p obj to
4200 * match that of the screen. The window itself will be resized to adjust
4201 * to the new geometry of its contents. If you want to keep the window size,
4202 * see elm_win_rotation_with_resize_set().
4204 * @param obj The window object
4205 * @param rotation The rotation of the window, in degrees (0-360),
4206 * counter-clockwise.
4208 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4210 * Rotates the window and resizes it.
4212 * Like elm_win_rotation_set(), but it also resizes the window's contents so
4213 * that they fit inside the current window geometry.
4215 * @param obj The window object
4216 * @param layer The rotation of the window in degrees (0-360),
4217 * counter-clockwise.
4219 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4221 * Get the rotation of the window.
4223 * @param obj The window object
4224 * @return The rotation of the window in degrees (0-360)
4226 * @see elm_win_rotation_set()
4227 * @see elm_win_rotation_with_resize_set()
4229 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4231 * Set the sticky state of the window.
4233 * Hints the Window Manager that the window in @p obj should be left fixed
4234 * at its position even when the virtual desktop it's on moves or changes.
4236 * @param obj The window object
4237 * @param sticky If true, the window's sticky state is enabled
4239 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4241 * Get the sticky state of the window.
4243 * @param obj The window object
4244 * @return If true, the window's sticky state is enabled
4246 * @see elm_win_sticky_set()
4248 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4250 * Set if this window is an illume conformant window
4252 * @param obj The window object
4253 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4255 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4257 * Get if this window is an illume conformant window
4259 * @param obj The window object
4260 * @return A boolean if this window is illume conformant or not
4262 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4264 * Set a window to be an illume quickpanel window
4266 * By default window objects are not quickpanel windows.
4268 * @param obj The window object
4269 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4271 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4273 * Get if this window is a quickpanel or not
4275 * @param obj The window object
4276 * @return A boolean if this window is a quickpanel or not
4278 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4280 * Set the major priority of a quickpanel window
4282 * @param obj The window object
4283 * @param priority The major priority for this quickpanel
4285 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4287 * Get the major priority of a quickpanel window
4289 * @param obj The window object
4290 * @return The major priority of this quickpanel
4292 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4294 * Set the minor priority of a quickpanel window
4296 * @param obj The window object
4297 * @param priority The minor priority for this quickpanel
4299 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4301 * Get the minor priority of a quickpanel window
4303 * @param obj The window object
4304 * @return The minor priority of this quickpanel
4306 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4308 * Set which zone this quickpanel should appear in
4310 * @param obj The window object
4311 * @param zone The requested zone for this quickpanel
4313 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4315 * Get which zone this quickpanel should appear in
4317 * @param obj The window object
4318 * @return The requested zone for this quickpanel
4320 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4322 * Set the window to be skipped by keyboard focus
4324 * This sets the window to be skipped by normal keyboard input. This means
4325 * a window manager will be asked to not focus this window as well as omit
4326 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4328 * Call this and enable it on a window BEFORE you show it for the first time,
4329 * otherwise it may have no effect.
4331 * Use this for windows that have only output information or might only be
4332 * interacted with by the mouse or fingers, and never for typing input.
4333 * Be careful that this may have side-effects like making the window
4334 * non-accessible in some cases unless the window is specially handled. Use
4337 * @param obj The window object
4338 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4340 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4342 * Send a command to the windowing environment
4344 * This is intended to work in touchscreen or small screen device
4345 * environments where there is a more simplistic window management policy in
4346 * place. This uses the window object indicated to select which part of the
4347 * environment to control (the part that this window lives in), and provides
4348 * a command and an optional parameter structure (use NULL for this if not
4351 * @param obj The window object that lives in the environment to control
4352 * @param command The command to send
4353 * @param params Optional parameters for the command
4355 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4357 * Get the inlined image object handle
4359 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4360 * then the window is in fact an evas image object inlined in the parent
4361 * canvas. You can get this object (be careful to not manipulate it as it
4362 * is under control of elementary), and use it to do things like get pixel
4363 * data, save the image to a file, etc.
4365 * @param obj The window object to get the inlined image from
4366 * @return The inlined image object, or NULL if none exists
4368 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4370 * Set the enabled status for the focus highlight in a window
4372 * This function will enable or disable the focus highlight only for the
4373 * given window, regardless of the global setting for it
4375 * @param obj The window where to enable the highlight
4376 * @param enabled The enabled value for the highlight
4378 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4380 * Get the enabled value of the focus highlight for this window
4382 * @param obj The window in which to check if the focus highlight is enabled
4384 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4386 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4388 * Set the style for the focus highlight on this window
4390 * Sets the style to use for theming the highlight of focused objects on
4391 * the given window. If @p style is NULL, the default will be used.
4393 * @param obj The window where to set the style
4394 * @param style The style to set
4396 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4398 * Get the style set for the focus highlight object
4400 * Gets the style set for this windows highilght object, or NULL if none
4403 * @param obj The window to retrieve the highlights style from
4405 * @return The style set or NULL if none was. Default is used in that case.
4407 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4408 EAPI void elm_win_indicator_state_set(Evas_Object *obj, int show_state);
4409 EAPI int elm_win_indicator_state_get(Evas_Object *obj);
4411 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4412 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4413 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4414 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4415 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4416 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4417 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4419 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4420 * (blank mouse, private mouse obj, defaultmouse)
4424 * Sets the keyboard mode of the window.
4426 * @param obj The window object
4427 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4429 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4431 * Gets the keyboard mode of the window.
4433 * @param obj The window object
4434 * @return The mode, one of #Elm_Win_Keyboard_Mode
4436 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4438 * Sets whether the window is a keyboard.
4440 * @param obj The window object
4441 * @param is_keyboard If true, the window is a virtual keyboard
4443 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4445 * Gets whether the window is a keyboard.
4447 * @param obj The window object
4448 * @return If the window is a virtual keyboard
4450 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4453 * Get the screen position of a window.
4455 * @param obj The window object
4456 * @param x The int to store the x coordinate to
4457 * @param y The int to store the y coordinate to
4459 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4465 * @defgroup Inwin Inwin
4467 * @image html img/widget/inwin/preview-00.png
4468 * @image latex img/widget/inwin/preview-00.eps
4469 * @image html img/widget/inwin/preview-01.png
4470 * @image latex img/widget/inwin/preview-01.eps
4471 * @image html img/widget/inwin/preview-02.png
4472 * @image latex img/widget/inwin/preview-02.eps
4474 * An inwin is a window inside a window that is useful for a quick popup.
4475 * It does not hover.
4477 * It works by creating an object that will occupy the entire window, so it
4478 * must be created using an @ref Win "elm_win" as parent only. The inwin
4479 * object can be hidden or restacked below every other object if it's
4480 * needed to show what's behind it without destroying it. If this is done,
4481 * the elm_win_inwin_activate() function can be used to bring it back to
4482 * full visibility again.
4484 * There are three styles available in the default theme. These are:
4485 * @li default: The inwin is sized to take over most of the window it's
4487 * @li minimal: The size of the inwin will be the minimum necessary to show
4489 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4490 * possible, but it's sized vertically the most it needs to fit its\
4493 * Some examples of Inwin can be found in the following:
4494 * @li @ref inwin_example_01
4499 * Adds an inwin to the current window
4501 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4502 * Never call this function with anything other than the top-most window
4503 * as its parameter, unless you are fond of undefined behavior.
4505 * After creating the object, the widget will set itself as resize object
4506 * for the window with elm_win_resize_object_add(), so when shown it will
4507 * appear to cover almost the entire window (how much of it depends on its
4508 * content and the style used). It must not be added into other container
4509 * objects and it needs not be moved or resized manually.
4511 * @param parent The parent object
4512 * @return The new object or NULL if it cannot be created
4514 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4516 * Activates an inwin object, ensuring its visibility
4518 * This function will make sure that the inwin @p obj is completely visible
4519 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4520 * to the front. It also sets the keyboard focus to it, which will be passed
4523 * The object's theme will also receive the signal "elm,action,show" with
4526 * @param obj The inwin to activate
4528 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4530 * Set the content of an inwin object.
4532 * Once the content object is set, a previously set one will be deleted.
4533 * If you want to keep that old content object, use the
4534 * elm_win_inwin_content_unset() function.
4536 * @param obj The inwin object
4537 * @param content The object to set as content
4539 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4541 * Get the content of an inwin object.
4543 * Return the content object which is set for this widget.
4545 * The returned object is valid as long as the inwin is still alive and no
4546 * other content is set on it. Deleting the object will notify the inwin
4547 * about it and this one will be left empty.
4549 * If you need to remove an inwin's content to be reused somewhere else,
4550 * see elm_win_inwin_content_unset().
4552 * @param obj The inwin object
4553 * @return The content that is being used
4555 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4557 * Unset the content of an inwin object.
4559 * Unparent and return the content object which was set for this widget.
4561 * @param obj The inwin object
4562 * @return The content that was being used
4564 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4568 /* X specific calls - won't work on non-x engines (return 0) */
4571 * Get the Ecore_X_Window of an Evas_Object
4573 * @param obj The object
4575 * @return The Ecore_X_Window of @p obj
4579 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4581 /* smart callbacks called:
4582 * "delete,request" - the user requested to delete the window
4583 * "focus,in" - window got focus
4584 * "focus,out" - window lost focus
4585 * "moved" - window that holds the canvas was moved
4591 * @image html img/widget/bg/preview-00.png
4592 * @image latex img/widget/bg/preview-00.eps
4594 * @brief Background object, used for setting a solid color, image or Edje
4595 * group as background to a window or any container object.
4597 * The bg object is used for setting a solid background to a window or
4598 * packing into any container object. It works just like an image, but has
4599 * some properties useful to a background, like setting it to tiled,
4600 * centered, scaled or stretched.
4602 * Default contents parts of the bg widget that you can use for are:
4603 * @li "overlay" - overlay of the bg
4605 * Here is some sample code using it:
4606 * @li @ref bg_01_example_page
4607 * @li @ref bg_02_example_page
4608 * @li @ref bg_03_example_page
4612 typedef enum _Elm_Bg_Option
4614 ELM_BG_OPTION_CENTER, /**< center the background */
4615 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4616 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4617 ELM_BG_OPTION_TILE /**< tile background at its original size */
4621 * Add a new background to the parent
4623 * @param parent The parent object
4624 * @return The new object or NULL if it cannot be created
4628 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4631 * Set the file (image or edje) used for the background
4633 * @param obj The bg object
4634 * @param file The file path
4635 * @param group Optional key (group in Edje) within the file
4637 * This sets the image file used in the background object. The image (or edje)
4638 * will be stretched (retaining aspect if its an image file) to completely fill
4639 * the bg object. This may mean some parts are not visible.
4641 * @note Once the image of @p obj is set, a previously set one will be deleted,
4642 * even if @p file is NULL.
4646 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4649 * Get the file (image or edje) used for the background
4651 * @param obj The bg object
4652 * @param file The file path
4653 * @param group Optional key (group in Edje) within the file
4657 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4660 * Set the option used for the background image
4662 * @param obj The bg object
4663 * @param option The desired background option (TILE, SCALE)
4665 * This sets the option used for manipulating the display of the background
4666 * image. The image can be tiled or scaled.
4670 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4673 * Get the option used for the background image
4675 * @param obj The bg object
4676 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4680 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4682 * Set the option used for the background color
4684 * @param obj The bg object
4689 * This sets the color used for the background rectangle. Its range goes
4694 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4696 * Get the option used for the background color
4698 * @param obj The bg object
4705 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4708 * Set the overlay object used for the background object.
4710 * @param obj The bg object
4711 * @param overlay The overlay object
4713 * This provides a way for elm_bg to have an 'overlay' that will be on top
4714 * of the bg. Once the over object is set, a previously set one will be
4715 * deleted, even if you set the new one to NULL. If you want to keep that
4716 * old content object, use the elm_bg_overlay_unset() function.
4718 * @deprecated use elm_object_part_content_set() instead
4723 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4726 * Get the overlay object used for the background object.
4728 * @param obj The bg object
4729 * @return The content that is being used
4731 * Return the content object which is set for this widget
4733 * @deprecated use elm_object_part_content_get() instead
4737 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4740 * Get the overlay object used for the background object.
4742 * @param obj The bg object
4743 * @return The content that was being used
4745 * Unparent and return the overlay object which was set for this widget
4747 * @deprecated use elm_object_part_content_unset() instead
4751 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4754 * Set the size of the pixmap representation of the image.
4756 * This option just makes sense if an image is going to be set in the bg.
4758 * @param obj The bg object
4759 * @param w The new width of the image pixmap representation.
4760 * @param h The new height of the image pixmap representation.
4762 * This function sets a new size for pixmap representation of the given bg
4763 * image. It allows the image to be loaded already in the specified size,
4764 * reducing the memory usage and load time when loading a big image with load
4765 * size set to a smaller size.
4767 * NOTE: this is just a hint, the real size of the pixmap may differ
4768 * depending on the type of image being loaded, being bigger than requested.
4772 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4773 /* smart callbacks called:
4777 * @defgroup Icon Icon
4779 * @image html img/widget/icon/preview-00.png
4780 * @image latex img/widget/icon/preview-00.eps
4782 * An object that provides standard icon images (delete, edit, arrows, etc.)
4783 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4785 * The icon image requested can be in the elementary theme, or in the
4786 * freedesktop.org paths. It's possible to set the order of preference from
4787 * where the image will be used.
4789 * This API is very similar to @ref Image, but with ready to use images.
4791 * Default images provided by the theme are described below.
4793 * The first list contains icons that were first intended to be used in
4794 * toolbars, but can be used in many other places too:
4810 * Now some icons that were designed to be used in menus (but again, you can
4811 * use them anywhere else):
4816 * @li menu/arrow_down
4817 * @li menu/arrow_left
4818 * @li menu/arrow_right
4827 * And here we have some media player specific icons:
4828 * @li media_player/forward
4829 * @li media_player/info
4830 * @li media_player/next
4831 * @li media_player/pause
4832 * @li media_player/play
4833 * @li media_player/prev
4834 * @li media_player/rewind
4835 * @li media_player/stop
4837 * Signals that you can add callbacks for are:
4839 * "clicked" - This is called when a user has clicked the icon
4841 * An example of usage for this API follows:
4842 * @li @ref tutorial_icon
4850 typedef enum _Elm_Icon_Type
4857 * @enum _Elm_Icon_Lookup_Order
4858 * @typedef Elm_Icon_Lookup_Order
4860 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4861 * theme, FDO paths, or both?
4865 typedef enum _Elm_Icon_Lookup_Order
4867 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4868 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4869 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4870 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4871 } Elm_Icon_Lookup_Order;
4874 * Add a new icon object to the parent.
4876 * @param parent The parent object
4877 * @return The new object or NULL if it cannot be created
4879 * @see elm_icon_file_set()
4883 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4885 * Set the file that will be used as icon.
4887 * @param obj The icon object
4888 * @param file The path to file that will be used as icon image
4889 * @param group The group that the icon belongs to an edje file
4891 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4893 * @note The icon image set by this function can be changed by
4894 * elm_icon_standard_set().
4896 * @see elm_icon_file_get()
4900 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4902 * Set a location in memory to be used as an icon
4904 * @param obj The icon object
4905 * @param img The binary data that will be used as an image
4906 * @param size The size of binary data @p img
4907 * @param format Optional format of @p img to pass to the image loader
4908 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4910 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4912 * @note The icon image set by this function can be changed by
4913 * elm_icon_standard_set().
4917 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);
4919 * Get the file that will be used as icon.
4921 * @param obj The icon object
4922 * @param file The path to file that will be used as the icon image
4923 * @param group The group that the icon belongs to, in edje file
4925 * @see elm_icon_file_set()
4929 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4930 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4932 * Set the icon by icon standards names.
4934 * @param obj The icon object
4935 * @param name The icon name
4937 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4939 * For example, freedesktop.org defines standard icon names such as "home",
4940 * "network", etc. There can be different icon sets to match those icon
4941 * keys. The @p name given as parameter is one of these "keys", and will be
4942 * used to look in the freedesktop.org paths and elementary theme. One can
4943 * change the lookup order with elm_icon_order_lookup_set().
4945 * If name is not found in any of the expected locations and it is the
4946 * absolute path of an image file, this image will be used.
4948 * @note The icon image set by this function can be changed by
4949 * elm_icon_file_set().
4951 * @see elm_icon_standard_get()
4952 * @see elm_icon_file_set()
4956 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4958 * Get the icon name set by icon standard names.
4960 * @param obj The icon object
4961 * @return The icon name
4963 * If the icon image was set using elm_icon_file_set() instead of
4964 * elm_icon_standard_set(), then this function will return @c NULL.
4966 * @see elm_icon_standard_set()
4970 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4972 * Set the smooth scaling for an icon object.
4974 * @param obj The icon object
4975 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4976 * otherwise. Default is @c EINA_TRUE.
4978 * Set the scaling algorithm to be used when scaling the icon image. Smooth
4979 * scaling provides a better resulting image, but is slower.
4981 * The smooth scaling should be disabled when making animations that change
4982 * the icon size, since they will be faster. Animations that don't require
4983 * resizing of the icon can keep the smooth scaling enabled (even if the icon
4984 * is already scaled, since the scaled icon image will be cached).
4986 * @see elm_icon_smooth_get()
4990 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4992 * Get whether smooth scaling is enabled for an icon object.
4994 * @param obj The icon object
4995 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4997 * @see elm_icon_smooth_set()
5001 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5003 * Disable scaling of this object.
5005 * @param obj The icon object.
5006 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5007 * otherwise. Default is @c EINA_FALSE.
5009 * This function disables scaling of the icon object through the function
5010 * elm_object_scale_set(). However, this does not affect the object
5011 * size/resize in any way. For that effect, take a look at
5012 * elm_icon_scale_set().
5014 * @see elm_icon_no_scale_get()
5015 * @see elm_icon_scale_set()
5016 * @see elm_object_scale_set()
5020 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5022 * Get whether scaling is disabled on the object.
5024 * @param obj The icon object
5025 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5027 * @see elm_icon_no_scale_set()
5031 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5033 * Set if the object is (up/down) resizable.
5035 * @param obj The icon object
5036 * @param scale_up A bool to set if the object is resizable up. Default is
5038 * @param scale_down A bool to set if the object is resizable down. Default
5041 * This function limits the icon object resize ability. If @p scale_up is set to
5042 * @c EINA_FALSE, the object can't have its height or width resized to a value
5043 * higher than the original icon size. Same is valid for @p scale_down.
5045 * @see elm_icon_scale_get()
5049 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5051 * Get if the object is (up/down) resizable.
5053 * @param obj The icon object
5054 * @param scale_up A bool to set if the object is resizable up
5055 * @param scale_down A bool to set if the object is resizable down
5057 * @see elm_icon_scale_set()
5061 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5063 * Get the object's image size
5065 * @param obj The icon object
5066 * @param w A pointer to store the width in
5067 * @param h A pointer to store the height in
5071 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5073 * Set if the icon fill the entire object area.
5075 * @param obj The icon object
5076 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5077 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5079 * When the icon object is resized to a different aspect ratio from the
5080 * original icon image, the icon image will still keep its aspect. This flag
5081 * tells how the image should fill the object's area. They are: keep the
5082 * entire icon inside the limits of height and width of the object (@p
5083 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5084 * of the object, and the icon will fill the entire object (@p fill_outside
5087 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5088 * retain property to false. Thus, the icon image will always keep its
5089 * original aspect ratio.
5091 * @see elm_icon_fill_outside_get()
5092 * @see elm_image_fill_outside_set()
5096 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5098 * Get if the object is filled outside.
5100 * @param obj The icon object
5101 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5103 * @see elm_icon_fill_outside_set()
5107 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5109 * Set the prescale size for the icon.
5111 * @param obj The icon object
5112 * @param size The prescale size. This value is used for both width and
5115 * This function sets a new size for pixmap representation of the given
5116 * icon. It allows the icon to be loaded already in the specified size,
5117 * reducing the memory usage and load time when loading a big icon with load
5118 * size set to a smaller size.
5120 * It's equivalent to the elm_bg_load_size_set() function for bg.
5122 * @note this is just a hint, the real size of the pixmap may differ
5123 * depending on the type of icon being loaded, being bigger than requested.
5125 * @see elm_icon_prescale_get()
5126 * @see elm_bg_load_size_set()
5130 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5132 * Get the prescale size for the icon.
5134 * @param obj The icon object
5135 * @return The prescale size
5137 * @see elm_icon_prescale_set()
5141 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5143 * Gets the image object of the icon. DO NOT MODIFY THIS.
5145 * @param obj The icon object
5146 * @return The internal icon object
5150 EAPI Evas_Object *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5152 * Sets the icon lookup order used by elm_icon_standard_set().
5154 * @param obj The icon object
5155 * @param order The icon lookup order (can be one of
5156 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5157 * or ELM_ICON_LOOKUP_THEME)
5159 * @see elm_icon_order_lookup_get()
5160 * @see Elm_Icon_Lookup_Order
5164 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5166 * Gets the icon lookup order.
5168 * @param obj The icon object
5169 * @return The icon lookup order
5171 * @see elm_icon_order_lookup_set()
5172 * @see Elm_Icon_Lookup_Order
5176 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5178 * Enable or disable preloading of the icon
5180 * @param obj The icon object
5181 * @param disable If EINA_TRUE, preloading will be disabled
5184 EAPI void elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5186 * Get if the icon supports animation or not.
5188 * @param obj The icon object
5189 * @return @c EINA_TRUE if the icon supports animation,
5190 * @c EINA_FALSE otherwise.
5192 * Return if this elm icon's image can be animated. Currently Evas only
5193 * supports gif animation. If the return value is EINA_FALSE, other
5194 * elm_icon_animated_XXX APIs won't work.
5197 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5199 * Set animation mode of the icon.
5201 * @param obj The icon object
5202 * @param anim @c EINA_TRUE if the object do animation job,
5203 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5205 * Since the default animation mode is set to EINA_FALSE,
5206 * the icon is shown without animation.
5207 * This might be desirable when the application developer wants to show
5208 * a snapshot of the animated icon.
5209 * Set it to EINA_TRUE when the icon needs to be animated.
5212 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5214 * Get animation mode of the icon.
5216 * @param obj The icon object
5217 * @return The animation mode of the icon object
5218 * @see elm_icon_animated_set
5221 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5223 * Set animation play mode of the icon.
5225 * @param obj The icon object
5226 * @param play @c EINA_TRUE the object play animation images,
5227 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5229 * To play elm icon's animation, set play to EINA_TURE.
5230 * For example, you make gif player using this set/get API and click event.
5232 * 1. Click event occurs
5233 * 2. Check play flag using elm_icon_animaged_play_get
5234 * 3. If elm icon was playing, set play to EINA_FALSE.
5235 * Then animation will be stopped and vice versa
5238 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5240 * Get animation play mode of the icon.
5242 * @param obj The icon object
5243 * @return The play mode of the icon object
5245 * @see elm_icon_animated_play_get
5248 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5250 /* compatibility code to avoid API and ABI breaks */
5251 EINA_DEPRECATED EAPI extern inline void elm_icon_anim_set(Evas_Object *obj, Eina_Bool animated)
5253 elm_icon_animated_set(obj, animated);
5256 EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_get(const Evas_Object *obj)
5258 return elm_icon_animated_get(obj);
5261 EINA_DEPRECATED EAPI extern inline void elm_icon_anim_play_set(Evas_Object *obj, Eina_Bool play)
5263 elm_icon_animated_play_set(obj, play);
5266 EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_play_get(const Evas_Object *obj)
5268 return elm_icon_animated_play_get(obj);
5276 * @defgroup Image Image
5278 * @image html img/widget/image/preview-00.png
5279 * @image latex img/widget/image/preview-00.eps
5282 * An object that allows one to load an image file to it. It can be used
5283 * anywhere like any other elementary widget.
5285 * This widget provides most of the functionality provided from @ref Bg or @ref
5286 * Icon, but with a slightly different API (use the one that fits better your
5289 * The features not provided by those two other image widgets are:
5290 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5291 * @li change the object orientation with elm_image_orient_set();
5292 * @li and turning the image editable with elm_image_editable_set().
5294 * Signals that you can add callbacks for are:
5296 * @li @c "clicked" - This is called when a user has clicked the image
5298 * An example of usage for this API follows:
5299 * @li @ref tutorial_image
5308 * @enum _Elm_Image_Orient
5309 * @typedef Elm_Image_Orient
5311 * Possible orientation options for elm_image_orient_set().
5313 * @image html elm_image_orient_set.png
5314 * @image latex elm_image_orient_set.eps width=\textwidth
5318 typedef enum _Elm_Image_Orient
5320 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5321 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5322 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5323 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5324 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5325 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5326 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5327 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5331 * Add a new image to the parent.
5333 * @param parent The parent object
5334 * @return The new object or NULL if it cannot be created
5336 * @see elm_image_file_set()
5340 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5342 * Set the file that will be used as image.
5344 * @param obj The image object
5345 * @param file The path to file that will be used as image
5346 * @param group The group that the image belongs in edje file (if it's an
5349 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5351 * @see elm_image_file_get()
5355 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5357 * Get the file that will be used as image.
5359 * @param obj The image object
5360 * @param file The path to file
5361 * @param group The group that the image belongs in edje file
5363 * @see elm_image_file_set()
5367 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5369 * Set the smooth effect for an image.
5371 * @param obj The image object
5372 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5373 * otherwise. Default is @c EINA_TRUE.
5375 * Set the scaling algorithm to be used when scaling the image. Smooth
5376 * scaling provides a better resulting image, but is slower.
5378 * The smooth scaling should be disabled when making animations that change
5379 * the image size, since it will be faster. Animations that don't require
5380 * resizing of the image can keep the smooth scaling enabled (even if the
5381 * image is already scaled, since the scaled image will be cached).
5383 * @see elm_image_smooth_get()
5387 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5389 * Get the smooth effect for an image.
5391 * @param obj The image object
5392 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5394 * @see elm_image_smooth_get()
5398 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5401 * Gets the current size of the image.
5403 * @param obj The image object.
5404 * @param w Pointer to store width, or NULL.
5405 * @param h Pointer to store height, or NULL.
5407 * This is the real size of the image, not the size of the object.
5409 * On error, neither w or h will be written.
5413 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5415 * Disable scaling of this object.
5417 * @param obj The image object.
5418 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5419 * otherwise. Default is @c EINA_FALSE.
5421 * This function disables scaling of the elm_image widget through the
5422 * function elm_object_scale_set(). However, this does not affect the widget
5423 * size/resize in any way. For that effect, take a look at
5424 * elm_image_scale_set().
5426 * @see elm_image_no_scale_get()
5427 * @see elm_image_scale_set()
5428 * @see elm_object_scale_set()
5432 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5434 * Get whether scaling is disabled on the object.
5436 * @param obj The image object
5437 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5439 * @see elm_image_no_scale_set()
5443 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5445 * Set if the object is (up/down) resizable.
5447 * @param obj The image object
5448 * @param scale_up A bool to set if the object is resizable up. Default is
5450 * @param scale_down A bool to set if the object is resizable down. Default
5453 * This function limits the image resize ability. If @p scale_up is set to
5454 * @c EINA_FALSE, the object can't have its height or width resized to a value
5455 * higher than the original image size. Same is valid for @p scale_down.
5457 * @see elm_image_scale_get()
5461 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5463 * Get if the object is (up/down) resizable.
5465 * @param obj The image object
5466 * @param scale_up A bool to set if the object is resizable up
5467 * @param scale_down A bool to set if the object is resizable down
5469 * @see elm_image_scale_set()
5473 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5475 * Set if the image fills the entire object area, when keeping the aspect ratio.
5477 * @param obj The image object
5478 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5479 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5481 * When the image should keep its aspect ratio even if resized to another
5482 * aspect ratio, there are two possibilities to resize it: keep the entire
5483 * image inside the limits of height and width of the object (@p fill_outside
5484 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5485 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5487 * @note This option will have no effect if
5488 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5490 * @see elm_image_fill_outside_get()
5491 * @see elm_image_aspect_ratio_retained_set()
5495 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5497 * Get if the object is filled outside
5499 * @param obj The image object
5500 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5502 * @see elm_image_fill_outside_set()
5506 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5508 * Set the prescale size for the image
5510 * @param obj The image object
5511 * @param size The prescale size. This value is used for both width and
5514 * This function sets a new size for pixmap representation of the given
5515 * image. It allows the image to be loaded already in the specified size,
5516 * reducing the memory usage and load time when loading a big image with load
5517 * size set to a smaller size.
5519 * It's equivalent to the elm_bg_load_size_set() function for bg.
5521 * @note this is just a hint, the real size of the pixmap may differ
5522 * depending on the type of image being loaded, being bigger than requested.
5524 * @see elm_image_prescale_get()
5525 * @see elm_bg_load_size_set()
5529 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5531 * Get the prescale size for the image
5533 * @param obj The image object
5534 * @return The prescale size
5536 * @see elm_image_prescale_set()
5540 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5542 * Set the image orientation.
5544 * @param obj The image object
5545 * @param orient The image orientation @ref Elm_Image_Orient
5546 * Default is #ELM_IMAGE_ORIENT_NONE.
5548 * This function allows to rotate or flip the given image.
5550 * @see elm_image_orient_get()
5551 * @see @ref Elm_Image_Orient
5555 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5557 * Get the image orientation.
5559 * @param obj The image object
5560 * @return The image orientation @ref Elm_Image_Orient
5562 * @see elm_image_orient_set()
5563 * @see @ref Elm_Image_Orient
5567 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5569 * Make the image 'editable'.
5571 * @param obj Image object.
5572 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5574 * This means the image is a valid drag target for drag and drop, and can be
5575 * cut or pasted too.
5579 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5581 * Check if the image 'editable'.
5583 * @param obj Image object.
5584 * @return Editability.
5586 * A return value of EINA_TRUE means the image is a valid drag target
5587 * for drag and drop, and can be cut or pasted too.
5591 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5593 * Get the basic Evas_Image object from this object (widget).
5595 * @param obj The image object to get the inlined image from
5596 * @return The inlined image object, or NULL if none exists
5598 * This function allows one to get the underlying @c Evas_Object of type
5599 * Image from this elementary widget. It can be useful to do things like get
5600 * the pixel data, save the image to a file, etc.
5602 * @note Be careful to not manipulate it, as it is under control of
5607 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5609 * Set whether the original aspect ratio of the image should be kept on resize.
5611 * @param obj The image object.
5612 * @param retained @c EINA_TRUE if the image should retain the aspect,
5613 * @c EINA_FALSE otherwise.
5615 * The original aspect ratio (width / height) of the image is usually
5616 * distorted to match the object's size. Enabling this option will retain
5617 * this original aspect, and the way that the image is fit into the object's
5618 * area depends on the option set by elm_image_fill_outside_set().
5620 * @see elm_image_aspect_ratio_retained_get()
5621 * @see elm_image_fill_outside_set()
5625 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5627 * Get if the object retains the original aspect ratio.
5629 * @param obj The image object.
5630 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5635 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5642 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5644 /* old API compatibility */
5645 typedef Elm_GLView_Func_Cb Elm_GLView_Func;
5647 typedef enum _Elm_GLView_Mode
5649 ELM_GLVIEW_ALPHA = 1,
5650 ELM_GLVIEW_DEPTH = 2,
5651 ELM_GLVIEW_STENCIL = 4
5655 * Defines a policy for the glview resizing.
5657 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5659 typedef enum _Elm_GLView_Resize_Policy
5661 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5662 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5663 } Elm_GLView_Resize_Policy;
5665 typedef enum _Elm_GLView_Render_Policy
5667 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5668 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5669 } Elm_GLView_Render_Policy;
5674 * A simple GLView widget that allows GL rendering.
5676 * Signals that you can add callbacks for are:
5682 * Add a new glview to the parent
5684 * @param parent The parent object
5685 * @return The new object or NULL if it cannot be created
5689 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5692 * Sets the size of the glview
5694 * @param obj The glview object
5695 * @param width width of the glview object
5696 * @param height height of the glview object
5700 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5703 * Gets the size of the glview.
5705 * @param obj The glview object
5706 * @param width width of the glview object
5707 * @param height height of the glview object
5709 * Note that this function returns the actual image size of the
5710 * glview. This means that when the scale policy is set to
5711 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5716 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5719 * Gets the gl api struct for gl rendering
5721 * @param obj The glview object
5722 * @return The api object or NULL if it cannot be created
5726 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5729 * Set the mode of the GLView. Supports Three simple modes.
5731 * @param obj The glview object
5732 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5733 * @return True if set properly.
5737 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5740 * Set the resize policy for the glview object.
5742 * @param obj The glview object.
5743 * @param policy The scaling policy.
5745 * By default, the resize policy is set to
5746 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5747 * destroys the previous surface and recreates the newly specified
5748 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5749 * however, glview only scales the image object and not the underlying
5754 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5757 * Set the render policy for the glview object.
5759 * @param obj The glview object.
5760 * @param policy The render policy.
5762 * By default, the render policy is set to
5763 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5764 * that during the render loop, glview is only redrawn if it needs
5765 * to be redrawn. (i.e. When it is visible) If the policy is set to
5766 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5767 * whether it is visible/need redrawing or not.
5771 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5774 * Set the init function that runs once in the main loop.
5776 * @param obj The glview object.
5777 * @param func The init function to be registered.
5779 * The registered init function gets called once during the render loop.
5783 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5786 * Set the render function that runs in the main loop.
5788 * @param obj The glview object.
5789 * @param func The delete function to be registered.
5791 * The registered del function gets called when GLView object is deleted.
5795 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5798 * Set the resize function that gets called when resize happens.
5800 * @param obj The glview object.
5801 * @param func The resize function to be registered.
5805 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5808 * Set the render function that runs in the main loop.
5810 * @param obj The glview object.
5811 * @param func The render function to be registered.
5815 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5818 * Notifies that there has been changes in the GLView.
5820 * @param obj The glview object.
5824 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5834 * @image html img/widget/box/preview-00.png
5835 * @image latex img/widget/box/preview-00.eps width=\textwidth
5837 * @image html img/box.png
5838 * @image latex img/box.eps width=\textwidth
5840 * A box arranges objects in a linear fashion, governed by a layout function
5841 * that defines the details of this arrangement.
5843 * By default, the box will use an internal function to set the layout to
5844 * a single row, either vertical or horizontal. This layout is affected
5845 * by a number of parameters, such as the homogeneous flag set by
5846 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5847 * elm_box_align_set() and the hints set to each object in the box.
5849 * For this default layout, it's possible to change the orientation with
5850 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5851 * placing its elements ordered from top to bottom. When horizontal is set,
5852 * the order will go from left to right. If the box is set to be
5853 * homogeneous, every object in it will be assigned the same space, that
5854 * of the largest object. Padding can be used to set some spacing between
5855 * the cell given to each object. The alignment of the box, set with
5856 * elm_box_align_set(), determines how the bounding box of all the elements
5857 * will be placed within the space given to the box widget itself.
5859 * The size hints of each object also affect how they are placed and sized
5860 * within the box. evas_object_size_hint_min_set() will give the minimum
5861 * size the object can have, and the box will use it as the basis for all
5862 * latter calculations. Elementary widgets set their own minimum size as
5863 * needed, so there's rarely any need to use it manually.
5865 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5866 * used to tell whether the object will be allocated the minimum size it
5867 * needs or if the space given to it should be expanded. It's important
5868 * to realize that expanding the size given to the object is not the same
5869 * thing as resizing the object. It could very well end being a small
5870 * widget floating in a much larger empty space. If not set, the weight
5871 * for objects will normally be 0.0 for both axis, meaning the widget will
5872 * not be expanded. To take as much space possible, set the weight to
5873 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5875 * Besides how much space each object is allocated, it's possible to control
5876 * how the widget will be placed within that space using
5877 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5878 * for both axis, meaning the object will be centered, but any value from
5879 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5880 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5881 * is -1.0, means the object will be resized to fill the entire space it
5884 * In addition, customized functions to define the layout can be set, which
5885 * allow the application developer to organize the objects within the box
5886 * in any number of ways.
5888 * The special elm_box_layout_transition() function can be used
5889 * to switch from one layout to another, animating the motion of the
5890 * children of the box.
5892 * @note Objects should not be added to box objects using _add() calls.
5894 * Some examples on how to use boxes follow:
5895 * @li @ref box_example_01
5896 * @li @ref box_example_02
5901 * @typedef Elm_Box_Transition
5903 * Opaque handler containing the parameters to perform an animated
5904 * transition of the layout the box uses.
5906 * @see elm_box_transition_new()
5907 * @see elm_box_layout_set()
5908 * @see elm_box_layout_transition()
5910 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5913 * Add a new box to the parent
5915 * By default, the box will be in vertical mode and non-homogeneous.
5917 * @param parent The parent object
5918 * @return The new object or NULL if it cannot be created
5920 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5922 * Set the horizontal orientation
5924 * By default, box object arranges their contents vertically from top to
5926 * By calling this function with @p horizontal as EINA_TRUE, the box will
5927 * become horizontal, arranging contents from left to right.
5929 * @note This flag is ignored if a custom layout function is set.
5931 * @param obj The box object
5932 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5933 * EINA_FALSE = vertical)
5935 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5937 * Get the horizontal orientation
5939 * @param obj The box object
5940 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5942 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5944 * Set the box to arrange its children homogeneously
5946 * If enabled, homogeneous layout makes all items the same size, according
5947 * to the size of the largest of its children.
5949 * @note This flag is ignored if a custom layout function is set.
5951 * @param obj The box object
5952 * @param homogeneous The homogeneous flag
5954 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5956 * Get whether the box is using homogeneous mode or not
5958 * @param obj The box object
5959 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5961 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5962 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5963 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5965 * Add an object to the beginning of the pack list
5967 * Pack @p subobj into the box @p obj, placing it first in the list of
5968 * children objects. The actual position the object will get on screen
5969 * depends on the layout used. If no custom layout is set, it will be at
5970 * the top or left, depending if the box is vertical or horizontal,
5973 * @param obj The box object
5974 * @param subobj The object to add to the box
5976 * @see elm_box_pack_end()
5977 * @see elm_box_pack_before()
5978 * @see elm_box_pack_after()
5979 * @see elm_box_unpack()
5980 * @see elm_box_unpack_all()
5981 * @see elm_box_clear()
5983 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5985 * Add an object at the end of the pack list
5987 * Pack @p subobj into the box @p obj, placing it last in the list of
5988 * children objects. The actual position the object will get on screen
5989 * depends on the layout used. If no custom layout is set, it will be at
5990 * the bottom or right, depending if the box is vertical or horizontal,
5993 * @param obj The box object
5994 * @param subobj The object to add to the box
5996 * @see elm_box_pack_start()
5997 * @see elm_box_pack_before()
5998 * @see elm_box_pack_after()
5999 * @see elm_box_unpack()
6000 * @see elm_box_unpack_all()
6001 * @see elm_box_clear()
6003 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6005 * Adds an object to the box before the indicated object
6007 * This will add the @p subobj to the box indicated before the object
6008 * indicated with @p before. If @p before is not already in the box, results
6009 * are undefined. Before means either to the left of the indicated object or
6010 * above it depending on orientation.
6012 * @param obj The box object
6013 * @param subobj The object to add to the box
6014 * @param before The object before which to add it
6016 * @see elm_box_pack_start()
6017 * @see elm_box_pack_end()
6018 * @see elm_box_pack_after()
6019 * @see elm_box_unpack()
6020 * @see elm_box_unpack_all()
6021 * @see elm_box_clear()
6023 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
6025 * Adds an object to the box after the indicated object
6027 * This will add the @p subobj to the box indicated after the object
6028 * indicated with @p after. If @p after is not already in the box, results
6029 * are undefined. After means either to the right of the indicated object or
6030 * below it depending on orientation.
6032 * @param obj The box object
6033 * @param subobj The object to add to the box
6034 * @param after The object after which to add it
6036 * @see elm_box_pack_start()
6037 * @see elm_box_pack_end()
6038 * @see elm_box_pack_before()
6039 * @see elm_box_unpack()
6040 * @see elm_box_unpack_all()
6041 * @see elm_box_clear()
6043 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
6045 * Clear the box of all children
6047 * Remove all the elements contained by the box, deleting the respective
6050 * @param obj The box object
6052 * @see elm_box_unpack()
6053 * @see elm_box_unpack_all()
6055 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6059 * Remove the object given by @p subobj from the box @p obj without
6062 * @param obj The box object
6064 * @see elm_box_unpack_all()
6065 * @see elm_box_clear()
6067 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6069 * Remove all items from the box, without deleting them
6071 * Clear the box from all children, but don't delete the respective objects.
6072 * If no other references of the box children exist, the objects will never
6073 * be deleted, and thus the application will leak the memory. Make sure
6074 * when using this function that you hold a reference to all the objects
6075 * in the box @p obj.
6077 * @param obj The box object
6079 * @see elm_box_clear()
6080 * @see elm_box_unpack()
6082 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6084 * Retrieve a list of the objects packed into the box
6086 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
6087 * The order of the list corresponds to the packing order the box uses.
6089 * You must free this list with eina_list_free() once you are done with it.
6091 * @param obj The box object
6093 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6095 * Set the space (padding) between the box's elements.
6097 * Extra space in pixels that will be added between a box child and its
6098 * neighbors after its containing cell has been calculated. This padding
6099 * is set for all elements in the box, besides any possible padding that
6100 * individual elements may have through their size hints.
6102 * @param obj The box object
6103 * @param horizontal The horizontal space between elements
6104 * @param vertical The vertical space between elements
6106 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
6108 * Get the space (padding) between the box's elements.
6110 * @param obj The box object
6111 * @param horizontal The horizontal space between elements
6112 * @param vertical The vertical space between elements
6114 * @see elm_box_padding_set()
6116 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
6118 * Set the alignment of the whole bouding box of contents.
6120 * Sets how the bounding box containing all the elements of the box, after
6121 * their sizes and position has been calculated, will be aligned within
6122 * the space given for the whole box widget.
6124 * @param obj The box object
6125 * @param horizontal The horizontal alignment of elements
6126 * @param vertical The vertical alignment of elements
6128 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6130 * Get the alignment of the whole bouding box of contents.
6132 * @param obj The box object
6133 * @param horizontal The horizontal alignment of elements
6134 * @param vertical The vertical alignment of elements
6136 * @see elm_box_align_set()
6138 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6141 * Force the box to recalculate its children packing.
6143 * If any children was added or removed, box will not calculate the
6144 * values immediately rather leaving it to the next main loop
6145 * iteration. While this is great as it would save lots of
6146 * recalculation, whenever you need to get the position of a just
6147 * added item you must force recalculate before doing so.
6149 * @param obj The box object.
6151 EAPI void elm_box_recalculate(Evas_Object *obj);
6154 * Set the layout defining function to be used by the box
6156 * Whenever anything changes that requires the box in @p obj to recalculate
6157 * the size and position of its elements, the function @p cb will be called
6158 * to determine what the layout of the children will be.
6160 * Once a custom function is set, everything about the children layout
6161 * is defined by it. The flags set by elm_box_horizontal_set() and
6162 * elm_box_homogeneous_set() no longer have any meaning, and the values
6163 * given by elm_box_padding_set() and elm_box_align_set() are up to this
6164 * layout function to decide if they are used and how. These last two
6165 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6166 * passed to @p cb. The @c Evas_Object the function receives is not the
6167 * Elementary widget, but the internal Evas Box it uses, so none of the
6168 * functions described here can be used on it.
6170 * Any of the layout functions in @c Evas can be used here, as well as the
6171 * special elm_box_layout_transition().
6173 * The final @p data argument received by @p cb is the same @p data passed
6174 * here, and the @p free_data function will be called to free it
6175 * whenever the box is destroyed or another layout function is set.
6177 * Setting @p cb to NULL will revert back to the default layout function.
6179 * @param obj The box object
6180 * @param cb The callback function used for layout
6181 * @param data Data that will be passed to layout function
6182 * @param free_data Function called to free @p data
6184 * @see elm_box_layout_transition()
6186 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);
6188 * Special layout function that animates the transition from one layout to another
6190 * Normally, when switching the layout function for a box, this will be
6191 * reflected immediately on screen on the next render, but it's also
6192 * possible to do this through an animated transition.
6194 * This is done by creating an ::Elm_Box_Transition and setting the box
6195 * layout to this function.
6199 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6200 * evas_object_box_layout_vertical, // start
6201 * NULL, // data for initial layout
6202 * NULL, // free function for initial data
6203 * evas_object_box_layout_horizontal, // end
6204 * NULL, // data for final layout
6205 * NULL, // free function for final data
6206 * anim_end, // will be called when animation ends
6207 * NULL); // data for anim_end function\
6208 * elm_box_layout_set(box, elm_box_layout_transition, t,
6209 * elm_box_transition_free);
6212 * @note This function can only be used with elm_box_layout_set(). Calling
6213 * it directly will not have the expected results.
6215 * @see elm_box_transition_new
6216 * @see elm_box_transition_free
6217 * @see elm_box_layout_set
6219 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6221 * Create a new ::Elm_Box_Transition to animate the switch of layouts
6223 * If you want to animate the change from one layout to another, you need
6224 * to set the layout function of the box to elm_box_layout_transition(),
6225 * passing as user data to it an instance of ::Elm_Box_Transition with the
6226 * necessary information to perform this animation. The free function to
6227 * set for the layout is elm_box_transition_free().
6229 * The parameters to create an ::Elm_Box_Transition sum up to how long
6230 * will it be, in seconds, a layout function to describe the initial point,
6231 * another for the final position of the children and one function to be
6232 * called when the whole animation ends. This last function is useful to
6233 * set the definitive layout for the box, usually the same as the end
6234 * layout for the animation, but could be used to start another transition.
6236 * @param start_layout The layout function that will be used to start the animation
6237 * @param start_layout_data The data to be passed the @p start_layout function
6238 * @param start_layout_free_data Function to free @p start_layout_data
6239 * @param end_layout The layout function that will be used to end the animation
6240 * @param end_layout_free_data The data to be passed the @p end_layout function
6241 * @param end_layout_free_data Function to free @p end_layout_data
6242 * @param transition_end_cb Callback function called when animation ends
6243 * @param transition_end_data Data to be passed to @p transition_end_cb
6244 * @return An instance of ::Elm_Box_Transition
6246 * @see elm_box_transition_new
6247 * @see elm_box_layout_transition
6249 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);
6251 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6253 * This function is mostly useful as the @c free_data parameter in
6254 * elm_box_layout_set() when elm_box_layout_transition().
6256 * @param data The Elm_Box_Transition instance to be freed.
6258 * @see elm_box_transition_new
6259 * @see elm_box_layout_transition
6261 EAPI void elm_box_transition_free(void *data);
6268 * @defgroup Button Button
6270 * @image html img/widget/button/preview-00.png
6271 * @image latex img/widget/button/preview-00.eps
6272 * @image html img/widget/button/preview-01.png
6273 * @image latex img/widget/button/preview-01.eps
6274 * @image html img/widget/button/preview-02.png
6275 * @image latex img/widget/button/preview-02.eps
6277 * This is a push-button. Press it and run some function. It can contain
6278 * a simple label and icon object and it also has an autorepeat feature.
6280 * This widgets emits the following signals:
6281 * @li "clicked": the user clicked the button (press/release).
6282 * @li "repeated": the user pressed the button without releasing it.
6283 * @li "pressed": button was pressed.
6284 * @li "unpressed": button was released after being pressed.
6285 * In all three cases, the @c event parameter of the callback will be
6288 * Also, defined in the default theme, the button has the following styles
6290 * @li default: a normal button.
6291 * @li anchor: Like default, but the button fades away when the mouse is not
6292 * over it, leaving only the text or icon.
6293 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6294 * continuous look across its options.
6295 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6297 * Default contents parts of the button widget that you can use for are:
6298 * @li "icon" - A icon of the button
6300 * Default text parts of the button widget that you can use for are:
6301 * @li "default" - Label of the button
6303 * Follow through a complete example @ref button_example_01 "here".
6309 UIControlStateDefault,
6310 UIControlStateHighlighted,
6311 UIControlStateDisabled,
6312 UIControlStateFocused,
6313 UIControlStateReserved
6317 * Add a new button to the parent's canvas
6319 * @param parent The parent object
6320 * @return The new object or NULL if it cannot be created
6322 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6324 * Set the label used in the button
6326 * The passed @p label can be NULL to clean any existing text in it and
6327 * leave the button as an icon only object.
6329 * @param obj The button object
6330 * @param label The text will be written on the button
6331 * @deprecated use elm_object_text_set() instead.
6333 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6335 * Get the label set for the button
6337 * The string returned is an internal pointer and should not be freed or
6338 * altered. It will also become invalid when the button is destroyed.
6339 * The string returned, if not NULL, is a stringshare, so if you need to
6340 * keep it around even after the button is destroyed, you can use
6341 * eina_stringshare_ref().
6343 * @param obj The button object
6344 * @return The text set to the label, or NULL if nothing is set
6345 * @deprecated use elm_object_text_set() instead.
6347 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6349 * Set the label for each state of button
6351 * The passed @p label can be NULL to clean any existing text in it and
6352 * leave the button as an icon only object for the state.
6354 * @param obj The button object
6355 * @param label The text will be written on the button
6356 * @param state The state of button
6360 EINA_DEPRECATED EAPI void elm_button_label_set_for_state(Evas_Object *obj, const char *label, UIControlState state) EINA_ARG_NONNULL(1);
6362 * Get the label of button for each state
6364 * The string returned is an internal pointer and should not be freed or
6365 * altered. It will also become invalid when the button is destroyed.
6366 * The string returned, if not NULL, is a stringshare, so if you need to
6367 * keep it around even after the button is destroyed, you can use
6368 * eina_stringshare_ref().
6370 * @param obj The button object
6371 * @param state The state of button
6372 * @return The title of button for state
6376 EINA_DEPRECATED EAPI const char *elm_button_label_get_for_state(const Evas_Object *obj, UIControlState state) EINA_ARG_NONNULL(1);
6378 * Set the icon used for the button
6380 * Setting a new icon will delete any other that was previously set, making
6381 * any reference to them invalid. If you need to maintain the previous
6382 * object alive, unset it first with elm_button_icon_unset().
6384 * @param obj The button object
6385 * @param icon The icon object for the button
6386 * @deprecated use elm_object_part_content_set() instead.
6388 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6390 * Get the icon used for the button
6392 * Return the icon object which is set for this widget. If the button is
6393 * destroyed or another icon is set, the returned object will be deleted
6394 * and any reference to it will be invalid.
6396 * @param obj The button object
6397 * @return The icon object that is being used
6399 * @deprecated use elm_object_part_content_get() instead
6401 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6403 * Remove the icon set without deleting it and return the object
6405 * This function drops the reference the button holds of the icon object
6406 * and returns this last object. It is used in case you want to remove any
6407 * icon, or set another one, without deleting the actual object. The button
6408 * will be left without an icon set.
6410 * @param obj The button object
6411 * @return The icon object that was being used
6412 * @deprecated use elm_object_part_content_unset() instead.
6414 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6416 * Turn on/off the autorepeat event generated when the button is kept pressed
6418 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6419 * signal when they are clicked.
6421 * When on, keeping a button pressed will continuously emit a @c repeated
6422 * signal until the button is released. The time it takes until it starts
6423 * emitting the signal is given by
6424 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6425 * new emission by elm_button_autorepeat_gap_timeout_set().
6427 * @param obj The button object
6428 * @param on A bool to turn on/off the event
6430 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6432 * Get whether the autorepeat feature is enabled
6434 * @param obj The button object
6435 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6437 * @see elm_button_autorepeat_set()
6439 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6441 * Set the initial timeout before the autorepeat event is generated
6443 * Sets the timeout, in seconds, since the button is pressed until the
6444 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6445 * won't be any delay and the even will be fired the moment the button is
6448 * @param obj The button object
6449 * @param t Timeout in seconds
6451 * @see elm_button_autorepeat_set()
6452 * @see elm_button_autorepeat_gap_timeout_set()
6454 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6456 * Get the initial timeout before the autorepeat event is generated
6458 * @param obj The button object
6459 * @return Timeout in seconds
6461 * @see elm_button_autorepeat_initial_timeout_set()
6463 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6465 * Set the interval between each generated autorepeat event
6467 * After the first @c repeated event is fired, all subsequent ones will
6468 * follow after a delay of @p t seconds for each.
6470 * @param obj The button object
6471 * @param t Interval in seconds
6473 * @see elm_button_autorepeat_initial_timeout_set()
6475 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6477 * Get the interval between each generated autorepeat event
6479 * @param obj The button object
6480 * @return Interval in seconds
6482 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6488 * @defgroup File_Selector_Button File Selector Button
6490 * @image html img/widget/fileselector_button/preview-00.png
6491 * @image latex img/widget/fileselector_button/preview-00.eps
6492 * @image html img/widget/fileselector_button/preview-01.png
6493 * @image latex img/widget/fileselector_button/preview-01.eps
6494 * @image html img/widget/fileselector_button/preview-02.png
6495 * @image latex img/widget/fileselector_button/preview-02.eps
6497 * This is a button that, when clicked, creates an Elementary
6498 * window (or inner window) <b> with a @ref Fileselector "file
6499 * selector widget" within</b>. When a file is chosen, the (inner)
6500 * window is closed and the button emits a signal having the
6501 * selected file as it's @c event_info.
6503 * This widget encapsulates operations on its internal file
6504 * selector on its own API. There is less control over its file
6505 * selector than that one would have instatiating one directly.
6507 * The following styles are available for this button:
6510 * @li @c "hoversel_vertical"
6511 * @li @c "hoversel_vertical_entry"
6513 * Smart callbacks one can register to:
6514 * - @c "file,chosen" - the user has selected a path, whose string
6515 * pointer comes as the @c event_info data (a stringshared
6518 * Here is an example on its usage:
6519 * @li @ref fileselector_button_example
6521 * @see @ref File_Selector_Entry for a similar widget.
6526 * Add a new file selector button widget to the given parent
6527 * Elementary (container) object
6529 * @param parent The parent object
6530 * @return a new file selector button widget handle or @c NULL, on
6533 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6536 * Set the label for a given file selector button widget
6538 * @param obj The file selector button widget
6539 * @param label The text label to be displayed on @p obj
6541 * @deprecated use elm_object_text_set() instead.
6543 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6546 * Get the label set for a given file selector button widget
6548 * @param obj The file selector button widget
6549 * @return The button label
6551 * @deprecated use elm_object_text_set() instead.
6553 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6556 * Set the icon on a given file selector button widget
6558 * @param obj The file selector button widget
6559 * @param icon The icon object for the button
6561 * Once the icon object is set, a previously set one will be
6562 * deleted. If you want to keep the latter, use the
6563 * elm_fileselector_button_icon_unset() function.
6565 * @see elm_fileselector_button_icon_get()
6567 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6570 * Get the icon set for a given file selector button widget
6572 * @param obj The file selector button widget
6573 * @return The icon object currently set on @p obj or @c NULL, if
6576 * @see elm_fileselector_button_icon_set()
6578 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6581 * Unset the icon used in a given file selector button widget
6583 * @param obj The file selector button widget
6584 * @return The icon object that was being used on @p obj or @c
6587 * Unparent and return the icon object which was set for this
6590 * @see elm_fileselector_button_icon_set()
6592 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6595 * Set the title for a given file selector button widget's window
6597 * @param obj The file selector button widget
6598 * @param title The title string
6600 * This will change the window's title, when the file selector pops
6601 * out after a click on the button. Those windows have the default
6602 * (unlocalized) value of @c "Select a file" as titles.
6604 * @note It will only take any effect if the file selector
6605 * button widget is @b not under "inwin mode".
6607 * @see elm_fileselector_button_window_title_get()
6609 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6612 * Get the title set for a given file selector button widget's
6615 * @param obj The file selector button widget
6616 * @return Title of the file selector button's window
6618 * @see elm_fileselector_button_window_title_get() for more details
6620 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6623 * Set the size of a given file selector button widget's window,
6624 * holding the file selector itself.
6626 * @param obj The file selector button widget
6627 * @param width The window's width
6628 * @param height The window's height
6630 * @note it will only take any effect if the file selector button
6631 * widget is @b not under "inwin mode". The default size for the
6632 * window (when applicable) is 400x400 pixels.
6634 * @see elm_fileselector_button_window_size_get()
6636 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6639 * Get the size of a given file selector button widget's window,
6640 * holding the file selector itself.
6642 * @param obj The file selector button widget
6643 * @param width Pointer into which to store the width value
6644 * @param height Pointer into which to store the height value
6646 * @note Use @c NULL pointers on the size values you're not
6647 * interested in: they'll be ignored by the function.
6649 * @see elm_fileselector_button_window_size_set(), for more details
6651 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6654 * Set the initial file system path for a given file selector
6657 * @param obj The file selector button widget
6658 * @param path The path string
6660 * It must be a <b>directory</b> path, which will have the contents
6661 * displayed initially in the file selector's view, when invoked
6662 * from @p obj. The default initial path is the @c "HOME"
6663 * environment variable's value.
6665 * @see elm_fileselector_button_path_get()
6667 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6670 * Get the initial file system path set for a given file selector
6673 * @param obj The file selector button widget
6674 * @return path The path string
6676 * @see elm_fileselector_button_path_set() for more details
6678 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6681 * Enable/disable a tree view in the given file selector button
6682 * widget's internal file selector
6684 * @param obj The file selector button widget
6685 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6688 * This has the same effect as elm_fileselector_expandable_set(),
6689 * but now applied to a file selector button's internal file
6692 * @note There's no way to put a file selector button's internal
6693 * file selector in "grid mode", as one may do with "pure" file
6696 * @see elm_fileselector_expandable_get()
6698 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6701 * Get whether tree view is enabled for the given file selector
6702 * button widget's internal file selector
6704 * @param obj The file selector button widget
6705 * @return @c EINA_TRUE if @p obj widget's internal file selector
6706 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6708 * @see elm_fileselector_expandable_set() for more details
6710 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6713 * Set whether a given file selector button widget's internal file
6714 * selector is to display folders only or the directory contents,
6717 * @param obj The file selector button widget
6718 * @param only @c EINA_TRUE to make @p obj widget's internal file
6719 * selector only display directories, @c EINA_FALSE to make files
6720 * to be displayed in it too
6722 * This has the same effect as elm_fileselector_folder_only_set(),
6723 * but now applied to a file selector button's internal file
6726 * @see elm_fileselector_folder_only_get()
6728 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6731 * Get whether a given file selector button widget's internal file
6732 * selector is displaying folders only or the directory contents,
6735 * @param obj The file selector button widget
6736 * @return @c EINA_TRUE if @p obj widget's internal file
6737 * selector is only displaying directories, @c EINA_FALSE if files
6738 * are being displayed in it too (and on errors)
6740 * @see elm_fileselector_button_folder_only_set() for more details
6742 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6745 * Enable/disable the file name entry box where the user can type
6746 * in a name for a file, in a given file selector button widget's
6747 * internal file selector.
6749 * @param obj The file selector button widget
6750 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6751 * file selector a "saving dialog", @c EINA_FALSE otherwise
6753 * This has the same effect as elm_fileselector_is_save_set(),
6754 * but now applied to a file selector button's internal file
6757 * @see elm_fileselector_is_save_get()
6759 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6762 * Get whether the given file selector button widget's internal
6763 * file selector is in "saving dialog" mode
6765 * @param obj The file selector button widget
6766 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6767 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6770 * @see elm_fileselector_button_is_save_set() for more details
6772 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6775 * Set whether a given file selector button widget's internal file
6776 * selector will raise an Elementary "inner window", instead of a
6777 * dedicated Elementary window. By default, it won't.
6779 * @param obj The file selector button widget
6780 * @param value @c EINA_TRUE to make it use an inner window, @c
6781 * EINA_TRUE to make it use a dedicated window
6783 * @see elm_win_inwin_add() for more information on inner windows
6784 * @see elm_fileselector_button_inwin_mode_get()
6786 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6789 * Get whether a given file selector button widget's internal file
6790 * selector will raise an Elementary "inner window", instead of a
6791 * dedicated Elementary window.
6793 * @param obj The file selector button widget
6794 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6795 * if it will use a dedicated window
6797 * @see elm_fileselector_button_inwin_mode_set() for more details
6799 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6806 * @defgroup File_Selector_Entry File Selector Entry
6808 * @image html img/widget/fileselector_entry/preview-00.png
6809 * @image latex img/widget/fileselector_entry/preview-00.eps
6811 * This is an entry made to be filled with or display a <b>file
6812 * system path string</b>. Besides the entry itself, the widget has
6813 * a @ref File_Selector_Button "file selector button" on its side,
6814 * which will raise an internal @ref Fileselector "file selector widget",
6815 * when clicked, for path selection aided by file system
6818 * This file selector may appear in an Elementary window or in an
6819 * inner window. When a file is chosen from it, the (inner) window
6820 * is closed and the selected file's path string is exposed both as
6821 * an smart event and as the new text on the entry.
6823 * This widget encapsulates operations on its internal file
6824 * selector on its own API. There is less control over its file
6825 * selector than that one would have instatiating one directly.
6827 * Smart callbacks one can register to:
6828 * - @c "changed" - The text within the entry was changed
6829 * - @c "activated" - The entry has had editing finished and
6830 * changes are to be "committed"
6831 * - @c "press" - The entry has been clicked
6832 * - @c "longpressed" - The entry has been clicked (and held) for a
6834 * - @c "clicked" - The entry has been clicked
6835 * - @c "clicked,double" - The entry has been double clicked
6836 * - @c "focused" - The entry has received focus
6837 * - @c "unfocused" - The entry has lost focus
6838 * - @c "selection,paste" - A paste action has occurred on the
6840 * - @c "selection,copy" - A copy action has occurred on the entry
6841 * - @c "selection,cut" - A cut action has occurred on the entry
6842 * - @c "unpressed" - The file selector entry's button was released
6843 * after being pressed.
6844 * - @c "file,chosen" - The user has selected a path via the file
6845 * selector entry's internal file selector, whose string pointer
6846 * comes as the @c event_info data (a stringshared string)
6848 * Here is an example on its usage:
6849 * @li @ref fileselector_entry_example
6851 * @see @ref File_Selector_Button for a similar widget.
6856 * Add a new file selector entry widget to the given parent
6857 * Elementary (container) object
6859 * @param parent The parent object
6860 * @return a new file selector entry widget handle or @c NULL, on
6863 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6866 * Set the label for a given file selector entry widget's button
6868 * @param obj The file selector entry widget
6869 * @param label The text label to be displayed on @p obj widget's
6872 * @deprecated use elm_object_text_set() instead.
6874 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6877 * Get the label set for a given file selector entry widget's button
6879 * @param obj The file selector entry widget
6880 * @return The widget button's label
6882 * @deprecated use elm_object_text_set() instead.
6884 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6887 * Set the icon on a given file selector entry widget's button
6889 * @param obj The file selector entry widget
6890 * @param icon The icon object for the entry's button
6892 * Once the icon object is set, a previously set one will be
6893 * deleted. If you want to keep the latter, use the
6894 * elm_fileselector_entry_button_icon_unset() function.
6896 * @see elm_fileselector_entry_button_icon_get()
6898 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6901 * Get the icon set for a given file selector entry widget's button
6903 * @param obj The file selector entry widget
6904 * @return The icon object currently set on @p obj widget's button
6905 * or @c NULL, if none is
6907 * @see elm_fileselector_entry_button_icon_set()
6909 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6912 * Unset the icon used in a given file selector entry widget's
6915 * @param obj The file selector entry widget
6916 * @return The icon object that was being used on @p obj widget's
6917 * button or @c NULL, on errors
6919 * Unparent and return the icon object which was set for this
6922 * @see elm_fileselector_entry_button_icon_set()
6924 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6927 * Set the title for a given file selector entry widget's window
6929 * @param obj The file selector entry widget
6930 * @param title The title string
6932 * This will change the window's title, when the file selector pops
6933 * out after a click on the entry's button. Those windows have the
6934 * default (unlocalized) value of @c "Select a file" as titles.
6936 * @note It will only take any effect if the file selector
6937 * entry widget is @b not under "inwin mode".
6939 * @see elm_fileselector_entry_window_title_get()
6941 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6944 * Get the title set for a given file selector entry widget's
6947 * @param obj The file selector entry widget
6948 * @return Title of the file selector entry's window
6950 * @see elm_fileselector_entry_window_title_get() for more details
6952 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6955 * Set the size of a given file selector entry widget's window,
6956 * holding the file selector itself.
6958 * @param obj The file selector entry widget
6959 * @param width The window's width
6960 * @param height The window's height
6962 * @note it will only take any effect if the file selector entry
6963 * widget is @b not under "inwin mode". The default size for the
6964 * window (when applicable) is 400x400 pixels.
6966 * @see elm_fileselector_entry_window_size_get()
6968 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6971 * Get the size of a given file selector entry widget's window,
6972 * holding the file selector itself.
6974 * @param obj The file selector entry widget
6975 * @param width Pointer into which to store the width value
6976 * @param height Pointer into which to store the height value
6978 * @note Use @c NULL pointers on the size values you're not
6979 * interested in: they'll be ignored by the function.
6981 * @see elm_fileselector_entry_window_size_set(), for more details
6983 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6986 * Set the initial file system path and the entry's path string for
6987 * a given file selector entry widget
6989 * @param obj The file selector entry widget
6990 * @param path The path string
6992 * It must be a <b>directory</b> path, which will have the contents
6993 * displayed initially in the file selector's view, when invoked
6994 * from @p obj. The default initial path is the @c "HOME"
6995 * environment variable's value.
6997 * @see elm_fileselector_entry_path_get()
6999 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7002 * Get the entry's path string for a given file selector entry
7005 * @param obj The file selector entry widget
7006 * @return path The path string
7008 * @see elm_fileselector_entry_path_set() for more details
7010 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7013 * Enable/disable a tree view in the given file selector entry
7014 * widget's internal file selector
7016 * @param obj The file selector entry widget
7017 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
7020 * This has the same effect as elm_fileselector_expandable_set(),
7021 * but now applied to a file selector entry's internal file
7024 * @note There's no way to put a file selector entry's internal
7025 * file selector in "grid mode", as one may do with "pure" file
7028 * @see elm_fileselector_expandable_get()
7030 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7033 * Get whether tree view is enabled for the given file selector
7034 * entry widget's internal file selector
7036 * @param obj The file selector entry widget
7037 * @return @c EINA_TRUE if @p obj widget's internal file selector
7038 * is in tree view, @c EINA_FALSE otherwise (and or errors)
7040 * @see elm_fileselector_expandable_set() for more details
7042 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7045 * Set whether a given file selector entry widget's internal file
7046 * selector is to display folders only or the directory contents,
7049 * @param obj The file selector entry widget
7050 * @param only @c EINA_TRUE to make @p obj widget's internal file
7051 * selector only display directories, @c EINA_FALSE to make files
7052 * to be displayed in it too
7054 * This has the same effect as elm_fileselector_folder_only_set(),
7055 * but now applied to a file selector entry's internal file
7058 * @see elm_fileselector_folder_only_get()
7060 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7063 * Get whether a given file selector entry widget's internal file
7064 * selector is displaying folders only or the directory contents,
7067 * @param obj The file selector entry widget
7068 * @return @c EINA_TRUE if @p obj widget's internal file
7069 * selector is only displaying directories, @c EINA_FALSE if files
7070 * are being displayed in it too (and on errors)
7072 * @see elm_fileselector_entry_folder_only_set() for more details
7074 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7077 * Enable/disable the file name entry box where the user can type
7078 * in a name for a file, in a given file selector entry widget's
7079 * internal file selector.
7081 * @param obj The file selector entry widget
7082 * @param is_save @c EINA_TRUE to make @p obj widget's internal
7083 * file selector a "saving dialog", @c EINA_FALSE otherwise
7085 * This has the same effect as elm_fileselector_is_save_set(),
7086 * but now applied to a file selector entry's internal file
7089 * @see elm_fileselector_is_save_get()
7091 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7094 * Get whether the given file selector entry widget's internal
7095 * file selector is in "saving dialog" mode
7097 * @param obj The file selector entry widget
7098 * @return @c EINA_TRUE, if @p obj widget's internal file selector
7099 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7102 * @see elm_fileselector_entry_is_save_set() for more details
7104 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7107 * Set whether a given file selector entry widget's internal file
7108 * selector will raise an Elementary "inner window", instead of a
7109 * dedicated Elementary window. By default, it won't.
7111 * @param obj The file selector entry widget
7112 * @param value @c EINA_TRUE to make it use an inner window, @c
7113 * EINA_TRUE to make it use a dedicated window
7115 * @see elm_win_inwin_add() for more information on inner windows
7116 * @see elm_fileselector_entry_inwin_mode_get()
7118 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7121 * Get whether a given file selector entry widget's internal file
7122 * selector will raise an Elementary "inner window", instead of a
7123 * dedicated Elementary window.
7125 * @param obj The file selector entry widget
7126 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7127 * if it will use a dedicated window
7129 * @see elm_fileselector_entry_inwin_mode_set() for more details
7131 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7134 * Set the initial file system path for a given file selector entry
7137 * @param obj The file selector entry widget
7138 * @param path The path string
7140 * It must be a <b>directory</b> path, which will have the contents
7141 * displayed initially in the file selector's view, when invoked
7142 * from @p obj. The default initial path is the @c "HOME"
7143 * environment variable's value.
7145 * @see elm_fileselector_entry_path_get()
7147 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7150 * Get the parent directory's path to the latest file selection on
7151 * a given filer selector entry widget
7153 * @param obj The file selector object
7154 * @return The (full) path of the directory of the last selection
7155 * on @p obj widget, a @b stringshared string
7157 * @see elm_fileselector_entry_path_set()
7159 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7166 * @defgroup Scroller Scroller
7168 * A scroller holds a single object and "scrolls it around". This means that
7169 * it allows the user to use a scrollbar (or a finger) to drag the viewable
7170 * region around, allowing to move through a much larger object that is
7171 * contained in the scroller. The scroller will always have a small minimum
7172 * size by default as it won't be limited by the contents of the scroller.
7174 * Signals that you can add callbacks for are:
7175 * @li "edge,left" - the left edge of the content has been reached
7176 * @li "edge,right" - the right edge of the content has been reached
7177 * @li "edge,top" - the top edge of the content has been reached
7178 * @li "edge,bottom" - the bottom edge of the content has been reached
7179 * @li "scroll" - the content has been scrolled (moved)
7180 * @li "scroll,anim,start" - scrolling animation has started
7181 * @li "scroll,anim,stop" - scrolling animation has stopped
7182 * @li "scroll,drag,start" - dragging the contents around has started
7183 * @li "scroll,drag,stop" - dragging the contents around has stopped
7184 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7187 * @note When Elemementary is in embedded mode the scrollbars will not be
7188 * dragable, they appear merely as indicators of how much has been scrolled.
7189 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7190 * fingerscroll) won't work.
7192 * Default contents parts of the scroller widget that you can use for are:
7193 * @li "default" - A content of the scroller
7195 * In @ref tutorial_scroller you'll find an example of how to use most of
7200 * @brief Type that controls when scrollbars should appear.
7202 * @see elm_scroller_policy_set()
7204 typedef enum _Elm_Scroller_Policy
7206 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7207 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7208 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7209 ELM_SCROLLER_POLICY_LAST
7210 } Elm_Scroller_Policy;
7212 * @brief Add a new scroller to the parent
7214 * @param parent The parent object
7215 * @return The new object or NULL if it cannot be created
7217 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7219 * @brief Set the content of the scroller widget (the object to be scrolled around).
7221 * @param obj The scroller object
7222 * @param content The new content object
7224 * Once the content object is set, a previously set one will be deleted.
7225 * If you want to keep that old content object, use the
7226 * elm_scroller_content_unset() function.
7227 * @deprecated use elm_object_content_set() instead
7229 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7231 * @brief Get the content of the scroller widget
7233 * @param obj The slider object
7234 * @return The content that is being used
7236 * Return the content object which is set for this widget
7238 * @see elm_scroller_content_set()
7239 * @deprecated use elm_object_content_get() instead.
7241 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7243 * @brief Unset the content of the scroller widget
7245 * @param obj The slider object
7246 * @return The content that was being used
7248 * Unparent and return the content object which was set for this widget
7250 * @see elm_scroller_content_set()
7251 * @deprecated use elm_object_content_unset() instead.
7253 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7255 * @brief Set custom theme elements for the scroller
7257 * @param obj The scroller object
7258 * @param widget The widget name to use (default is "scroller")
7259 * @param base The base name to use (default is "base")
7261 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7263 * @brief Make the scroller minimum size limited to the minimum size of the content
7265 * @param obj The scroller object
7266 * @param w Enable limiting minimum size horizontally
7267 * @param h Enable limiting minimum size vertically
7269 * By default the scroller will be as small as its design allows,
7270 * irrespective of its content. This will make the scroller minimum size the
7271 * right size horizontally and/or vertically to perfectly fit its content in
7274 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7276 * @brief Show a specific virtual region within the scroller content object
7278 * @param obj The scroller object
7279 * @param x X coordinate of the region
7280 * @param y Y coordinate of the region
7281 * @param w Width of the region
7282 * @param h Height of the region
7284 * This will ensure all (or part if it does not fit) of the designated
7285 * region in the virtual content object (0, 0 starting at the top-left of the
7286 * virtual content object) is shown within the scroller.
7288 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);
7290 * @brief Set the scrollbar visibility policy
7292 * @param obj The scroller object
7293 * @param policy_h Horizontal scrollbar policy
7294 * @param policy_v Vertical scrollbar policy
7296 * This sets the scrollbar visibility policy for the given scroller.
7297 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7298 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7299 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7300 * respectively for the horizontal and vertical scrollbars.
7302 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7304 * @brief Gets scrollbar visibility policy
7306 * @param obj The scroller object
7307 * @param policy_h Horizontal scrollbar policy
7308 * @param policy_v Vertical scrollbar policy
7310 * @see elm_scroller_policy_set()
7312 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7314 * @brief Get the currently visible content region
7316 * @param obj The scroller object
7317 * @param x X coordinate of the region
7318 * @param y Y coordinate of the region
7319 * @param w Width of the region
7320 * @param h Height of the region
7322 * This gets the current region in the content object that is visible through
7323 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7324 * w, @p h values pointed to.
7326 * @note All coordinates are relative to the content.
7328 * @see elm_scroller_region_show()
7330 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);
7332 * @brief Get the size of the content object
7334 * @param obj The scroller object
7335 * @param w Width of the content object.
7336 * @param h Height of the content object.
7338 * This gets the size of the content object of the scroller.
7340 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7342 * @brief Set bouncing behavior
7344 * @param obj The scroller object
7345 * @param h_bounce Allow bounce horizontally
7346 * @param v_bounce Allow bounce vertically
7348 * When scrolling, the scroller may "bounce" when reaching an edge of the
7349 * content object. This is a visual way to indicate the end has been reached.
7350 * This is enabled by default for both axis. This API will set if it is enabled
7351 * for the given axis with the boolean parameters for each axis.
7353 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7355 * @brief Get the bounce behaviour
7357 * @param obj The Scroller object
7358 * @param h_bounce Will the scroller bounce horizontally or not
7359 * @param v_bounce Will the scroller bounce vertically or not
7361 * @see elm_scroller_bounce_set()
7363 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7365 * @brief Set scroll page size relative to viewport size.
7367 * @param obj The scroller object
7368 * @param h_pagerel The horizontal page relative size
7369 * @param v_pagerel The vertical page relative size
7371 * The scroller is capable of limiting scrolling by the user to "pages". That
7372 * is to jump by and only show a "whole page" at a time as if the continuous
7373 * area of the scroller content is split into page sized pieces. This sets
7374 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7375 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7376 * axis. This is mutually exclusive with page size
7377 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7378 * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7379 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7382 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7384 * @brief Set scroll page size.
7386 * @param obj The scroller object
7387 * @param h_pagesize The horizontal page size
7388 * @param v_pagesize The vertical page size
7390 * This sets the page size to an absolute fixed value, with 0 turning it off
7393 * @see elm_scroller_page_relative_set()
7395 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7397 * @brief Get scroll current page number.
7399 * @param obj The scroller object
7400 * @param h_pagenumber The horizontal page number
7401 * @param v_pagenumber The vertical page number
7403 * The page number starts from 0. 0 is the first page.
7404 * Current page means the page which meets the top-left of the viewport.
7405 * If there are two or more pages in the viewport, it returns the number of the page
7406 * which meets the top-left of the viewport.
7408 * @see elm_scroller_last_page_get()
7409 * @see elm_scroller_page_show()
7410 * @see elm_scroller_page_brint_in()
7412 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7414 * @brief Get scroll last page number.
7416 * @param obj The scroller object
7417 * @param h_pagenumber The horizontal page number
7418 * @param v_pagenumber The vertical page number
7420 * The page number starts from 0. 0 is the first page.
7421 * This returns the last page number among the pages.
7423 * @see elm_scroller_current_page_get()
7424 * @see elm_scroller_page_show()
7425 * @see elm_scroller_page_brint_in()
7427 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7429 * Show a specific virtual region within the scroller content object by page number.
7431 * @param obj The scroller object
7432 * @param h_pagenumber The horizontal page number
7433 * @param v_pagenumber The vertical page number
7435 * 0, 0 of the indicated page is located at the top-left of the viewport.
7436 * This will jump to the page directly without animation.
7441 * sc = elm_scroller_add(win);
7442 * elm_scroller_content_set(sc, content);
7443 * elm_scroller_page_relative_set(sc, 1, 0);
7444 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7445 * elm_scroller_page_show(sc, h_page + 1, v_page);
7448 * @see elm_scroller_page_bring_in()
7450 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7452 * Show a specific virtual region within the scroller content object by page number.
7454 * @param obj The scroller object
7455 * @param h_pagenumber The horizontal page number
7456 * @param v_pagenumber The vertical page number
7458 * 0, 0 of the indicated page is located at the top-left of the viewport.
7459 * This will slide to the page with animation.
7464 * sc = elm_scroller_add(win);
7465 * elm_scroller_content_set(sc, content);
7466 * elm_scroller_page_relative_set(sc, 1, 0);
7467 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7468 * elm_scroller_page_bring_in(sc, h_page, v_page);
7471 * @see elm_scroller_page_show()
7473 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7475 * @brief Show a specific virtual region within the scroller content object.
7477 * @param obj The scroller object
7478 * @param x X coordinate of the region
7479 * @param y Y coordinate of the region
7480 * @param w Width of the region
7481 * @param h Height of the region
7483 * This will ensure all (or part if it does not fit) of the designated
7484 * region in the virtual content object (0, 0 starting at the top-left of the
7485 * virtual content object) is shown within the scroller. Unlike
7486 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7487 * to this location (if configuration in general calls for transitions). It
7488 * may not jump immediately to the new location and make take a while and
7489 * show other content along the way.
7491 * @see elm_scroller_region_show()
7493 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);
7495 * @brief Set event propagation on a scroller
7497 * @param obj The scroller object
7498 * @param propagation If propagation is enabled or not
7500 * This enables or disabled event propagation from the scroller content to
7501 * the scroller and its parent. By default event propagation is disabled.
7503 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7505 * @brief Get event propagation for a scroller
7507 * @param obj The scroller object
7508 * @return The propagation state
7510 * This gets the event propagation for a scroller.
7512 * @see elm_scroller_propagate_events_set()
7514 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7516 * @brief Set scrolling gravity on a scroller
7518 * @param obj The scroller object
7519 * @param x The scrolling horizontal gravity
7520 * @param y The scrolling vertical gravity
7522 * The gravity, defines how the scroller will adjust its view
7523 * when the size of the scroller contents increase.
7525 * The scroller will adjust the view to glue itself as follows.
7527 * x=0.0, for showing the left most region of the content.
7528 * x=1.0, for showing the right most region of the content.
7529 * y=0.0, for showing the bottom most region of the content.
7530 * y=1.0, for showing the top most region of the content.
7532 * Default values for x and y are 0.0
7534 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7536 * @brief Get scrolling gravity values for a scroller
7538 * @param obj The scroller object
7539 * @param x The scrolling horizontal gravity
7540 * @param y The scrolling vertical gravity
7542 * This gets gravity values for a scroller.
7544 * @see elm_scroller_gravity_set()
7547 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7553 * @defgroup Label Label
7555 * @image html img/widget/label/preview-00.png
7556 * @image latex img/widget/label/preview-00.eps
7558 * @brief Widget to display text, with simple html-like markup.
7560 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7561 * text doesn't fit the geometry of the label it will be ellipsized or be
7562 * cut. Elementary provides several themes for this widget:
7563 * @li default - No animation
7564 * @li marker - Centers the text in the label and make it bold by default
7565 * @li slide_long - The entire text appears from the right of the screen and
7566 * slides until it disappears in the left of the screen(reappering on the
7568 * @li slide_short - The text appears in the left of the label and slides to
7569 * the right to show the overflow. When all of the text has been shown the
7570 * position is reset.
7571 * @li slide_bounce - The text appears in the left of the label and slides to
7572 * the right to show the overflow. When all of the text has been shown the
7573 * animation reverses, moving the text to the left.
7575 * Custom themes can of course invent new markup tags and style them any way
7578 * The following signals may be emitted by the label widget:
7579 * @li "language,changed": The program's language changed.
7581 * See @ref tutorial_label for a demonstration of how to use a label widget.
7585 * @brief Add a new label to the parent
7587 * @param parent The parent object
7588 * @return The new object or NULL if it cannot be created
7590 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7592 * @brief Set the label on the label object
7594 * @param obj The label object
7595 * @param label The label will be used on the label object
7596 * @deprecated See elm_object_text_set()
7598 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 */
7600 * @brief Get the label used on the label object
7602 * @param obj The label object
7603 * @return The string inside the label
7604 * @deprecated See elm_object_text_get()
7606 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7608 * @brief Set the wrapping behavior of the label
7610 * @param obj The label object
7611 * @param wrap To wrap text or not
7613 * By default no wrapping is done. Possible values for @p wrap are:
7614 * @li ELM_WRAP_NONE - No wrapping
7615 * @li ELM_WRAP_CHAR - wrap between characters
7616 * @li ELM_WRAP_WORD - wrap between words
7617 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7619 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7621 * @brief Get the wrapping behavior of the label
7623 * @param obj The label object
7626 * @see elm_label_line_wrap_set()
7628 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7630 * @brief Set wrap width of the label
7632 * @param obj The label object
7633 * @param w The wrap width in pixels at a minimum where words need to wrap
7635 * This function sets the maximum width size hint of the label.
7637 * @warning This is only relevant if the label is inside a container.
7639 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7641 * @brief Get wrap width of the label
7643 * @param obj The label object
7644 * @return The wrap width in pixels at a minimum where words need to wrap
7646 * @see elm_label_wrap_width_set()
7648 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7650 * @brief Set wrap height of the label
7652 * @param obj The label object
7653 * @param h The wrap height in pixels at a minimum where words need to wrap
7655 * This function sets the maximum height size hint of the label.
7657 * @warning This is only relevant if the label is inside a container.
7659 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7661 * @brief get wrap width of the label
7663 * @param obj The label object
7664 * @return The wrap height in pixels at a minimum where words need to wrap
7666 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7668 * @brief Set the font size on the label object.
7670 * @param obj The label object
7671 * @param size font size
7673 * @warning NEVER use this. It is for hyper-special cases only. use styles
7674 * instead. e.g. "big", "medium", "small" - or better name them by use:
7675 * "title", "footnote", "quote" etc.
7677 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7679 * @brief Set the text color on the label object
7681 * @param obj The label object
7682 * @param r Red property background color of The label object
7683 * @param g Green property background color of The label object
7684 * @param b Blue property background color of The label object
7685 * @param a Alpha property background color of The label object
7687 * @warning NEVER use this. It is for hyper-special cases only. use styles
7688 * instead. e.g. "big", "medium", "small" - or better name them by use:
7689 * "title", "footnote", "quote" etc.
7691 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);
7693 * @brief Set the text align on the label object
7695 * @param obj The label object
7696 * @param align align mode ("left", "center", "right")
7698 * @warning NEVER use this. It is for hyper-special cases only. use styles
7699 * instead. e.g. "big", "medium", "small" - or better name them by use:
7700 * "title", "footnote", "quote" etc.
7702 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7704 * @brief Set background color of the label
7706 * @param obj The label object
7707 * @param r Red property background color of The label object
7708 * @param g Green property background color of The label object
7709 * @param b Blue property background color of The label object
7710 * @param a Alpha property background alpha of The label object
7712 * @warning NEVER use this. It is for hyper-special cases only. use styles
7713 * instead. e.g. "big", "medium", "small" - or better name them by use:
7714 * "title", "footnote", "quote" etc.
7716 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);
7718 * @brief Set the ellipsis behavior of the label
7720 * @param obj The label object
7721 * @param ellipsis To ellipsis text or not
7723 * If set to true and the text doesn't fit in the label an ellipsis("...")
7724 * will be shown at the end of the widget.
7726 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7727 * choosen wrap method was ELM_WRAP_WORD.
7729 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7730 EINA_DEPRECATED EAPI void elm_label_wrap_mode_set(Evas_Object *obj, Eina_Bool wrapmode) EINA_ARG_NONNULL(1);
7732 * @brief Set the text slide of the label
7734 * @param obj The label object
7735 * @param slide To start slide or stop
7737 * If set to true, the text of the label will slide/scroll through the length of
7740 * @warning This only works with the themes "slide_short", "slide_long" and
7743 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7745 * @brief Get the text slide mode of the label
7747 * @param obj The label object
7748 * @return slide slide mode value
7750 * @see elm_label_slide_set()
7752 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7754 * @brief Set the slide duration(speed) of the label
7756 * @param obj The label object
7757 * @return The duration in seconds in moving text from slide begin position
7758 * to slide end position
7760 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7762 * @brief Get the slide duration(speed) of the label
7764 * @param obj The label object
7765 * @return The duration time in moving text from slide begin position to slide end position
7767 * @see elm_label_slide_duration_set()
7769 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7775 * @defgroup Frame Frame
7777 * @image html img/widget/frame/preview-00.png
7778 * @image latex img/widget/frame/preview-00.eps
7780 * @brief Frame is a widget that holds some content and has a title.
7782 * The default look is a frame with a title, but Frame supports multple
7790 * @li outdent_bottom
7792 * Of all this styles only default shows the title. Frame emits no signals.
7794 * Default contents parts of the frame widget that you can use for are:
7795 * @li "default" - A content of the frame
7797 * Default text parts of the frame widget that you can use for are:
7798 * @li "elm.text" - Label of the frame
7800 * For a detailed example see the @ref tutorial_frame.
7805 * @brief Add a new frame to the parent
7807 * @param parent The parent object
7808 * @return The new object or NULL if it cannot be created
7810 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7812 * @brief Set the frame label
7814 * @param obj The frame object
7815 * @param label The label of this frame object
7817 * @deprecated use elm_object_text_set() instead.
7819 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7821 * @brief Get the frame label
7823 * @param obj The frame object
7825 * @return The label of this frame objet or NULL if unable to get frame
7827 * @deprecated use elm_object_text_get() instead.
7829 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7831 * @brief Set the content of the frame widget
7833 * Once the content object is set, a previously set one will be deleted.
7834 * If you want to keep that old content object, use the
7835 * elm_frame_content_unset() function.
7837 * @param obj The frame object
7838 * @param content The content will be filled in this frame object
7840 * @deprecated use elm_object_content_set() instead.
7842 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7844 * @brief Get the content of the frame widget
7846 * Return the content object which is set for this widget
7848 * @param obj The frame object
7849 * @return The content that is being used
7851 * @deprecated use elm_object_content_get() instead.
7853 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7855 * @brief Unset the content of the frame widget
7857 * Unparent and return the content object which was set for this widget
7859 * @param obj The frame object
7860 * @return The content that was being used
7862 * @deprecated use elm_object_content_unset() instead.
7864 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7870 * @defgroup Table Table
7872 * A container widget to arrange other widgets in a table where items can
7873 * also span multiple columns or rows - even overlap (and then be raised or
7874 * lowered accordingly to adjust stacking if they do overlap).
7876 * For a Table widget the row/column count is not fixed.
7877 * The table widget adjusts itself when subobjects are added to it dynamically.
7879 * The followin are examples of how to use a table:
7880 * @li @ref tutorial_table_01
7881 * @li @ref tutorial_table_02
7886 * @brief Add a new table to the parent
7888 * @param parent The parent object
7889 * @return The new object or NULL if it cannot be created
7891 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7893 * @brief Set the homogeneous layout in the table
7895 * @param obj The layout object
7896 * @param homogeneous A boolean to set if the layout is homogeneous in the
7897 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7899 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7901 * @brief Get the current table homogeneous mode.
7903 * @param obj The table object
7904 * @return A boolean to indicating if the layout is homogeneous in the table
7905 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7907 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7909 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7911 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7913 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7915 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7917 * @brief Set padding between cells.
7919 * @param obj The layout object.
7920 * @param horizontal set the horizontal padding.
7921 * @param vertical set the vertical padding.
7923 * Default value is 0.
7925 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7927 * @brief Get padding between cells.
7929 * @param obj The layout object.
7930 * @param horizontal set the horizontal padding.
7931 * @param vertical set the vertical padding.
7933 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7935 * @brief Add a subobject on the table with the coordinates passed
7937 * @param obj The table object
7938 * @param subobj The subobject to be added to the table
7939 * @param x Row number
7940 * @param y Column number
7944 * @note All positioning inside the table is relative to rows and columns, so
7945 * a value of 0 for x and y, means the top left cell of the table, and a
7946 * value of 1 for w and h means @p subobj only takes that 1 cell.
7948 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7950 * @brief Remove child from table.
7952 * @param obj The table object
7953 * @param subobj The subobject
7955 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7957 * @brief Faster way to remove all child objects from a table object.
7959 * @param obj The table object
7960 * @param clear If true, will delete children, else just remove from table.
7962 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7964 * @brief Set the packing location of an existing child of the table
7966 * @param subobj The subobject to be modified in the table
7967 * @param x Row number
7968 * @param y Column number
7972 * Modifies the position of an object already in the table.
7974 * @note All positioning inside the table is relative to rows and columns, so
7975 * a value of 0 for x and y, means the top left cell of the table, and a
7976 * value of 1 for w and h means @p subobj only takes that 1 cell.
7978 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7980 * @brief Get the packing location of an existing child of the table
7982 * @param subobj The subobject to be modified in the table
7983 * @param x Row number
7984 * @param y Column number
7988 * @see elm_table_pack_set()
7990 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7996 * @defgroup Gengrid Gengrid (Generic grid)
7998 * This widget aims to position objects in a grid layout while
7999 * actually creating and rendering only the visible ones, using the
8000 * same idea as the @ref Genlist "genlist": the user defines a @b
8001 * class for each item, specifying functions that will be called at
8002 * object creation, deletion, etc. When those items are selected by
8003 * the user, a callback function is issued. Users may interact with
8004 * a gengrid via the mouse (by clicking on items to select them and
8005 * clicking on the grid's viewport and swiping to pan the whole
8006 * view) or via the keyboard, navigating through item with the
8009 * @section Gengrid_Layouts Gengrid layouts
8011 * Gengrid may layout its items in one of two possible layouts:
8015 * When in "horizontal mode", items will be placed in @b columns,
8016 * from top to bottom and, when the space for a column is filled,
8017 * another one is started on the right, thus expanding the grid
8018 * horizontally, making for horizontal scrolling. When in "vertical
8019 * mode" , though, items will be placed in @b rows, from left to
8020 * right and, when the space for a row is filled, another one is
8021 * started below, thus expanding the grid vertically (and making
8022 * for vertical scrolling).
8024 * @section Gengrid_Items Gengrid items
8026 * An item in a gengrid can have 0 or more text labels (they can be
8027 * regular text or textblock Evas objects - that's up to the style
8028 * to determine), 0 or more icons (which are simply objects
8029 * swallowed into the gengrid item's theming Edje object) and 0 or
8030 * more <b>boolean states</b>, which have the behavior left to the
8031 * user to define. The Edje part names for each of these properties
8032 * will be looked up, in the theme file for the gengrid, under the
8033 * Edje (string) data items named @c "labels", @c "icons" and @c
8034 * "states", respectively. For each of those properties, if more
8035 * than one part is provided, they must have names listed separated
8036 * by spaces in the data fields. For the default gengrid item
8037 * theme, we have @b one label part (@c "elm.text"), @b two icon
8038 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8041 * A gengrid item may be at one of several styles. Elementary
8042 * provides one by default - "default", but this can be extended by
8043 * system or application custom themes/overlays/extensions (see
8044 * @ref Theme "themes" for more details).
8046 * @section Gengrid_Item_Class Gengrid item classes
8048 * In order to have the ability to add and delete items on the fly,
8049 * gengrid implements a class (callback) system where the
8050 * application provides a structure with information about that
8051 * type of item (gengrid may contain multiple different items with
8052 * different classes, states and styles). Gengrid will call the
8053 * functions in this struct (methods) when an item is "realized"
8054 * (i.e., created dynamically, while the user is scrolling the
8055 * grid). All objects will simply be deleted when no longer needed
8056 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8057 * contains the following members:
8058 * - @c item_style - This is a constant string and simply defines
8059 * the name of the item style. It @b must be specified and the
8060 * default should be @c "default".
8061 * - @c func.label_get - This function is called when an item
8062 * object is actually created. The @c data parameter will point to
8063 * the same data passed to elm_gengrid_item_append() and related
8064 * item creation functions. The @c obj parameter is the gengrid
8065 * object itself, while the @c part one is the name string of one
8066 * of the existing text parts in the Edje group implementing the
8067 * item's theme. This function @b must return a strdup'()ed string,
8068 * as the caller will free() it when done. See
8069 * #Elm_Gengrid_Item_Label_Get_Cb.
8070 * - @c func.content_get - This function is called when an item object
8071 * is actually created. The @c data parameter will point to the
8072 * same data passed to elm_gengrid_item_append() and related item
8073 * creation functions. The @c obj parameter is the gengrid object
8074 * itself, while the @c part one is the name string of one of the
8075 * existing (content) swallow parts in the Edje group implementing the
8076 * item's theme. It must return @c NULL, when no content is desired,
8077 * or a valid object handle, otherwise. The object will be deleted
8078 * by the gengrid on its deletion or when the item is "unrealized".
8079 * See #Elm_Gengrid_Item_Content_Get_Cb.
8080 * - @c func.state_get - This function is called when an item
8081 * object is actually created. The @c data parameter will point to
8082 * the same data passed to elm_gengrid_item_append() and related
8083 * item creation functions. The @c obj parameter is the gengrid
8084 * object itself, while the @c part one is the name string of one
8085 * of the state parts in the Edje group implementing the item's
8086 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8087 * true/on. Gengrids will emit a signal to its theming Edje object
8088 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8089 * "source" arguments, respectively, when the state is true (the
8090 * default is false), where @c XXX is the name of the (state) part.
8091 * See #Elm_Gengrid_Item_State_Get_Cb.
8092 * - @c func.del - This is called when elm_gengrid_item_del() is
8093 * called on an item or elm_gengrid_clear() is called on the
8094 * gengrid. This is intended for use when gengrid items are
8095 * deleted, so any data attached to the item (e.g. its data
8096 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8098 * @section Gengrid_Usage_Hints Usage hints
8100 * If the user wants to have multiple items selected at the same
8101 * time, elm_gengrid_multi_select_set() will permit it. If the
8102 * gengrid is single-selection only (the default), then
8103 * elm_gengrid_select_item_get() will return the selected item or
8104 * @c NULL, if none is selected. If the gengrid is under
8105 * multi-selection, then elm_gengrid_selected_items_get() will
8106 * return a list (that is only valid as long as no items are
8107 * modified (added, deleted, selected or unselected) of child items
8110 * If an item changes (internal (boolean) state, label or content
8111 * changes), then use elm_gengrid_item_update() to have gengrid
8112 * update the item with the new state. A gengrid will re-"realize"
8113 * the item, thus calling the functions in the
8114 * #Elm_Gengrid_Item_Class set for that item.
8116 * To programmatically (un)select an item, use
8117 * elm_gengrid_item_selected_set(). To get its selected state use
8118 * elm_gengrid_item_selected_get(). To make an item disabled
8119 * (unable to be selected and appear differently) use
8120 * elm_gengrid_item_disabled_set() to set this and
8121 * elm_gengrid_item_disabled_get() to get the disabled state.
8123 * Grid cells will only have their selection smart callbacks called
8124 * when firstly getting selected. Any further clicks will do
8125 * nothing, unless you enable the "always select mode", with
8126 * elm_gengrid_always_select_mode_set(), thus making every click to
8127 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8128 * turn off the ability to select items entirely in the widget and
8129 * they will neither appear selected nor call the selection smart
8132 * Remember that you can create new styles and add your own theme
8133 * augmentation per application with elm_theme_extension_add(). If
8134 * you absolutely must have a specific style that overrides any
8135 * theme the user or system sets up you can use
8136 * elm_theme_overlay_add() to add such a file.
8138 * @section Gengrid_Smart_Events Gengrid smart events
8140 * Smart events that you can add callbacks for are:
8141 * - @c "activated" - The user has double-clicked or pressed
8142 * (enter|return|spacebar) on an item. The @c event_info parameter
8143 * is the gengrid item that was activated.
8144 * - @c "clicked,double" - The user has double-clicked an item.
8145 * The @c event_info parameter is the gengrid item that was double-clicked.
8146 * - @c "longpressed" - This is called when the item is pressed for a certain
8147 * amount of time. By default it's 1 second.
8148 * - @c "selected" - The user has made an item selected. The
8149 * @c event_info parameter is the gengrid item that was selected.
8150 * - @c "unselected" - The user has made an item unselected. The
8151 * @c event_info parameter is the gengrid item that was unselected.
8152 * - @c "realized" - This is called when the item in the gengrid
8153 * has its implementing Evas object instantiated, de facto. @c
8154 * event_info is the gengrid item that was created. The object
8155 * may be deleted at any time, so it is highly advised to the
8156 * caller @b not to use the object pointer returned from
8157 * elm_gengrid_item_object_get(), because it may point to freed
8159 * - @c "unrealized" - This is called when the implementing Evas
8160 * object for this item is deleted. @c event_info is the gengrid
8161 * item that was deleted.
8162 * - @c "changed" - Called when an item is added, removed, resized
8163 * or moved and when the gengrid is resized or gets "horizontal"
8165 * - @c "scroll,anim,start" - This is called when scrolling animation has
8167 * - @c "scroll,anim,stop" - This is called when scrolling animation has
8169 * - @c "drag,start,up" - Called when the item in the gengrid has
8170 * been dragged (not scrolled) up.
8171 * - @c "drag,start,down" - Called when the item in the gengrid has
8172 * been dragged (not scrolled) down.
8173 * - @c "drag,start,left" - Called when the item in the gengrid has
8174 * been dragged (not scrolled) left.
8175 * - @c "drag,start,right" - Called when the item in the gengrid has
8176 * been dragged (not scrolled) right.
8177 * - @c "drag,stop" - Called when the item in the gengrid has
8178 * stopped being dragged.
8179 * - @c "drag" - Called when the item in the gengrid is being
8181 * - @c "scroll" - called when the content has been scrolled
8183 * - @c "scroll,drag,start" - called when dragging the content has
8185 * - @c "scroll,drag,stop" - called when dragging the content has
8187 * - @c "edge,top" - This is called when the gengrid is scrolled until
8189 * - @c "edge,bottom" - This is called when the gengrid is scrolled
8190 * until the bottom edge.
8191 * - @c "edge,left" - This is called when the gengrid is scrolled
8192 * until the left edge.
8193 * - @c "edge,right" - This is called when the gengrid is scrolled
8194 * until the right edge.
8196 * List of gengrid examples:
8197 * @li @ref gengrid_example
8201 * @addtogroup Gengrid
8205 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8206 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8207 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8208 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
8209 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. */
8210 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. */
8211 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
8213 /* temporary compatibility code */
8214 typedef Elm_Gengrid_Item_Label_Get_Cb GridItemLabelGetFunc EINA_DEPRECATED;
8215 typedef Elm_Gengrid_Item_Content_Get_Cb GridItemIconGetFunc EINA_DEPRECATED;
8216 typedef Elm_Gengrid_Item_State_Get_Cb GridItemStateGetFunc EINA_DEPRECATED;
8217 typedef Elm_Gengrid_Item_Del_Cb GridItemDelFunc EINA_DEPRECATED;
8220 * @struct _Elm_Gengrid_Item_Class
8222 * Gengrid item class definition. See @ref Gengrid_Item_Class for
8225 struct _Elm_Gengrid_Item_Class
8227 const char *item_style;
8228 struct _Elm_Gengrid_Item_Class_Func
8230 Elm_Gengrid_Item_Label_Get_Cb label_get;
8231 union { /* temporary compatibility code */
8232 Elm_Gengrid_Item_Content_Get_Cb icon_get EINA_DEPRECATED;
8233 Elm_Gengrid_Item_Content_Get_Cb content_get;
8235 Elm_Gengrid_Item_State_Get_Cb state_get;
8236 Elm_Gengrid_Item_Del_Cb del;
8238 }; /**< #Elm_Gengrid_Item_Class member definitions */
8240 * Add a new gengrid widget to the given parent Elementary
8241 * (container) object
8243 * @param parent The parent object
8244 * @return a new gengrid widget handle or @c NULL, on errors
8246 * This function inserts a new gengrid widget on the canvas.
8248 * @see elm_gengrid_item_size_set()
8249 * @see elm_gengrid_group_item_size_set()
8250 * @see elm_gengrid_horizontal_set()
8251 * @see elm_gengrid_item_append()
8252 * @see elm_gengrid_item_del()
8253 * @see elm_gengrid_clear()
8257 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8260 * Set the size for the items of a given gengrid widget
8262 * @param obj The gengrid object.
8263 * @param w The items' width.
8264 * @param h The items' height;
8266 * A gengrid, after creation, has still no information on the size
8267 * to give to each of its cells. So, you most probably will end up
8268 * with squares one @ref Fingers "finger" wide, the default
8269 * size. Use this function to force a custom size for you items,
8270 * making them as big as you wish.
8272 * @see elm_gengrid_item_size_get()
8276 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8279 * Get the size set for the items of a given gengrid widget
8281 * @param obj The gengrid object.
8282 * @param w Pointer to a variable where to store the items' width.
8283 * @param h Pointer to a variable where to store the items' height.
8285 * @note Use @c NULL pointers on the size values you're not
8286 * interested in: they'll be ignored by the function.
8288 * @see elm_gengrid_item_size_get() for more details
8292 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8295 * Set the items grid's alignment within a given gengrid widget
8297 * @param obj The gengrid object.
8298 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8299 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8301 * This sets the alignment of the whole grid of items of a gengrid
8302 * within its given viewport. By default, those values are both
8303 * 0.5, meaning that the gengrid will have its items grid placed
8304 * exactly in the middle of its viewport.
8306 * @note If given alignment values are out of the cited ranges,
8307 * they'll be changed to the nearest boundary values on the valid
8310 * @see elm_gengrid_align_get()
8314 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8317 * Get the items grid's alignment values within a given gengrid
8320 * @param obj The gengrid object.
8321 * @param align_x Pointer to a variable where to store the
8322 * horizontal alignment.
8323 * @param align_y Pointer to a variable where to store the vertical
8326 * @note Use @c NULL pointers on the alignment values you're not
8327 * interested in: they'll be ignored by the function.
8329 * @see elm_gengrid_align_set() for more details
8333 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8336 * Set whether a given gengrid widget is or not able have items
8339 * @param obj The gengrid object
8340 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8341 * @c EINA_FALSE to turn it off
8343 * If a gengrid is set to allow reordering, a click held for more
8344 * than 0.5 over a given item will highlight it specially,
8345 * signalling the gengrid has entered the reordering state. From
8346 * that time on, the user will be able to, while still holding the
8347 * mouse button down, move the item freely in the gengrid's
8348 * viewport, replacing to said item to the locations it goes to.
8349 * The replacements will be animated and, whenever the user
8350 * releases the mouse button, the item being replaced gets a new
8351 * definitive place in the grid.
8353 * @see elm_gengrid_reorder_mode_get()
8357 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8360 * Get whether a given gengrid widget is or not able have items
8363 * @param obj The gengrid object
8364 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8367 * @see elm_gengrid_reorder_mode_set() for more details
8371 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8374 * Append a new item in a given gengrid widget.
8376 * @param obj The gengrid object.
8377 * @param gic The item class for the item.
8378 * @param data The item data.
8379 * @param func Convenience function called when the item is
8381 * @param func_data Data to be passed to @p func.
8382 * @return A handle to the item added or @c NULL, on errors.
8384 * This adds an item to the beginning of the gengrid.
8386 * @see elm_gengrid_item_prepend()
8387 * @see elm_gengrid_item_insert_before()
8388 * @see elm_gengrid_item_insert_after()
8389 * @see elm_gengrid_item_del()
8393 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);
8396 * Prepend a new item in a given gengrid widget.
8398 * @param obj The gengrid object.
8399 * @param gic The item class for the item.
8400 * @param data The item data.
8401 * @param func Convenience function called when the item is
8403 * @param func_data Data to be passed to @p func.
8404 * @return A handle to the item added or @c NULL, on errors.
8406 * This adds an item to the end of the gengrid.
8408 * @see elm_gengrid_item_append()
8409 * @see elm_gengrid_item_insert_before()
8410 * @see elm_gengrid_item_insert_after()
8411 * @see elm_gengrid_item_del()
8415 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);
8418 * Insert an item before another in a gengrid widget
8420 * @param obj The gengrid object.
8421 * @param gic The item class for the item.
8422 * @param data The item data.
8423 * @param relative The item to place this new one before.
8424 * @param func Convenience function called when the item is
8426 * @param func_data Data to be passed to @p func.
8427 * @return A handle to the item added or @c NULL, on errors.
8429 * This inserts an item before another in the gengrid.
8431 * @see elm_gengrid_item_append()
8432 * @see elm_gengrid_item_prepend()
8433 * @see elm_gengrid_item_insert_after()
8434 * @see elm_gengrid_item_del()
8438 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);
8441 * Insert an item after another in a gengrid widget
8443 * @param obj The gengrid object.
8444 * @param gic The item class for the item.
8445 * @param data The item data.
8446 * @param relative The item to place this new one after.
8447 * @param func Convenience function called when the item is
8449 * @param func_data Data to be passed to @p func.
8450 * @return A handle to the item added or @c NULL, on errors.
8452 * This inserts an item after another in the gengrid.
8454 * @see elm_gengrid_item_append()
8455 * @see elm_gengrid_item_prepend()
8456 * @see elm_gengrid_item_insert_after()
8457 * @see elm_gengrid_item_del()
8461 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);
8464 * Insert an item in a gengrid widget using a user-defined sort function.
8466 * @param obj The gengrid object.
8467 * @param gic The item class for the item.
8468 * @param data The item data.
8469 * @param comp User defined comparison function that defines the sort order based on
8470 * Elm_Gen_Item and its data param.
8471 * @param func Convenience function called when the item is selected.
8472 * @param func_data Data to be passed to @p func.
8473 * @return A handle to the item added or @c NULL, on errors.
8475 * This inserts an item in the gengrid based on user defined comparison function.
8477 * @see elm_gengrid_item_append()
8478 * @see elm_gengrid_item_prepend()
8479 * @see elm_gengrid_item_insert_after()
8480 * @see elm_gengrid_item_del()
8481 * @see elm_gengrid_item_direct_sorted_insert()
8485 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);
8488 * Insert an item in a gengrid widget using a user-defined sort function.
8490 * @param obj The gengrid object.
8491 * @param gic The item class for the item.
8492 * @param data The item data.
8493 * @param comp User defined comparison function that defines the sort order based on
8495 * @param func Convenience function called when the item is selected.
8496 * @param func_data Data to be passed to @p func.
8497 * @return A handle to the item added or @c NULL, on errors.
8499 * This inserts an item in the gengrid based on user defined comparison function.
8501 * @see elm_gengrid_item_append()
8502 * @see elm_gengrid_item_prepend()
8503 * @see elm_gengrid_item_insert_after()
8504 * @see elm_gengrid_item_del()
8505 * @see elm_gengrid_item_sorted_insert()
8509 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);
8512 * Set whether items on a given gengrid widget are to get their
8513 * selection callbacks issued for @b every subsequent selection
8514 * click on them or just for the first click.
8516 * @param obj The gengrid object
8517 * @param always_select @c EINA_TRUE to make items "always
8518 * selected", @c EINA_FALSE, otherwise
8520 * By default, grid items will only call their selection callback
8521 * function when firstly getting selected, any subsequent further
8522 * clicks will do nothing. With this call, you make those
8523 * subsequent clicks also to issue the selection callbacks.
8525 * @note <b>Double clicks</b> will @b always be reported on items.
8527 * @see elm_gengrid_always_select_mode_get()
8531 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8534 * Get whether items on a given gengrid widget have their selection
8535 * callbacks issued for @b every subsequent selection click on them
8536 * or just for the first click.
8538 * @param obj The gengrid object.
8539 * @return @c EINA_TRUE if the gengrid items are "always selected",
8540 * @c EINA_FALSE, otherwise
8542 * @see elm_gengrid_always_select_mode_set() for more details
8546 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8549 * Set whether items on a given gengrid widget can be selected or not.
8551 * @param obj The gengrid object
8552 * @param no_select @c EINA_TRUE to make items selectable,
8553 * @c EINA_FALSE otherwise
8555 * This will make items in @p obj selectable or not. In the latter
8556 * case, any user interaction on the gengrid items will neither make
8557 * them appear selected nor them call their selection callback
8560 * @see elm_gengrid_no_select_mode_get()
8564 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8567 * Get whether items on a given gengrid widget can be selected or
8570 * @param obj The gengrid object
8571 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8574 * @see elm_gengrid_no_select_mode_set() for more details
8578 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8581 * Enable or disable multi-selection in a given gengrid widget
8583 * @param obj The gengrid object.
8584 * @param multi @c EINA_TRUE, to enable multi-selection,
8585 * @c EINA_FALSE to disable it.
8587 * Multi-selection is the ability to have @b more than one
8588 * item selected, on a given gengrid, simultaneously. When it is
8589 * enabled, a sequence of clicks on different items will make them
8590 * all selected, progressively. A click on an already selected item
8591 * will unselect it. If interacting via the keyboard,
8592 * multi-selection is enabled while holding the "Shift" key.
8594 * @note By default, multi-selection is @b disabled on gengrids
8596 * @see elm_gengrid_multi_select_get()
8600 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8603 * Get whether multi-selection is enabled or disabled for a given
8606 * @param obj The gengrid object.
8607 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8608 * EINA_FALSE otherwise
8610 * @see elm_gengrid_multi_select_set() for more details
8614 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8617 * Enable or disable bouncing effect for a given gengrid widget
8619 * @param obj The gengrid object
8620 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8621 * @c EINA_FALSE to disable it
8622 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8623 * @c EINA_FALSE to disable it
8625 * The bouncing effect occurs whenever one reaches the gengrid's
8626 * edge's while panning it -- it will scroll past its limits a
8627 * little bit and return to the edge again, in a animated for,
8630 * @note By default, gengrids have bouncing enabled on both axis
8632 * @see elm_gengrid_bounce_get()
8636 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8639 * Get whether bouncing effects are enabled or disabled, for a
8640 * given gengrid widget, on each axis
8642 * @param obj The gengrid object
8643 * @param h_bounce Pointer to a variable where to store the
8644 * horizontal bouncing flag.
8645 * @param v_bounce Pointer to a variable where to store the
8646 * vertical bouncing flag.
8648 * @see elm_gengrid_bounce_set() for more details
8652 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8655 * Set a given gengrid widget's scrolling page size, relative to
8656 * its viewport size.
8658 * @param obj The gengrid object
8659 * @param h_pagerel The horizontal page (relative) size
8660 * @param v_pagerel The vertical page (relative) size
8662 * The gengrid's scroller is capable of binding scrolling by the
8663 * user to "pages". It means that, while scrolling and, specially
8664 * after releasing the mouse button, the grid will @b snap to the
8665 * nearest displaying page's area. When page sizes are set, the
8666 * grid's continuous content area is split into (equal) page sized
8669 * This function sets the size of a page <b>relatively to the
8670 * viewport dimensions</b> of the gengrid, for each axis. A value
8671 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8672 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8673 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8674 * 1.0. Values beyond those will make it behave behave
8675 * inconsistently. If you only want one axis to snap to pages, use
8676 * the value @c 0.0 for the other one.
8678 * There is a function setting page size values in @b absolute
8679 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8680 * is mutually exclusive to this one.
8682 * @see elm_gengrid_page_relative_get()
8686 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8689 * Get a given gengrid widget's scrolling page size, relative to
8690 * its viewport size.
8692 * @param obj The gengrid object
8693 * @param h_pagerel Pointer to a variable where to store the
8694 * horizontal page (relative) size
8695 * @param v_pagerel Pointer to a variable where to store the
8696 * vertical page (relative) size
8698 * @see elm_gengrid_page_relative_set() for more details
8702 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8705 * Set a given gengrid widget's scrolling page size
8707 * @param obj The gengrid object
8708 * @param h_pagerel The horizontal page size, in pixels
8709 * @param v_pagerel The vertical page size, in pixels
8711 * The gengrid's scroller is capable of binding scrolling by the
8712 * user to "pages". It means that, while scrolling and, specially
8713 * after releasing the mouse button, the grid will @b snap to the
8714 * nearest displaying page's area. When page sizes are set, the
8715 * grid's continuous content area is split into (equal) page sized
8718 * This function sets the size of a page of the gengrid, in pixels,
8719 * for each axis. Sane usable values are, between @c 0 and the
8720 * dimensions of @p obj, for each axis. Values beyond those will
8721 * make it behave behave inconsistently. If you only want one axis
8722 * to snap to pages, use the value @c 0 for the other one.
8724 * There is a function setting page size values in @b relative
8725 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8726 * use is mutually exclusive to this one.
8730 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8733 * Set the direction in which a given gengrid widget will expand while
8734 * placing its items.
8736 * @param obj The gengrid object.
8737 * @param setting @c EINA_TRUE to make the gengrid expand
8738 * horizontally, @c EINA_FALSE to expand vertically.
8740 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8741 * in @b columns, from top to bottom and, when the space for a
8742 * column is filled, another one is started on the right, thus
8743 * expanding the grid horizontally. When in "vertical mode"
8744 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8745 * to right and, when the space for a row is filled, another one is
8746 * started below, thus expanding the grid vertically.
8748 * @see elm_gengrid_horizontal_get()
8752 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8755 * Get for what direction a given gengrid widget will expand while
8756 * placing its items.
8758 * @param obj The gengrid object.
8759 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8760 * @c EINA_FALSE if it's set to expand vertically.
8762 * @see elm_gengrid_horizontal_set() for more detais
8766 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8769 * Get the first item in a given gengrid widget
8771 * @param obj The gengrid object
8772 * @return The first item's handle or @c NULL, if there are no
8773 * items in @p obj (and on errors)
8775 * This returns the first item in the @p obj's internal list of
8778 * @see elm_gengrid_last_item_get()
8782 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8785 * Get the last item in a given gengrid widget
8787 * @param obj The gengrid object
8788 * @return The last item's handle or @c NULL, if there are no
8789 * items in @p obj (and on errors)
8791 * This returns the last item in the @p obj's internal list of
8794 * @see elm_gengrid_first_item_get()
8798 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8801 * Get the @b next item in a gengrid widget's internal list of items,
8802 * given a handle to one of those items.
8804 * @param item The gengrid item to fetch next from
8805 * @return The item after @p item, or @c NULL if there's none (and
8808 * This returns the item placed after the @p item, on the container
8811 * @see elm_gengrid_item_prev_get()
8815 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8818 * Get the @b previous item in a gengrid widget's internal list of items,
8819 * given a handle to one of those items.
8821 * @param item The gengrid item to fetch previous from
8822 * @return The item before @p item, or @c NULL if there's none (and
8825 * This returns the item placed before the @p item, on the container
8828 * @see elm_gengrid_item_next_get()
8832 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8835 * Get the gengrid object's handle which contains a given gengrid
8838 * @param item The item to fetch the container from
8839 * @return The gengrid (parent) object
8841 * This returns the gengrid object itself that an item belongs to.
8845 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8848 * Remove a gengrid item from its parent, deleting it.
8850 * @param item The item to be removed.
8851 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8853 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8858 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8861 * Update the contents of a given gengrid item
8863 * @param item The gengrid item
8865 * This updates an item by calling all the item class functions
8866 * again to get the contents, labels and states. Use this when the
8867 * original item data has changed and you want the changes to be
8872 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8875 * Get the Gengrid Item class for the given Gengrid Item.
8877 * @param item The gengrid item
8879 * This returns the Gengrid_Item_Class for the given item. It can be used to examine
8880 * the function pointers and item_style.
8884 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8887 * Get the Gengrid Item class for the given Gengrid Item.
8889 * This sets the Gengrid_Item_Class for the given item. It can be used to examine
8890 * the function pointers and item_style.
8892 * @param item The gengrid item
8893 * @param gic The gengrid item class describing the function pointers and the item style.
8897 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8900 * Return the data associated to a given gengrid item
8902 * @param item The gengrid item.
8903 * @return the data associated with this item.
8905 * This returns the @c data value passed on the
8906 * elm_gengrid_item_append() and related item addition calls.
8908 * @see elm_gengrid_item_append()
8909 * @see elm_gengrid_item_data_set()
8913 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8916 * Set the data associated with a given gengrid item
8918 * @param item The gengrid item
8919 * @param data The data pointer to set on it
8921 * This @b overrides the @c data value passed on the
8922 * elm_gengrid_item_append() and related item addition calls. This
8923 * function @b won't call elm_gengrid_item_update() automatically,
8924 * so you'd issue it afterwards if you want to have the item
8925 * updated to reflect the new data.
8927 * @see elm_gengrid_item_data_get()
8928 * @see elm_gengrid_item_update()
8932 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8935 * Get a given gengrid item's position, relative to the whole
8936 * gengrid's grid area.
8938 * @param item The Gengrid item.
8939 * @param x Pointer to variable to store the item's <b>row number</b>.
8940 * @param y Pointer to variable to store the item's <b>column number</b>.
8942 * This returns the "logical" position of the item within the
8943 * gengrid. For example, @c (0, 1) would stand for first row,
8948 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8951 * Set whether a given gengrid item is selected or not
8953 * @param item The gengrid item
8954 * @param selected Use @c EINA_TRUE, to make it selected, @c
8955 * EINA_FALSE to make it unselected
8957 * This sets the selected state of an item. If multi-selection is
8958 * not enabled on the containing gengrid and @p selected is @c
8959 * EINA_TRUE, any other previously selected items will get
8960 * unselected in favor of this new one.
8962 * @see elm_gengrid_item_selected_get()
8966 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8969 * Get whether a given gengrid item is selected or not
8971 * @param item The gengrid item
8972 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8974 * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
8976 * @see elm_gengrid_item_selected_set() for more details
8980 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8983 * Get the real Evas object created to implement the view of a
8984 * given gengrid item
8986 * @param item The gengrid item.
8987 * @return the Evas object implementing this item's view.
8989 * This returns the actual Evas object used to implement the
8990 * specified gengrid item's view. This may be @c NULL, as it may
8991 * not have been created or may have been deleted, at any time, by
8992 * the gengrid. <b>Do not modify this object</b> (move, resize,
8993 * show, hide, etc.), as the gengrid is controlling it. This
8994 * function is for querying, emitting custom signals or hooking
8995 * lower level callbacks for events on that object. Do not delete
8996 * this object under any circumstances.
8998 * @see elm_gengrid_item_data_get()
9002 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9005 * Show the portion of a gengrid's internal grid containing a given
9006 * item, @b immediately.
9008 * @param item The item to display
9010 * This causes gengrid to @b redraw its viewport's contents to the
9011 * region contining the given @p item item, if it is not fully
9014 * @see elm_gengrid_item_bring_in()
9018 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9021 * Animatedly bring in, to the visible area of a gengrid, a given
9024 * @param item The gengrid item to display
9026 * This causes gengrid to jump to the given @p item and show
9027 * it (by scrolling), if it is not fully visible. This will use
9028 * animation to do so and take a period of time to complete.
9030 * @see elm_gengrid_item_show()
9034 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9037 * Set whether a given gengrid item is disabled or not.
9039 * @param item The gengrid item
9040 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9041 * to enable it back.
9043 * A disabled item cannot be selected or unselected. It will also
9044 * change its appearance, to signal the user it's disabled.
9046 * @see elm_gengrid_item_disabled_get()
9050 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9053 * Get whether a given gengrid item is disabled or not.
9055 * @param item The gengrid item
9056 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9059 * @see elm_gengrid_item_disabled_set() for more details
9063 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9066 * Set the text to be shown in a given gengrid item's tooltips.
9068 * @param item The gengrid item
9069 * @param text The text to set in the content
9071 * This call will setup the text to be used as tooltip to that item
9072 * (analogous to elm_object_tooltip_text_set(), but being item
9073 * tooltips with higher precedence than object tooltips). It can
9074 * have only one tooltip at a time, so any previous tooltip data
9079 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9082 * Set the content to be shown in a given gengrid item's tooltip
9084 * @param item The gengrid item.
9085 * @param func The function returning the tooltip contents.
9086 * @param data What to provide to @a func as callback data/context.
9087 * @param del_cb Called when data is not needed anymore, either when
9088 * another callback replaces @p func, the tooltip is unset with
9089 * elm_gengrid_item_tooltip_unset() or the owner @p item
9090 * dies. This callback receives as its first parameter the
9091 * given @p data, being @c event_info the item handle.
9093 * This call will setup the tooltip's contents to @p item
9094 * (analogous to elm_object_tooltip_content_cb_set(), but being
9095 * item tooltips with higher precedence than object tooltips). It
9096 * can have only one tooltip at a time, so any previous tooltip
9097 * content will get removed. @p func (with @p data) will be called
9098 * every time Elementary needs to show the tooltip and it should
9099 * return a valid Evas object, which will be fully managed by the
9100 * tooltip system, getting deleted when the tooltip is gone.
9104 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);
9107 * Unset a tooltip from a given gengrid item
9109 * @param item gengrid item to remove a previously set tooltip from.
9111 * This call removes any tooltip set on @p item. The callback
9112 * provided as @c del_cb to
9113 * elm_gengrid_item_tooltip_content_cb_set() will be called to
9114 * notify it is not used anymore (and have resources cleaned, if
9117 * @see elm_gengrid_item_tooltip_content_cb_set()
9121 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9124 * Set a different @b style for a given gengrid item's tooltip.
9126 * @param item gengrid item with tooltip set
9127 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9128 * "default", @c "transparent", etc)
9130 * Tooltips can have <b>alternate styles</b> to be displayed on,
9131 * which are defined by the theme set on Elementary. This function
9132 * works analogously as elm_object_tooltip_style_set(), but here
9133 * applied only to gengrid item objects. The default style for
9134 * tooltips is @c "default".
9136 * @note before you set a style you should define a tooltip with
9137 * elm_gengrid_item_tooltip_content_cb_set() or
9138 * elm_gengrid_item_tooltip_text_set()
9140 * @see elm_gengrid_item_tooltip_style_get()
9144 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9147 * Get the style set a given gengrid item's tooltip.
9149 * @param item gengrid item with tooltip already set on.
9150 * @return style the theme style in use, which defaults to
9151 * "default". If the object does not have a tooltip set,
9152 * then @c NULL is returned.
9154 * @see elm_gengrid_item_tooltip_style_set() for more details
9158 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9160 * Set the type of mouse pointer/cursor decoration to be shown,
9161 * when the mouse pointer is over the given gengrid widget item
9163 * @param item gengrid item to customize cursor on
9164 * @param cursor the cursor type's name
9166 * This function works analogously as elm_object_cursor_set(), but
9167 * here the cursor's changing area is restricted to the item's
9168 * area, and not the whole widget's. Note that that item cursors
9169 * have precedence over widget cursors, so that a mouse over @p
9170 * item will always show cursor @p type.
9172 * If this function is called twice for an object, a previously set
9173 * cursor will be unset on the second call.
9175 * @see elm_object_cursor_set()
9176 * @see elm_gengrid_item_cursor_get()
9177 * @see elm_gengrid_item_cursor_unset()
9181 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9184 * Get the type of mouse pointer/cursor decoration set to be shown,
9185 * when the mouse pointer is over the given gengrid widget item
9187 * @param item gengrid item with custom cursor set
9188 * @return the cursor type's name or @c NULL, if no custom cursors
9189 * were set to @p item (and on errors)
9191 * @see elm_object_cursor_get()
9192 * @see elm_gengrid_item_cursor_set() for more details
9193 * @see elm_gengrid_item_cursor_unset()
9197 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9200 * Unset any custom mouse pointer/cursor decoration set to be
9201 * shown, when the mouse pointer is over the given gengrid widget
9202 * item, thus making it show the @b default cursor again.
9204 * @param item a gengrid item
9206 * Use this call to undo any custom settings on this item's cursor
9207 * decoration, bringing it back to defaults (no custom style set).
9209 * @see elm_object_cursor_unset()
9210 * @see elm_gengrid_item_cursor_set() for more details
9214 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9217 * Set a different @b style for a given custom cursor set for a
9220 * @param item gengrid item with custom cursor set
9221 * @param style the <b>theme style</b> to use (e.g. @c "default",
9222 * @c "transparent", etc)
9224 * This function only makes sense when one is using custom mouse
9225 * cursor decorations <b>defined in a theme file</b> , which can
9226 * have, given a cursor name/type, <b>alternate styles</b> on
9227 * it. It works analogously as elm_object_cursor_style_set(), but
9228 * here applied only to gengrid item objects.
9230 * @warning Before you set a cursor style you should have defined a
9231 * custom cursor previously on the item, with
9232 * elm_gengrid_item_cursor_set()
9234 * @see elm_gengrid_item_cursor_engine_only_set()
9235 * @see elm_gengrid_item_cursor_style_get()
9239 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9242 * Get the current @b style set for a given gengrid item's custom
9245 * @param item gengrid item with custom cursor set.
9246 * @return style the cursor style in use. If the object does not
9247 * have a cursor set, then @c NULL is returned.
9249 * @see elm_gengrid_item_cursor_style_set() for more details
9253 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9256 * Set if the (custom) cursor for a given gengrid item should be
9257 * searched in its theme, also, or should only rely on the
9260 * @param item item with custom (custom) cursor already set on
9261 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9262 * only on those provided by the rendering engine, @c EINA_FALSE to
9263 * have them searched on the widget's theme, as well.
9265 * @note This call is of use only if you've set a custom cursor
9266 * for gengrid items, with elm_gengrid_item_cursor_set().
9268 * @note By default, cursors will only be looked for between those
9269 * provided by the rendering engine.
9273 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9276 * Get if the (custom) cursor for a given gengrid item is being
9277 * searched in its theme, also, or is only relying on the rendering
9280 * @param item a gengrid item
9281 * @return @c EINA_TRUE, if cursors are being looked for only on
9282 * those provided by the rendering engine, @c EINA_FALSE if they
9283 * are being searched on the widget's theme, as well.
9285 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9289 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9292 * Remove all items from a given gengrid widget
9294 * @param obj The gengrid object.
9296 * This removes (and deletes) all items in @p obj, leaving it
9299 * @see elm_gengrid_item_del(), to remove just one item.
9303 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9306 * Get the selected item in a given gengrid widget
9308 * @param obj The gengrid object.
9309 * @return The selected item's handleor @c NULL, if none is
9310 * selected at the moment (and on errors)
9312 * This returns the selected item in @p obj. If multi selection is
9313 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9314 * the first item in the list is selected, which might not be very
9315 * useful. For that case, see elm_gengrid_selected_items_get().
9319 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9322 * Get <b>a list</b> of selected items in a given gengrid
9324 * @param obj The gengrid object.
9325 * @return The list of selected items or @c NULL, if none is
9326 * selected at the moment (and on errors)
9328 * This returns a list of the selected items, in the order that
9329 * they appear in the grid. This list is only valid as long as no
9330 * more items are selected or unselected (or unselected implictly
9331 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9334 * @see elm_gengrid_selected_item_get()
9338 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9345 * @defgroup Clock Clock
9347 * @image html img/widget/clock/preview-00.png
9348 * @image latex img/widget/clock/preview-00.eps
9350 * This is a @b digital clock widget. In its default theme, it has a
9351 * vintage "flipping numbers clock" appearance, which will animate
9352 * sheets of individual algarisms individually as time goes by.
9354 * A newly created clock will fetch system's time (already
9355 * considering local time adjustments) to start with, and will tick
9356 * accondingly. It may or may not show seconds.
9358 * Clocks have an @b edition mode. When in it, the sheets will
9359 * display extra arrow indications on the top and bottom and the
9360 * user may click on them to raise or lower the time values. After
9361 * it's told to exit edition mode, it will keep ticking with that
9362 * new time set (it keeps the difference from local time).
9364 * Also, when under edition mode, user clicks on the cited arrows
9365 * which are @b held for some time will make the clock to flip the
9366 * sheet, thus editing the time, continuosly and automatically for
9367 * the user. The interval between sheet flips will keep growing in
9368 * time, so that it helps the user to reach a time which is distant
9371 * The time display is, by default, in military mode (24h), but an
9372 * am/pm indicator may be optionally shown, too, when it will
9375 * Smart callbacks one can register to:
9376 * - "changed" - the clock's user changed the time
9378 * Here is an example on its usage:
9379 * @li @ref clock_example
9388 * Identifiers for which clock digits should be editable, when a
9389 * clock widget is in edition mode. Values may be ORed together to
9390 * make a mask, naturally.
9392 * @see elm_clock_edit_set()
9393 * @see elm_clock_digit_edit_set()
9395 typedef enum _Elm_Clock_Digedit
9397 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9398 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9399 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9400 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9401 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9402 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9403 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9404 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9405 } Elm_Clock_Digedit;
9408 * Add a new clock widget to the given parent Elementary
9409 * (container) object
9411 * @param parent The parent object
9412 * @return a new clock widget handle or @c NULL, on errors
9414 * This function inserts a new clock widget on the canvas.
9418 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9421 * Set a clock widget's time, programmatically
9423 * @param obj The clock widget object
9424 * @param hrs The hours to set
9425 * @param min The minutes to set
9426 * @param sec The secondes to set
9428 * This function updates the time that is showed by the clock
9431 * Values @b must be set within the following ranges:
9432 * - 0 - 23, for hours
9433 * - 0 - 59, for minutes
9434 * - 0 - 59, for seconds,
9436 * even if the clock is not in "military" mode.
9438 * @warning The behavior for values set out of those ranges is @b
9443 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9446 * Get a clock widget's time values
9448 * @param obj The clock object
9449 * @param[out] hrs Pointer to the variable to get the hours value
9450 * @param[out] min Pointer to the variable to get the minutes value
9451 * @param[out] sec Pointer to the variable to get the seconds value
9453 * This function gets the time set for @p obj, returning
9454 * it on the variables passed as the arguments to function
9456 * @note Use @c NULL pointers on the time values you're not
9457 * interested in: they'll be ignored by the function.
9461 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9464 * Set whether a given clock widget is under <b>edition mode</b> or
9465 * under (default) displaying-only mode.
9467 * @param obj The clock object
9468 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9469 * put it back to "displaying only" mode
9471 * This function makes a clock's time to be editable or not <b>by
9472 * user interaction</b>. When in edition mode, clocks @b stop
9473 * ticking, until one brings them back to canonical mode. The
9474 * elm_clock_digit_edit_set() function will influence which digits
9475 * of the clock will be editable. By default, all of them will be
9476 * (#ELM_CLOCK_NONE).
9478 * @note am/pm sheets, if being shown, will @b always be editable
9479 * under edition mode.
9481 * @see elm_clock_edit_get()
9485 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9488 * Retrieve whether a given clock widget is under <b>edition
9489 * mode</b> or under (default) displaying-only mode.
9491 * @param obj The clock object
9492 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9495 * This function retrieves whether the clock's time can be edited
9496 * or not by user interaction.
9498 * @see elm_clock_edit_set() for more details
9502 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9505 * Set what digits of the given clock widget should be editable
9506 * when in edition mode.
9508 * @param obj The clock object
9509 * @param digedit Bit mask indicating the digits to be editable
9510 * (values in #Elm_Clock_Digedit).
9512 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9513 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9516 * @see elm_clock_digit_edit_get()
9520 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9523 * Retrieve what digits of the given clock widget should be
9524 * editable when in edition mode.
9526 * @param obj The clock object
9527 * @return Bit mask indicating the digits to be editable
9528 * (values in #Elm_Clock_Digedit).
9530 * @see elm_clock_digit_edit_set() for more details
9534 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9537 * Set if the given clock widget must show hours in military or
9540 * @param obj The clock object
9541 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9544 * This function sets if the clock must show hours in military or
9545 * am/pm mode. In some countries like Brazil the military mode
9546 * (00-24h-format) is used, in opposition to the USA, where the
9547 * am/pm mode is more commonly used.
9549 * @see elm_clock_show_am_pm_get()
9553 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9556 * Get if the given clock widget shows hours in military or am/pm
9559 * @param obj The clock object
9560 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9563 * This function gets if the clock shows hours in military or am/pm
9566 * @see elm_clock_show_am_pm_set() for more details
9570 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9573 * Set if the given clock widget must show time with seconds or not
9575 * @param obj The clock object
9576 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9578 * This function sets if the given clock must show or not elapsed
9579 * seconds. By default, they are @b not shown.
9581 * @see elm_clock_show_seconds_get()
9585 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9588 * Get whether the given clock widget is showing time with seconds
9591 * @param obj The clock object
9592 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9594 * This function gets whether @p obj is showing or not the elapsed
9597 * @see elm_clock_show_seconds_set()
9601 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9604 * Set the interval on time updates for an user mouse button hold
9605 * on clock widgets' time edition.
9607 * @param obj The clock object
9608 * @param interval The (first) interval value in seconds
9610 * This interval value is @b decreased while the user holds the
9611 * mouse pointer either incrementing or decrementing a given the
9612 * clock digit's value.
9614 * This helps the user to get to a given time distant from the
9615 * current one easier/faster, as it will start to flip quicker and
9616 * quicker on mouse button holds.
9618 * The calculation for the next flip interval value, starting from
9619 * the one set with this call, is the previous interval divided by
9620 * 1.05, so it decreases a little bit.
9622 * The default starting interval value for automatic flips is
9625 * @see elm_clock_interval_get()
9629 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9632 * Get the interval on time updates for an user mouse button hold
9633 * on clock widgets' time edition.
9635 * @param obj The clock object
9636 * @return The (first) interval value, in seconds, set on it
9638 * @see elm_clock_interval_set() for more details
9642 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9649 * @defgroup Layout Layout
9651 * @image html img/widget/layout/preview-00.png
9652 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9654 * @image html img/layout-predefined.png
9655 * @image latex img/layout-predefined.eps width=\textwidth
9657 * This is a container widget that takes a standard Edje design file and
9658 * wraps it very thinly in a widget.
9660 * An Edje design (theme) file has a very wide range of possibilities to
9661 * describe the behavior of elements added to the Layout. Check out the Edje
9662 * documentation and the EDC reference to get more information about what can
9663 * be done with Edje.
9665 * Just like @ref List, @ref Box, and other container widgets, any
9666 * object added to the Layout will become its child, meaning that it will be
9667 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9669 * The Layout widget can contain as many Contents, Boxes or Tables as
9670 * described in its theme file. For instance, objects can be added to
9671 * different Tables by specifying the respective Table part names. The same
9672 * is valid for Content and Box.
9674 * The objects added as child of the Layout will behave as described in the
9675 * part description where they were added. There are 3 possible types of
9676 * parts where a child can be added:
9678 * @section secContent Content (SWALLOW part)
9680 * Only one object can be added to the @c SWALLOW part (but you still can
9681 * have many @c SWALLOW parts and one object on each of them). Use the @c
9682 * elm_object_content_set/get/unset functions to set, retrieve and unset
9683 * objects as content of the @c SWALLOW. After being set to this part, the
9684 * object size, position, visibility, clipping and other description
9685 * properties will be totally controled by the description of the given part
9686 * (inside the Edje theme file).
9688 * One can use @c evas_object_size_hint_* functions on the child to have some
9689 * kind of control over its behavior, but the resulting behavior will still
9690 * depend heavily on the @c SWALLOW part description.
9692 * The Edje theme also can change the part description, based on signals or
9693 * scripts running inside the theme. This change can also be animated. All of
9694 * this will affect the child object set as content accordingly. The object
9695 * size will be changed if the part size is changed, it will animate move if
9696 * the part is moving, and so on.
9698 * The following picture demonstrates a Layout widget with a child object
9699 * added to its @c SWALLOW:
9701 * @image html layout_swallow.png
9702 * @image latex layout_swallow.eps width=\textwidth
9704 * @section secBox Box (BOX part)
9706 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9707 * allows one to add objects to the box and have them distributed along its
9708 * area, accordingly to the specified @a layout property (now by @a layout we
9709 * mean the chosen layouting design of the Box, not the Layout widget
9712 * A similar effect for having a box with its position, size and other things
9713 * controled by the Layout theme would be to create an Elementary @ref Box
9714 * widget and add it as a Content in the @c SWALLOW part.
9716 * The main difference of using the Layout Box is that its behavior, the box
9717 * properties like layouting format, padding, align, etc. will be all
9718 * controled by the theme. This means, for example, that a signal could be
9719 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9720 * handled the signal by changing the box padding, or align, or both. Using
9721 * the Elementary @ref Box widget is not necessarily harder or easier, it
9722 * just depends on the circunstances and requirements.
9724 * The Layout Box can be used through the @c elm_layout_box_* set of
9727 * The following picture demonstrates a Layout widget with many child objects
9728 * added to its @c BOX part:
9730 * @image html layout_box.png
9731 * @image latex layout_box.eps width=\textwidth
9733 * @section secTable Table (TABLE part)
9735 * Just like the @ref secBox, the Layout Table is very similar to the
9736 * Elementary @ref Table widget. It allows one to add objects to the Table
9737 * specifying the row and column where the object should be added, and any
9738 * column or row span if necessary.
9740 * Again, we could have this design by adding a @ref Table widget to the @c
9741 * SWALLOW part using elm_object_part_content_set(). The same difference happens
9742 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9743 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9745 * The Layout Table can be used through the @c elm_layout_table_* set of
9748 * The following picture demonstrates a Layout widget with many child objects
9749 * added to its @c TABLE part:
9751 * @image html layout_table.png
9752 * @image latex layout_table.eps width=\textwidth
9754 * @section secPredef Predefined Layouts
9756 * Another interesting thing about the Layout widget is that it offers some
9757 * predefined themes that come with the default Elementary theme. These
9758 * themes can be set by the call elm_layout_theme_set(), and provide some
9759 * basic functionality depending on the theme used.
9761 * Most of them already send some signals, some already provide a toolbar or
9762 * back and next buttons.
9764 * These are available predefined theme layouts. All of them have class = @c
9765 * layout, group = @c application, and style = one of the following options:
9767 * @li @c toolbar-content - application with toolbar and main content area
9768 * @li @c toolbar-content-back - application with toolbar and main content
9769 * area with a back button and title area
9770 * @li @c toolbar-content-back-next - application with toolbar and main
9771 * content area with a back and next buttons and title area
9772 * @li @c content-back - application with a main content area with a back
9773 * button and title area
9774 * @li @c content-back-next - application with a main content area with a
9775 * back and next buttons and title area
9776 * @li @c toolbar-vbox - application with toolbar and main content area as a
9778 * @li @c toolbar-table - application with toolbar and main content area as a
9781 * @section secExamples Examples
9783 * Some examples of the Layout widget can be found here:
9784 * @li @ref layout_example_01
9785 * @li @ref layout_example_02
9786 * @li @ref layout_example_03
9787 * @li @ref layout_example_edc
9792 * Add a new layout to the parent
9794 * @param parent The parent object
9795 * @return The new object or NULL if it cannot be created
9797 * @see elm_layout_file_set()
9798 * @see elm_layout_theme_set()
9802 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9804 * Set the file that will be used as layout
9806 * @param obj The layout object
9807 * @param file The path to file (edj) that will be used as layout
9808 * @param group The group that the layout belongs in edje file
9810 * @return (1 = success, 0 = error)
9814 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9816 * Set the edje group from the elementary theme that will be used as layout
9818 * @param obj The layout object
9819 * @param clas the clas of the group
9820 * @param group the group
9821 * @param style the style to used
9823 * @return (1 = success, 0 = error)
9827 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9829 * Set the layout content.
9831 * @param obj The layout object
9832 * @param swallow The swallow part name in the edje file
9833 * @param content The child that will be added in this layout object
9835 * Once the content object is set, a previously set one will be deleted.
9836 * If you want to keep that old content object, use the
9837 * elm_object_part_content_unset() function.
9839 * @note In an Edje theme, the part used as a content container is called @c
9840 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9841 * expected to be a part name just like the second parameter of
9842 * elm_layout_box_append().
9844 * @see elm_layout_box_append()
9845 * @see elm_object_part_content_get()
9846 * @see elm_object_part_content_unset()
9848 * @deprecated use elm_object_part_content_set() instead
9852 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9854 * Get the child object in the given content part.
9856 * @param obj The layout object
9857 * @param swallow The SWALLOW part to get its content
9859 * @return The swallowed object or NULL if none or an error occurred
9861 * @deprecated use elm_object_part_content_get() instead
9865 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9867 * Unset the layout content.
9869 * @param obj The layout object
9870 * @param swallow The swallow part name in the edje file
9871 * @return The content that was being used
9873 * Unparent and return the content object which was set for this part.
9875 * @deprecated use elm_object_part_content_unset() instead
9879 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9881 * Set the text of the given part
9883 * @param obj The layout object
9884 * @param part The TEXT part where to set the text
9885 * @param text The text to set
9888 * @deprecated use elm_object_part_text_set() instead.
9890 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9892 * Get the text set in the given part
9894 * @param obj The layout object
9895 * @param part The TEXT part to retrieve the text off
9897 * @return The text set in @p part
9900 * @deprecated use elm_object_part_text_get() instead.
9902 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9904 * Append child to layout box part.
9906 * @param obj the layout object
9907 * @param part the box part to which the object will be appended.
9908 * @param child the child object to append to box.
9910 * Once the object is appended, it will become child of the layout. Its
9911 * lifetime will be bound to the layout, whenever the layout dies the child
9912 * will be deleted automatically. One should use elm_layout_box_remove() to
9913 * make this layout forget about the object.
9915 * @see elm_layout_box_prepend()
9916 * @see elm_layout_box_insert_before()
9917 * @see elm_layout_box_insert_at()
9918 * @see elm_layout_box_remove()
9922 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9924 * Prepend child to layout box part.
9926 * @param obj the layout object
9927 * @param part the box part to prepend.
9928 * @param child the child object to prepend to box.
9930 * Once the object is prepended, it will become child of the layout. Its
9931 * lifetime will be bound to the layout, whenever the layout dies the child
9932 * will be deleted automatically. One should use elm_layout_box_remove() to
9933 * make this layout forget about the object.
9935 * @see elm_layout_box_append()
9936 * @see elm_layout_box_insert_before()
9937 * @see elm_layout_box_insert_at()
9938 * @see elm_layout_box_remove()
9942 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9944 * Insert child to layout box part before a reference object.
9946 * @param obj the layout object
9947 * @param part the box part to insert.
9948 * @param child the child object to insert into box.
9949 * @param reference another reference object to insert before in box.
9951 * Once the object is inserted, it will become child of the layout. Its
9952 * lifetime will be bound to the layout, whenever the layout dies the child
9953 * will be deleted automatically. One should use elm_layout_box_remove() to
9954 * make this layout forget about the object.
9956 * @see elm_layout_box_append()
9957 * @see elm_layout_box_prepend()
9958 * @see elm_layout_box_insert_before()
9959 * @see elm_layout_box_remove()
9963 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9965 * Insert child to layout box part at a given position.
9967 * @param obj the layout object
9968 * @param part the box part to insert.
9969 * @param child the child object to insert into box.
9970 * @param pos the numeric position >=0 to insert the child.
9972 * Once the object is inserted, it will become child of the layout. Its
9973 * lifetime will be bound to the layout, whenever the layout dies the child
9974 * will be deleted automatically. One should use elm_layout_box_remove() to
9975 * make this layout forget about the object.
9977 * @see elm_layout_box_append()
9978 * @see elm_layout_box_prepend()
9979 * @see elm_layout_box_insert_before()
9980 * @see elm_layout_box_remove()
9984 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9986 * Remove a child of the given part box.
9988 * @param obj The layout object
9989 * @param part The box part name to remove child.
9990 * @param child The object to remove from box.
9991 * @return The object that was being used, or NULL if not found.
9993 * The object will be removed from the box part and its lifetime will
9994 * not be handled by the layout anymore. This is equivalent to
9995 * elm_object_part_content_unset() for box.
9997 * @see elm_layout_box_append()
9998 * @see elm_layout_box_remove_all()
10002 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10004 * Remove all child of the given part box.
10006 * @param obj The layout object
10007 * @param part The box part name to remove child.
10008 * @param clear If EINA_TRUE, then all objects will be deleted as
10009 * well, otherwise they will just be removed and will be
10010 * dangling on the canvas.
10012 * The objects will be removed from the box part and their lifetime will
10013 * not be handled by the layout anymore. This is equivalent to
10014 * elm_layout_box_remove() for all box children.
10016 * @see elm_layout_box_append()
10017 * @see elm_layout_box_remove()
10021 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10023 * Insert child to layout table part.
10025 * @param obj the layout object
10026 * @param part the box part to pack child.
10027 * @param child_obj the child object to pack into table.
10028 * @param col the column to which the child should be added. (>= 0)
10029 * @param row the row to which the child should be added. (>= 0)
10030 * @param colspan how many columns should be used to store this object. (>=
10032 * @param rowspan how many rows should be used to store this object. (>= 1)
10034 * Once the object is inserted, it will become child of the table. Its
10035 * lifetime will be bound to the layout, and whenever the layout dies the
10036 * child will be deleted automatically. One should use
10037 * elm_layout_table_remove() to make this layout forget about the object.
10039 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10040 * more space than a single cell. For instance, the following code:
10042 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10045 * Would result in an object being added like the following picture:
10047 * @image html layout_colspan.png
10048 * @image latex layout_colspan.eps width=\textwidth
10050 * @see elm_layout_table_unpack()
10051 * @see elm_layout_table_clear()
10055 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);
10057 * Unpack (remove) a child of the given part table.
10059 * @param obj The layout object
10060 * @param part The table part name to remove child.
10061 * @param child_obj The object to remove from table.
10062 * @return The object that was being used, or NULL if not found.
10064 * The object will be unpacked from the table part and its lifetime
10065 * will not be handled by the layout anymore. This is equivalent to
10066 * elm_object_part_content_unset() for table.
10068 * @see elm_layout_table_pack()
10069 * @see elm_layout_table_clear()
10073 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10075 * Remove all child of the given part table.
10077 * @param obj The layout object
10078 * @param part The table part name to remove child.
10079 * @param clear If EINA_TRUE, then all objects will be deleted as
10080 * well, otherwise they will just be removed and will be
10081 * dangling on the canvas.
10083 * The objects will be removed from the table part and their lifetime will
10084 * not be handled by the layout anymore. This is equivalent to
10085 * elm_layout_table_unpack() for all table children.
10087 * @see elm_layout_table_pack()
10088 * @see elm_layout_table_unpack()
10092 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10094 * Get the edje layout
10096 * @param obj The layout object
10098 * @return A Evas_Object with the edje layout settings loaded
10099 * with function elm_layout_file_set
10101 * This returns the edje object. It is not expected to be used to then
10102 * swallow objects via edje_object_part_swallow() for example. Use
10103 * elm_object_part_content_set() instead so child object handling and sizing is
10106 * @note This function should only be used if you really need to call some
10107 * low level Edje function on this edje object. All the common stuff (setting
10108 * text, emitting signals, hooking callbacks to signals, etc.) can be done
10109 * with proper elementary functions.
10111 * @see elm_object_signal_callback_add()
10112 * @see elm_object_signal_emit()
10113 * @see elm_object_part_text_set()
10114 * @see elm_object_part_content_set()
10115 * @see elm_layout_box_append()
10116 * @see elm_layout_table_pack()
10117 * @see elm_layout_data_get()
10121 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10123 * Get the edje data from the given layout
10125 * @param obj The layout object
10126 * @param key The data key
10128 * @return The edje data string
10130 * This function fetches data specified inside the edje theme of this layout.
10131 * This function return NULL if data is not found.
10133 * In EDC this comes from a data block within the group block that @p
10134 * obj was loaded from. E.g.
10141 * item: "key1" "value1";
10142 * item: "key2" "value2";
10150 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10154 * @param obj The layout object
10156 * Manually forces a sizing re-evaluation. This is useful when the minimum
10157 * size required by the edje theme of this layout has changed. The change on
10158 * the minimum size required by the edje theme is not immediately reported to
10159 * the elementary layout, so one needs to call this function in order to tell
10160 * the widget (layout) that it needs to reevaluate its own size.
10162 * The minimum size of the theme is calculated based on minimum size of
10163 * parts, the size of elements inside containers like box and table, etc. All
10164 * of this can change due to state changes, and that's when this function
10165 * should be called.
10167 * Also note that a standard signal of "size,eval" "elm" emitted from the
10168 * edje object will cause this to happen too.
10172 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10175 * Sets a specific cursor for an edje part.
10177 * @param obj The layout object.
10178 * @param part_name a part from loaded edje group.
10179 * @param cursor cursor name to use, see Elementary_Cursor.h
10181 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10182 * part not exists or it has "mouse_events: 0".
10186 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10189 * Get the cursor to be shown when mouse is over an edje part
10191 * @param obj The layout object.
10192 * @param part_name a part from loaded edje group.
10193 * @return the cursor name.
10197 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10200 * Unsets a cursor previously set with elm_layout_part_cursor_set().
10202 * @param obj The layout object.
10203 * @param part_name a part from loaded edje group, that had a cursor set
10204 * with elm_layout_part_cursor_set().
10208 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10211 * Sets a specific cursor style for an edje part.
10213 * @param obj The layout object.
10214 * @param part_name a part from loaded edje group.
10215 * @param style the theme style to use (default, transparent, ...)
10217 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10218 * part not exists or it did not had a cursor set.
10222 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10225 * Gets a specific cursor style for an edje part.
10227 * @param obj The layout object.
10228 * @param part_name a part from loaded edje group.
10230 * @return the theme style in use, defaults to "default". If the
10231 * object does not have a cursor set, then NULL is returned.
10235 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10238 * Sets if the cursor set should be searched on the theme or should use
10239 * the provided by the engine, only.
10241 * @note before you set if should look on theme you should define a
10242 * cursor with elm_layout_part_cursor_set(). By default it will only
10243 * look for cursors provided by the engine.
10245 * @param obj The layout object.
10246 * @param part_name a part from loaded edje group.
10247 * @param engine_only if cursors should be just provided by the engine
10248 * or should also search on widget's theme as well
10250 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10251 * part not exists or it did not had a cursor set.
10255 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);
10258 * Gets a specific cursor engine_only for an edje part.
10260 * @param obj The layout object.
10261 * @param part_name a part from loaded edje group.
10263 * @return whenever the cursor is just provided by engine or also from theme.
10267 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10270 * @def elm_layout_icon_set
10271 * Convienience macro to set the icon object in a layout that follows the
10272 * Elementary naming convention for its parts.
10276 #define elm_layout_icon_set(_ly, _obj) \
10279 elm_object_part_content_set((_ly), "elm.swallow.icon", (_obj)); \
10280 if ((_obj)) sig = "elm,state,icon,visible"; \
10281 else sig = "elm,state,icon,hidden"; \
10282 elm_object_signal_emit((_ly), sig, "elm"); \
10286 * @def elm_layout_icon_get
10287 * Convienience macro to get the icon object from a layout that follows the
10288 * Elementary naming convention for its parts.
10292 #define elm_layout_icon_get(_ly) \
10293 elm_object_part_content_get((_ly), "elm.swallow.icon")
10296 * @def elm_layout_end_set
10297 * Convienience macro to set the end object in a layout that follows the
10298 * Elementary naming convention for its parts.
10302 #define elm_layout_end_set(_ly, _obj) \
10305 elm_object_part_content_set((_ly), "elm.swallow.end", (_obj)); \
10306 if ((_obj)) sig = "elm,state,end,visible"; \
10307 else sig = "elm,state,end,hidden"; \
10308 elm_object_signal_emit((_ly), sig, "elm"); \
10312 * @def elm_layout_end_get
10313 * Convienience macro to get the end object in a layout that follows the
10314 * Elementary naming convention for its parts.
10318 #define elm_layout_end_get(_ly) \
10319 elm_object_part_content_get((_ly), "elm.swallow.end")
10322 * @def elm_layout_label_set
10323 * Convienience macro to set the label in a layout that follows the
10324 * Elementary naming convention for its parts.
10327 * @deprecated use elm_object_text_set() instead.
10329 #define elm_layout_label_set(_ly, _txt) \
10330 elm_layout_text_set((_ly), "elm.text", (_txt))
10333 * @def elm_layout_label_get
10334 * Convenience macro to get the label in a layout that follows the
10335 * Elementary naming convention for its parts.
10338 * @deprecated use elm_object_text_set() instead.
10340 #define elm_layout_label_get(_ly) \
10341 elm_layout_text_get((_ly), "elm.text")
10343 /* smart callbacks called:
10344 * "theme,changed" - when elm theme is changed.
10348 * @defgroup Notify Notify
10350 * @image html img/widget/notify/preview-00.png
10351 * @image latex img/widget/notify/preview-00.eps
10353 * Display a container in a particular region of the parent(top, bottom,
10354 * etc). A timeout can be set to automatically hide the notify. This is so
10355 * that, after an evas_object_show() on a notify object, if a timeout was set
10356 * on it, it will @b automatically get hidden after that time.
10358 * Signals that you can add callbacks for are:
10359 * @li "timeout" - when timeout happens on notify and it's hidden
10360 * @li "block,clicked" - when a click outside of the notify happens
10362 * Default contents parts of the notify widget that you can use for are:
10363 * @li "default" - A content of the notify
10365 * @ref tutorial_notify show usage of the API.
10370 * @brief Possible orient values for notify.
10372 * This values should be used in conjunction to elm_notify_orient_set() to
10373 * set the position in which the notify should appear(relative to its parent)
10374 * and in conjunction with elm_notify_orient_get() to know where the notify
10377 typedef enum _Elm_Notify_Orient
10379 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10380 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10381 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10382 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10383 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10384 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10385 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10386 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10387 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10388 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10389 } Elm_Notify_Orient;
10391 * @brief Add a new notify to the parent
10393 * @param parent The parent object
10394 * @return The new object or NULL if it cannot be created
10396 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10398 * @brief Set the content of the notify widget
10400 * @param obj The notify object
10401 * @param content The content will be filled in this notify object
10403 * Once the content object is set, a previously set one will be deleted. If
10404 * you want to keep that old content object, use the
10405 * elm_notify_content_unset() function.
10407 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10409 * @brief Unset the content of the notify widget
10411 * @param obj The notify object
10412 * @return The content that was being used
10414 * Unparent and return the content object which was set for this widget
10416 * @see elm_notify_content_set()
10418 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10420 * @brief Return the content of the notify widget
10422 * @param obj The notify object
10423 * @return The content that is being used
10425 * @see elm_notify_content_set()
10427 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10429 * @brief Set the notify parent
10431 * @param obj The notify object
10432 * @param content The new parent
10434 * Once the parent object is set, a previously set one will be disconnected
10437 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10439 * @brief Get the notify parent
10441 * @param obj The notify object
10442 * @return The parent
10444 * @see elm_notify_parent_set()
10446 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10448 * @brief Set the orientation
10450 * @param obj The notify object
10451 * @param orient The new orientation
10453 * Sets the position in which the notify will appear in its parent.
10455 * @see @ref Elm_Notify_Orient for possible values.
10457 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10459 * @brief Return the orientation
10460 * @param obj The notify object
10461 * @return The orientation of the notification
10463 * @see elm_notify_orient_set()
10464 * @see Elm_Notify_Orient
10466 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10468 * @brief Set the time interval after which the notify window is going to be
10471 * @param obj The notify object
10472 * @param time The timeout in seconds
10474 * This function sets a timeout and starts the timer controlling when the
10475 * notify is hidden. Since calling evas_object_show() on a notify restarts
10476 * the timer controlling when the notify is hidden, setting this before the
10477 * notify is shown will in effect mean starting the timer when the notify is
10480 * @note Set a value <= 0.0 to disable a running timer.
10482 * @note If the value > 0.0 and the notify is previously visible, the
10483 * timer will be started with this value, canceling any running timer.
10485 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10487 * @brief Return the timeout value (in seconds)
10488 * @param obj the notify object
10490 * @see elm_notify_timeout_set()
10492 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10494 * @brief Sets whether events should be passed to by a click outside
10497 * @param obj The notify object
10498 * @param repeats EINA_TRUE Events are repeats, else no
10500 * When true if the user clicks outside the window the events will be caught
10501 * by the others widgets, else the events are blocked.
10503 * @note The default value is EINA_TRUE.
10505 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10507 * @brief Return true if events are repeat below the notify object
10508 * @param obj the notify object
10510 * @see elm_notify_repeat_events_set()
10512 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10518 * @defgroup Hover Hover
10520 * @image html img/widget/hover/preview-00.png
10521 * @image latex img/widget/hover/preview-00.eps
10523 * A Hover object will hover over its @p parent object at the @p target
10524 * location. Anything in the background will be given a darker coloring to
10525 * indicate that the hover object is on top (at the default theme). When the
10526 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10527 * clicked that @b doesn't cause the hover to be dismissed.
10529 * A Hover object has two parents. One parent that owns it during creation
10530 * and the other parent being the one over which the hover object spans.
10533 * @note The hover object will take up the entire space of @p target
10536 * Elementary has the following styles for the hover widget:
10540 * @li hoversel_vertical
10542 * The following are the available position for content:
10554 * Signals that you can add callbacks for are:
10555 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10556 * @li "smart,changed" - a content object placed under the "smart"
10557 * policy was replaced to a new slot direction.
10559 * See @ref tutorial_hover for more information.
10563 typedef enum _Elm_Hover_Axis
10565 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10566 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10567 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10568 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10571 * @brief Adds a hover object to @p parent
10573 * @param parent The parent object
10574 * @return The hover object or NULL if one could not be created
10576 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10578 * @brief Sets the target object for the hover.
10580 * @param obj The hover object
10581 * @param target The object to center the hover onto. The hover
10583 * This function will cause the hover to be centered on the target object.
10585 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10587 * @brief Gets the target object for the hover.
10589 * @param obj The hover object
10590 * @param parent The object to locate the hover over.
10592 * @see elm_hover_target_set()
10594 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10596 * @brief Sets the parent object for the hover.
10598 * @param obj The hover object
10599 * @param parent The object to locate the hover over.
10601 * This function will cause the hover to take up the entire space that the
10602 * parent object fills.
10604 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10606 * @brief Gets the parent object for the hover.
10608 * @param obj The hover object
10609 * @return The parent object to locate the hover over.
10611 * @see elm_hover_parent_set()
10613 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10615 * @brief Sets the content of the hover object and the direction in which it
10618 * @param obj The hover object
10619 * @param swallow The direction that the object will be displayed
10620 * at. Accepted values are "left", "top-left", "top", "top-right",
10621 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10623 * @param content The content to place at @p swallow
10625 * Once the content object is set for a given direction, a previously
10626 * set one (on the same direction) will be deleted. If you want to
10627 * keep that old content object, use the elm_hover_content_unset()
10630 * All directions may have contents at the same time, except for
10631 * "smart". This is a special placement hint and its use case
10632 * independs of the calculations coming from
10633 * elm_hover_best_content_location_get(). Its use is for cases when
10634 * one desires only one hover content, but with a dinamic special
10635 * placement within the hover area. The content's geometry, whenever
10636 * it changes, will be used to decide on a best location not
10637 * extrapolating the hover's parent object view to show it in (still
10638 * being the hover's target determinant of its medium part -- move and
10639 * resize it to simulate finger sizes, for example). If one of the
10640 * directions other than "smart" are used, a previously content set
10641 * using it will be deleted, and vice-versa.
10643 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10645 * @brief Get the content of the hover object, in a given direction.
10647 * Return the content object which was set for this widget in the
10648 * @p swallow direction.
10650 * @param obj The hover object
10651 * @param swallow The direction that the object was display at.
10652 * @return The content that was being used
10654 * @see elm_hover_content_set()
10656 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10658 * @brief Unset the content of the hover object, in a given direction.
10660 * Unparent and return the content object set at @p swallow direction.
10662 * @param obj The hover object
10663 * @param swallow The direction that the object was display at.
10664 * @return The content that was being used.
10666 * @see elm_hover_content_set()
10668 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10670 * @brief Returns the best swallow location for content in the hover.
10672 * @param obj The hover object
10673 * @param pref_axis The preferred orientation axis for the hover object to use
10674 * @return The edje location to place content into the hover or @c
10677 * Best is defined here as the location at which there is the most available
10680 * @p pref_axis may be one of
10681 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10682 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10683 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10684 * - @c ELM_HOVER_AXIS_BOTH -- both
10686 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10687 * nescessarily be along the horizontal axis("left" or "right"). If
10688 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10689 * be along the vertical axis("top" or "bottom"). Chossing
10690 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10691 * returned position may be in either axis.
10693 * @see elm_hover_content_set()
10695 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10702 * @defgroup Entry Entry
10704 * @image html img/widget/entry/preview-00.png
10705 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10706 * @image html img/widget/entry/preview-01.png
10707 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10708 * @image html img/widget/entry/preview-02.png
10709 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10710 * @image html img/widget/entry/preview-03.png
10711 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10713 * An entry is a convenience widget which shows a box that the user can
10714 * enter text into. Entries by default don't scroll, so they grow to
10715 * accomodate the entire text, resizing the parent window as needed. This
10716 * can be changed with the elm_entry_scrollable_set() function.
10718 * They can also be single line or multi line (the default) and when set
10719 * to multi line mode they support text wrapping in any of the modes
10720 * indicated by #Elm_Wrap_Type.
10722 * Other features include password mode, filtering of inserted text with
10723 * elm_entry_text_filter_append() and related functions, inline "items" and
10724 * formatted markup text.
10726 * @section entry-markup Formatted text
10728 * The markup tags supported by the Entry are defined by the theme, but
10729 * even when writing new themes or extensions it's a good idea to stick to
10730 * a sane default, to maintain coherency and avoid application breakages.
10731 * Currently defined by the default theme are the following tags:
10732 * @li \<br\>: Inserts a line break.
10733 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10735 * @li \<tab\>: Inserts a tab.
10736 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10738 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10739 * @li \<link\>...\</link\>: Underlines the enclosed text.
10740 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10742 * @section entry-special Special markups
10744 * Besides those used to format text, entries support two special markup
10745 * tags used to insert clickable portions of text or items inlined within
10748 * @subsection entry-anchors Anchors
10750 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10751 * \</a\> tags and an event will be generated when this text is clicked,
10755 * This text is outside <a href=anc-01>but this one is an anchor</a>
10758 * The @c href attribute in the opening tag gives the name that will be
10759 * used to identify the anchor and it can be any valid utf8 string.
10761 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10762 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10763 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10764 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10767 * @subsection entry-items Items
10769 * Inlined in the text, any other @c Evas_Object can be inserted by using
10770 * \<item\> tags this way:
10773 * <item size=16x16 vsize=full href=emoticon/haha></item>
10776 * Just like with anchors, the @c href identifies each item, but these need,
10777 * in addition, to indicate their size, which is done using any one of
10778 * @c size, @c absize or @c relsize attributes. These attributes take their
10779 * value in the WxH format, where W is the width and H the height of the
10782 * @li absize: Absolute pixel size for the item. Whatever value is set will
10783 * be the item's size regardless of any scale value the object may have
10784 * been set to. The final line height will be adjusted to fit larger items.
10785 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10787 * @li relsize: Size is adjusted for the item to fit within the current
10790 * Besides their size, items are specificed a @c vsize value that affects
10791 * how their final size and position are calculated. The possible values
10793 * @li ascent: Item will be placed within the line's baseline and its
10794 * ascent. That is, the height between the line where all characters are
10795 * positioned and the highest point in the line. For @c size and @c absize
10796 * items, the descent value will be added to the total line height to make
10797 * them fit. @c relsize items will be adjusted to fit within this space.
10798 * @li full: Items will be placed between the descent and ascent, or the
10799 * lowest point in the line and its highest.
10801 * The next image shows different configurations of items and how they
10802 * are the previously mentioned options affect their sizes. In all cases,
10803 * the green line indicates the ascent, blue for the baseline and red for
10806 * @image html entry_item.png
10807 * @image latex entry_item.eps width=\textwidth
10809 * And another one to show how size differs from absize. In the first one,
10810 * the scale value is set to 1.0, while the second one is using one of 2.0.
10812 * @image html entry_item_scale.png
10813 * @image latex entry_item_scale.eps width=\textwidth
10815 * After the size for an item is calculated, the entry will request an
10816 * object to place in its space. For this, the functions set with
10817 * elm_entry_item_provider_append() and related functions will be called
10818 * in order until one of them returns a @c non-NULL value. If no providers
10819 * are available, or all of them return @c NULL, then the entry falls back
10820 * to one of the internal defaults, provided the name matches with one of
10823 * All of the following are currently supported:
10826 * - emoticon/angry-shout
10827 * - emoticon/crazy-laugh
10828 * - emoticon/evil-laugh
10830 * - emoticon/goggle-smile
10831 * - emoticon/grumpy
10832 * - emoticon/grumpy-smile
10833 * - emoticon/guilty
10834 * - emoticon/guilty-smile
10836 * - emoticon/half-smile
10837 * - emoticon/happy-panting
10839 * - emoticon/indifferent
10841 * - emoticon/knowing-grin
10843 * - emoticon/little-bit-sorry
10844 * - emoticon/love-lots
10846 * - emoticon/minimal-smile
10847 * - emoticon/not-happy
10848 * - emoticon/not-impressed
10850 * - emoticon/opensmile
10853 * - emoticon/squint-laugh
10854 * - emoticon/surprised
10855 * - emoticon/suspicious
10856 * - emoticon/tongue-dangling
10857 * - emoticon/tongue-poke
10859 * - emoticon/unhappy
10860 * - emoticon/very-sorry
10863 * - emoticon/worried
10866 * Alternatively, an item may reference an image by its path, using
10867 * the URI form @c file:///path/to/an/image.png and the entry will then
10868 * use that image for the item.
10870 * @section entry-files Loading and saving files
10872 * Entries have convinience functions to load text from a file and save
10873 * changes back to it after a short delay. The automatic saving is enabled
10874 * by default, but can be disabled with elm_entry_autosave_set() and files
10875 * can be loaded directly as plain text or have any markup in them
10876 * recognized. See elm_entry_file_set() for more details.
10878 * @section entry-signals Emitted signals
10880 * This widget emits the following signals:
10882 * @li "changed": The text within the entry was changed.
10883 * @li "changed,user": The text within the entry was changed because of user interaction.
10884 * @li "activated": The enter key was pressed on a single line entry.
10885 * @li "press": A mouse button has been pressed on the entry.
10886 * @li "longpressed": A mouse button has been pressed and held for a couple
10888 * @li "clicked": The entry has been clicked (mouse press and release).
10889 * @li "clicked,double": The entry has been double clicked.
10890 * @li "clicked,triple": The entry has been triple clicked.
10891 * @li "focused": The entry has received focus.
10892 * @li "unfocused": The entry has lost focus.
10893 * @li "selection,paste": A paste of the clipboard contents was requested.
10894 * @li "selection,copy": A copy of the selected text into the clipboard was
10896 * @li "selection,cut": A cut of the selected text into the clipboard was
10898 * @li "selection,start": A selection has begun and no previous selection
10900 * @li "selection,changed": The current selection has changed.
10901 * @li "selection,cleared": The current selection has been cleared.
10902 * @li "cursor,changed": The cursor has changed position.
10903 * @li "anchor,clicked": An anchor has been clicked. The event_info
10904 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10905 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10906 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10907 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10908 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10909 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10910 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10911 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10912 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10913 * @li "preedit,changed": The preedit string has changed.
10914 * @li "language,changed": Program language changed.
10916 * @section entry-examples
10918 * An overview of the Entry API can be seen in @ref entry_example_01
10923 * @typedef Elm_Entry_Anchor_Info
10925 * The info sent in the callback for the "anchor,clicked" signals emitted
10928 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10930 * @struct _Elm_Entry_Anchor_Info
10932 * The info sent in the callback for the "anchor,clicked" signals emitted
10935 struct _Elm_Entry_Anchor_Info
10937 const char *name; /**< The name of the anchor, as stated in its href */
10938 int button; /**< The mouse button used to click on it */
10939 Evas_Coord x, /**< Anchor geometry, relative to canvas */
10940 y, /**< Anchor geometry, relative to canvas */
10941 w, /**< Anchor geometry, relative to canvas */
10942 h; /**< Anchor geometry, relative to canvas */
10945 * @typedef Elm_Entry_Filter_Cb
10946 * This callback type is used by entry filters to modify text.
10947 * @param data The data specified as the last param when adding the filter
10948 * @param entry The entry object
10949 * @param text A pointer to the location of the text being filtered. This data can be modified,
10950 * but any additional allocations must be managed by the user.
10951 * @see elm_entry_text_filter_append
10952 * @see elm_entry_text_filter_prepend
10954 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10957 * This adds an entry to @p parent object.
10959 * By default, entries are:
10963 * @li autosave is enabled
10965 * @param parent The parent object
10966 * @return The new object or NULL if it cannot be created
10968 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10970 * Sets the entry to single line mode.
10972 * In single line mode, entries don't ever wrap when the text reaches the
10973 * edge, and instead they keep growing horizontally. Pressing the @c Enter
10974 * key will generate an @c "activate" event instead of adding a new line.
10976 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10977 * and pressing enter will break the text into a different line
10978 * without generating any events.
10980 * @param obj The entry object
10981 * @param single_line If true, the text in the entry
10982 * will be on a single line.
10984 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10986 * Gets whether the entry is set to be single line.
10988 * @param obj The entry object
10989 * @return single_line If true, the text in the entry is set to display
10990 * on a single line.
10992 * @see elm_entry_single_line_set()
10994 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10996 * Sets the entry to password mode.
10998 * In password mode, entries are implicitly single line and the display of
10999 * any text in them is replaced with asterisks (*).
11001 * @param obj The entry object
11002 * @param password If true, password mode is enabled.
11004 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11006 * Gets whether the entry is set to password mode.
11008 * @param obj The entry object
11009 * @return If true, the entry is set to display all characters
11010 * as asterisks (*).
11012 * @see elm_entry_password_set()
11014 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11016 * This sets the text displayed within the entry to @p entry.
11018 * @param obj The entry object
11019 * @param entry The text to be displayed
11021 * @deprecated Use elm_object_text_set() instead.
11022 * @note Using this function bypasses text filters
11024 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11026 * This returns the text currently shown in object @p entry.
11027 * See also elm_entry_entry_set().
11029 * @param obj The entry object
11030 * @return The currently displayed text or NULL on failure
11032 * @deprecated Use elm_object_text_get() instead.
11034 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11036 * Appends @p entry to the text of the entry.
11038 * Adds the text in @p entry to the end of any text already present in the
11041 * The appended text is subject to any filters set for the widget.
11043 * @param obj The entry object
11044 * @param entry The text to be displayed
11046 * @see elm_entry_text_filter_append()
11048 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11050 * Gets whether the entry is empty.
11052 * Empty means no text at all. If there are any markup tags, like an item
11053 * tag for which no provider finds anything, and no text is displayed, this
11054 * function still returns EINA_FALSE.
11056 * @param obj The entry object
11057 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11059 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11061 * Gets any selected text within the entry.
11063 * If there's any selected text in the entry, this function returns it as
11064 * a string in markup format. NULL is returned if no selection exists or
11065 * if an error occurred.
11067 * The returned value points to an internal string and should not be freed
11068 * or modified in any way. If the @p entry object is deleted or its
11069 * contents are changed, the returned pointer should be considered invalid.
11071 * @param obj The entry object
11072 * @return The selected text within the entry or NULL on failure
11074 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11076 * Inserts the given text into the entry at the current cursor position.
11078 * This inserts text at the cursor position as if it was typed
11079 * by the user (note that this also allows markup which a user
11080 * can't just "type" as it would be converted to escaped text, so this
11081 * call can be used to insert things like emoticon items or bold push/pop
11082 * tags, other font and color change tags etc.)
11084 * If any selection exists, it will be replaced by the inserted text.
11086 * The inserted text is subject to any filters set for the widget.
11088 * @param obj The entry object
11089 * @param entry The text to insert
11091 * @see elm_entry_text_filter_append()
11093 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11095 * Set the line wrap type to use on multi-line entries.
11097 * Sets the wrap type used by the entry to any of the specified in
11098 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11099 * line (without inserting a line break or paragraph separator) when it
11100 * reaches the far edge of the widget.
11102 * Note that this only makes sense for multi-line entries. A widget set
11103 * to be single line will never wrap.
11105 * @param obj The entry object
11106 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11108 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11109 EINA_DEPRECATED EAPI void elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
11111 * Gets the wrap mode the entry was set to use.
11113 * @param obj The entry object
11114 * @return Wrap type
11116 * @see also elm_entry_line_wrap_set()
11118 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11120 * Sets if the entry is to be editable or not.
11122 * By default, entries are editable and when focused, any text input by the
11123 * user will be inserted at the current cursor position. But calling this
11124 * function with @p editable as EINA_FALSE will prevent the user from
11125 * inputting text into the entry.
11127 * The only way to change the text of a non-editable entry is to use
11128 * elm_object_text_set(), elm_entry_entry_insert() and other related
11131 * @param obj The entry object
11132 * @param editable If EINA_TRUE, user input will be inserted in the entry,
11133 * if not, the entry is read-only and no user input is allowed.
11135 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11137 * Gets whether the entry is editable or not.
11139 * @param obj The entry object
11140 * @return If true, the entry is editable by the user.
11141 * If false, it is not editable by the user
11143 * @see elm_entry_editable_set()
11145 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11147 * This drops any existing text selection within the entry.
11149 * @param obj The entry object
11151 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11153 * This selects all text within the entry.
11155 * @param obj The entry object
11157 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11159 * This moves the cursor one place to the right within the entry.
11161 * @param obj The entry object
11162 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11164 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11166 * This moves the cursor one place to the left within the entry.
11168 * @param obj The entry object
11169 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11171 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11173 * This moves the cursor one line up within the entry.
11175 * @param obj The entry object
11176 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11178 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11180 * This moves the cursor one line down within the entry.
11182 * @param obj The entry object
11183 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11185 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11187 * This moves the cursor to the beginning of the entry.
11189 * @param obj The entry object
11191 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11193 * This moves the cursor to the end of the entry.
11195 * @param obj The entry object
11197 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11199 * This moves the cursor to the beginning of the current line.
11201 * @param obj The entry object
11203 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11205 * This moves the cursor to the end of the current line.
11207 * @param obj The entry object
11209 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11211 * This begins a selection within the entry as though
11212 * the user were holding down the mouse button to make a selection.
11214 * @param obj The entry object
11216 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11218 * This ends a selection within the entry as though
11219 * the user had just released the mouse button while making a selection.
11221 * @param obj The entry object
11223 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11225 * Gets whether a format node exists at the current cursor position.
11227 * A format node is anything that defines how the text is rendered. It can
11228 * be a visible format node, such as a line break or a paragraph separator,
11229 * or an invisible one, such as bold begin or end tag.
11230 * This function returns whether any format node exists at the current
11233 * @param obj The entry object
11234 * @return EINA_TRUE if the current cursor position contains a format node,
11235 * EINA_FALSE otherwise.
11237 * @see elm_entry_cursor_is_visible_format_get()
11239 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11241 * Gets if the current cursor position holds a visible format node.
11243 * @param obj The entry object
11244 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11245 * if it's an invisible one or no format exists.
11247 * @see elm_entry_cursor_is_format_get()
11249 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11251 * Gets the character pointed by the cursor at its current position.
11253 * This function returns a string with the utf8 character stored at the
11254 * current cursor position.
11255 * Only the text is returned, any format that may exist will not be part
11256 * of the return value.
11258 * @param obj The entry object
11259 * @return The text pointed by the cursors.
11261 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11263 * This function returns the geometry of the cursor.
11265 * It's useful if you want to draw something on the cursor (or where it is),
11266 * or for example in the case of scrolled entry where you want to show the
11269 * @param obj The entry object
11270 * @param x returned geometry
11271 * @param y returned geometry
11272 * @param w returned geometry
11273 * @param h returned geometry
11274 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11276 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);
11278 * Sets the cursor position in the entry to the given value
11280 * The value in @p pos is the index of the character position within the
11281 * contents of the string as returned by elm_entry_cursor_pos_get().
11283 * @param obj The entry object
11284 * @param pos The position of the cursor
11286 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11288 * Retrieves the current position of the cursor in the entry
11290 * @param obj The entry object
11291 * @return The cursor position
11293 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11295 * This executes a "cut" action on the selected text in the entry.
11297 * @param obj The entry object
11299 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11301 * This executes a "copy" action on the selected text in the entry.
11303 * @param obj The entry object
11305 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11307 * This executes a "paste" action in the entry.
11309 * @param obj The entry object
11311 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11313 * This clears and frees the items in a entry's contextual (longpress)
11316 * @param obj The entry object
11318 * @see elm_entry_context_menu_item_add()
11320 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11322 * This adds an item to the entry's contextual menu.
11324 * A longpress on an entry will make the contextual menu show up, if this
11325 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11326 * By default, this menu provides a few options like enabling selection mode,
11327 * which is useful on embedded devices that need to be explicit about it,
11328 * and when a selection exists it also shows the copy and cut actions.
11330 * With this function, developers can add other options to this menu to
11331 * perform any action they deem necessary.
11333 * @param obj The entry object
11334 * @param label The item's text label
11335 * @param icon_file The item's icon file
11336 * @param icon_type The item's icon type
11337 * @param func The callback to execute when the item is clicked
11338 * @param data The data to associate with the item for related functions
11340 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);
11342 * This disables the entry's contextual (longpress) menu.
11344 * @param obj The entry object
11345 * @param disabled If true, the menu is disabled
11347 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11349 * This returns whether the entry's contextual (longpress) menu is
11352 * @param obj The entry object
11353 * @return If true, the menu is disabled
11355 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11357 * This appends a custom item provider to the list for that entry
11359 * This appends the given callback. The list is walked from beginning to end
11360 * with each function called given the item href string in the text. If the
11361 * function returns an object handle other than NULL (it should create an
11362 * object to do this), then this object is used to replace that item. If
11363 * not the next provider is called until one provides an item object, or the
11364 * default provider in entry does.
11366 * @param obj The entry object
11367 * @param func The function called to provide the item object
11368 * @param data The data passed to @p func
11370 * @see @ref entry-items
11372 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);
11374 * This prepends a custom item provider to the list for that entry
11376 * This prepends the given callback. See elm_entry_item_provider_append() for
11379 * @param obj The entry object
11380 * @param func The function called to provide the item object
11381 * @param data The data passed to @p func
11383 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);
11385 * This removes a custom item provider to the list for that entry
11387 * This removes the given callback. See elm_entry_item_provider_append() for
11390 * @param obj The entry object
11391 * @param func The function called to provide the item object
11392 * @param data The data passed to @p func
11394 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);
11396 * Append a filter function for text inserted in the entry
11398 * Append the given callback to the list. This functions will be called
11399 * whenever any text is inserted into the entry, with the text to be inserted
11400 * as a parameter. The callback function is free to alter the text in any way
11401 * it wants, but it must remember to free the given pointer and update it.
11402 * If the new text is to be discarded, the function can free it and set its
11403 * text parameter to NULL. This will also prevent any following filters from
11406 * @param obj The entry object
11407 * @param func The function to use as text filter
11408 * @param data User data to pass to @p func
11410 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11412 * Prepend a filter function for text insdrted in the entry
11414 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11415 * for more information
11417 * @param obj The entry object
11418 * @param func The function to use as text filter
11419 * @param data User data to pass to @p func
11421 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11423 * Remove a filter from the list
11425 * Removes the given callback from the filter list. See
11426 * elm_entry_text_filter_append() for more information.
11428 * @param obj The entry object
11429 * @param func The filter function to remove
11430 * @param data The user data passed when adding the function
11432 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11434 * This converts a markup (HTML-like) string into UTF-8.
11436 * The returned string is a malloc'ed buffer and it should be freed when
11437 * not needed anymore.
11439 * @param s The string (in markup) to be converted
11440 * @return The converted string (in UTF-8). It should be freed.
11442 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11444 * This converts a UTF-8 string into markup (HTML-like).
11446 * The returned string is a malloc'ed buffer and it should be freed when
11447 * not needed anymore.
11449 * @param s The string (in UTF-8) to be converted
11450 * @return The converted string (in markup). It should be freed.
11452 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11454 * This sets the file (and implicitly loads it) for the text to display and
11455 * then edit. All changes are written back to the file after a short delay if
11456 * the entry object is set to autosave (which is the default).
11458 * If the entry had any other file set previously, any changes made to it
11459 * will be saved if the autosave feature is enabled, otherwise, the file
11460 * will be silently discarded and any non-saved changes will be lost.
11462 * @param obj The entry object
11463 * @param file The path to the file to load and save
11464 * @param format The file format
11466 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11468 * Gets the file being edited by the entry.
11470 * This function can be used to retrieve any file set on the entry for
11471 * edition, along with the format used to load and save it.
11473 * @param obj The entry object
11474 * @param file The path to the file to load and save
11475 * @param format The file format
11477 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11479 * This function writes any changes made to the file set with
11480 * elm_entry_file_set()
11482 * @param obj The entry object
11484 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11486 * This sets the entry object to 'autosave' the loaded text file or not.
11488 * @param obj The entry object
11489 * @param autosave Autosave the loaded file or not
11491 * @see elm_entry_file_set()
11493 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11495 * This gets the entry object's 'autosave' status.
11497 * @param obj The entry object
11498 * @return Autosave the loaded file or not
11500 * @see elm_entry_file_set()
11502 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11504 * Control pasting of text and images for the widget.
11506 * Normally the entry allows both text and images to be pasted. By setting
11507 * textonly to be true, this prevents images from being pasted.
11509 * Note this only changes the behaviour of text.
11511 * @param obj The entry object
11512 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11513 * text+image+other.
11515 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11517 * Getting elm_entry text paste/drop mode.
11519 * In textonly mode, only text may be pasted or dropped into the widget.
11521 * @param obj The entry object
11522 * @return If the widget only accepts text from pastes.
11524 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11526 * Enable or disable scrolling in entry
11528 * Normally the entry is not scrollable unless you enable it with this call.
11530 * @param obj The entry object
11531 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11533 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11535 * Get the scrollable state of the entry
11537 * Normally the entry is not scrollable. This gets the scrollable state
11538 * of the entry. See elm_entry_scrollable_set() for more information.
11540 * @param obj The entry object
11541 * @return The scrollable state
11543 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11545 * This sets a widget to be displayed to the left of a scrolled entry.
11547 * @param obj The scrolled entry object
11548 * @param icon The widget to display on the left side of the scrolled
11551 * @note A previously set widget will be destroyed.
11552 * @note If the object being set does not have minimum size hints set,
11553 * it won't get properly displayed.
11555 * @see elm_entry_end_set()
11557 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11559 * Gets the leftmost widget of the scrolled entry. This object is
11560 * owned by the scrolled entry and should not be modified.
11562 * @param obj The scrolled entry object
11563 * @return the left widget inside the scroller
11565 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11567 * Unset the leftmost widget of the scrolled entry, unparenting and
11570 * @param obj The scrolled entry object
11571 * @return the previously set icon sub-object of this entry, on
11574 * @see elm_entry_icon_set()
11576 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11578 * Sets the visibility of the left-side widget of the scrolled entry,
11579 * set by elm_entry_icon_set().
11581 * @param obj The scrolled entry object
11582 * @param setting EINA_TRUE if the object should be displayed,
11583 * EINA_FALSE if not.
11585 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11587 * This sets a widget to be displayed to the end of a scrolled entry.
11589 * @param obj The scrolled entry object
11590 * @param end The widget to display on the right side of the scrolled
11593 * @note A previously set widget will be destroyed.
11594 * @note If the object being set does not have minimum size hints set,
11595 * it won't get properly displayed.
11597 * @see elm_entry_icon_set
11599 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11601 * Gets the endmost widget of the scrolled entry. This object is owned
11602 * by the scrolled entry and should not be modified.
11604 * @param obj The scrolled entry object
11605 * @return the right widget inside the scroller
11607 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11609 * Unset the endmost widget of the scrolled entry, unparenting and
11612 * @param obj The scrolled entry object
11613 * @return the previously set icon sub-object of this entry, on
11616 * @see elm_entry_icon_set()
11618 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11620 * Sets the visibility of the end widget of the scrolled entry, set by
11621 * elm_entry_end_set().
11623 * @param obj The scrolled entry object
11624 * @param setting EINA_TRUE if the object should be displayed,
11625 * EINA_FALSE if not.
11627 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11629 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11632 * Setting an entry to single-line mode with elm_entry_single_line_set()
11633 * will automatically disable the display of scrollbars when the entry
11634 * moves inside its scroller.
11636 * @param obj The scrolled entry object
11637 * @param h The horizontal scrollbar policy to apply
11638 * @param v The vertical scrollbar policy to apply
11640 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11642 * This enables/disables bouncing within the entry.
11644 * This function sets whether the entry will bounce when scrolling reaches
11645 * the end of the contained entry.
11647 * @param obj The scrolled entry object
11648 * @param h The horizontal bounce state
11649 * @param v The vertical bounce state
11651 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11653 * Get the bounce mode
11655 * @param obj The Entry object
11656 * @param h_bounce Allow bounce horizontally
11657 * @param v_bounce Allow bounce vertically
11659 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11661 /* pre-made filters for entries */
11663 * @typedef Elm_Entry_Filter_Limit_Size
11665 * Data for the elm_entry_filter_limit_size() entry filter.
11667 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11669 * @struct _Elm_Entry_Filter_Limit_Size
11671 * Data for the elm_entry_filter_limit_size() entry filter.
11673 struct _Elm_Entry_Filter_Limit_Size
11675 int max_char_count; /**< The maximum number of characters allowed. */
11676 int max_byte_count; /**< The maximum number of bytes allowed*/
11679 * Filter inserted text based on user defined character and byte limits
11681 * Add this filter to an entry to limit the characters that it will accept
11682 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11683 * The funtion works on the UTF-8 representation of the string, converting
11684 * it from the set markup, thus not accounting for any format in it.
11686 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11687 * it as data when setting the filter. In it, it's possible to set limits
11688 * by character count or bytes (any of them is disabled if 0), and both can
11689 * be set at the same time. In that case, it first checks for characters,
11692 * The function will cut the inserted text in order to allow only the first
11693 * number of characters that are still allowed. The cut is made in
11694 * characters, even when limiting by bytes, in order to always contain
11695 * valid ones and avoid half unicode characters making it in.
11697 * This filter, like any others, does not apply when setting the entry text
11698 * directly with elm_object_text_set() (or the deprecated
11699 * elm_entry_entry_set()).
11701 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11703 * @typedef Elm_Entry_Filter_Accept_Set
11705 * Data for the elm_entry_filter_accept_set() entry filter.
11707 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11709 * @struct _Elm_Entry_Filter_Accept_Set
11711 * Data for the elm_entry_filter_accept_set() entry filter.
11713 struct _Elm_Entry_Filter_Accept_Set
11715 const char *accepted; /**< Set of characters accepted in the entry. */
11716 const char *rejected; /**< Set of characters rejected from the entry. */
11719 * Filter inserted text based on accepted or rejected sets of characters
11721 * Add this filter to an entry to restrict the set of accepted characters
11722 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11723 * This structure contains both accepted and rejected sets, but they are
11724 * mutually exclusive.
11726 * The @c accepted set takes preference, so if it is set, the filter will
11727 * only work based on the accepted characters, ignoring anything in the
11728 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11730 * In both cases, the function filters by matching utf8 characters to the
11731 * raw markup text, so it can be used to remove formatting tags.
11733 * This filter, like any others, does not apply when setting the entry text
11734 * directly with elm_object_text_set() (or the deprecated
11735 * elm_entry_entry_set()).
11737 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11739 * Set the input panel layout of the entry
11741 * @param obj The entry object
11742 * @param layout layout type
11744 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11746 * Get the input panel layout of the entry
11748 * @param obj The entry object
11749 * @return layout type
11751 * @see elm_entry_input_panel_layout_set
11753 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11755 * Set the autocapitalization type on the immodule.
11757 * @param obj The entry object
11758 * @param autocapital_type The type of autocapitalization
11760 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
11762 * Retrieve the autocapitalization type on the immodule.
11764 * @param obj The entry object
11765 * @return autocapitalization type
11767 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11769 * Sets the attribute to show the input panel automatically.
11771 * @param obj The entry object
11772 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
11774 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
11776 * Retrieve the attribute to show the input panel automatically.
11778 * @param obj The entry object
11779 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
11781 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11783 EAPI void elm_entry_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11784 EAPI void elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
11785 EAPI void elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
11786 EAPI void elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
11787 EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
11788 EAPI void elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
11789 EAPI void elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
11791 EINA_DEPRECATED EAPI void elm_entry_wrap_width_set(Evas_Object *obj, Evas_Coord w);
11792 EINA_DEPRECATED EAPI Evas_Coord elm_entry_wrap_width_get(const Evas_Object *obj);
11793 EINA_DEPRECATED EAPI void elm_entry_fontsize_set(Evas_Object *obj, int fontsize);
11794 EINA_DEPRECATED EAPI void elm_entry_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11795 EINA_DEPRECATED EAPI void elm_entry_text_align_set(Evas_Object *obj, const char *alignmode);
11801 /* composite widgets - these basically put together basic widgets above
11802 * in convenient packages that do more than basic stuff */
11806 * @defgroup Anchorview Anchorview
11808 * @image html img/widget/anchorview/preview-00.png
11809 * @image latex img/widget/anchorview/preview-00.eps
11811 * Anchorview is for displaying text that contains markup with anchors
11812 * like <c>\<a href=1234\>something\</\></c> in it.
11814 * Besides being styled differently, the anchorview widget provides the
11815 * necessary functionality so that clicking on these anchors brings up a
11816 * popup with user defined content such as "call", "add to contacts" or
11817 * "open web page". This popup is provided using the @ref Hover widget.
11819 * This widget is very similar to @ref Anchorblock, so refer to that
11820 * widget for an example. The only difference Anchorview has is that the
11821 * widget is already provided with scrolling functionality, so if the
11822 * text set to it is too large to fit in the given space, it will scroll,
11823 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11824 * text can be displayed.
11826 * This widget emits the following signals:
11827 * @li "anchor,clicked": will be called when an anchor is clicked. The
11828 * @p event_info parameter on the callback will be a pointer of type
11829 * ::Elm_Entry_Anchorview_Info.
11831 * See @ref Anchorblock for an example on how to use both of them.
11840 * @typedef Elm_Entry_Anchorview_Info
11842 * The info sent in the callback for "anchor,clicked" signals emitted by
11843 * the Anchorview widget.
11845 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11847 * @struct _Elm_Entry_Anchorview_Info
11849 * The info sent in the callback for "anchor,clicked" signals emitted by
11850 * the Anchorview widget.
11852 struct _Elm_Entry_Anchorview_Info
11854 const char *name; /**< Name of the anchor, as indicated in its href
11856 int button; /**< The mouse button used to click on it */
11857 Evas_Object *hover; /**< The hover object to use for the popup */
11859 Evas_Coord x, y, w, h;
11860 } anchor, /**< Geometry selection of text used as anchor */
11861 hover_parent; /**< Geometry of the object used as parent by the
11863 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11864 for content on the left side of
11865 the hover. Before calling the
11866 callback, the widget will make the
11867 necessary calculations to check
11868 which sides are fit to be set with
11869 content, based on the position the
11870 hover is activated and its distance
11871 to the edges of its parent object
11873 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11874 the right side of the hover.
11875 See @ref hover_left */
11876 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11877 of the hover. See @ref hover_left */
11878 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11879 below the hover. See @ref
11883 * Add a new Anchorview object
11885 * @param parent The parent object
11886 * @return The new object or NULL if it cannot be created
11888 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11890 * Set the text to show in the anchorview
11892 * Sets the text of the anchorview to @p text. This text can include markup
11893 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11894 * text that will be specially styled and react to click events, ended with
11895 * either of \</a\> or \</\>. When clicked, the anchor will emit an
11896 * "anchor,clicked" signal that you can attach a callback to with
11897 * evas_object_smart_callback_add(). The name of the anchor given in the
11898 * event info struct will be the one set in the href attribute, in this
11899 * case, anchorname.
11901 * Other markup can be used to style the text in different ways, but it's
11902 * up to the style defined in the theme which tags do what.
11903 * @deprecated use elm_object_text_set() instead.
11905 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11907 * Get the markup text set for the anchorview
11909 * Retrieves the text set on the anchorview, with markup tags included.
11911 * @param obj The anchorview object
11912 * @return The markup text set or @c NULL if nothing was set or an error
11914 * @deprecated use elm_object_text_set() instead.
11916 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11918 * Set the parent of the hover popup
11920 * Sets the parent object to use by the hover created by the anchorview
11921 * when an anchor is clicked. See @ref Hover for more details on this.
11922 * If no parent is set, the same anchorview object will be used.
11924 * @param obj The anchorview object
11925 * @param parent The object to use as parent for the hover
11927 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11929 * Get the parent of the hover popup
11931 * Get the object used as parent for the hover created by the anchorview
11932 * widget. See @ref Hover for more details on this.
11934 * @param obj The anchorview object
11935 * @return The object used as parent for the hover, NULL if none is set.
11937 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11939 * Set the style that the hover should use
11941 * When creating the popup hover, anchorview will request that it's
11942 * themed according to @p style.
11944 * @param obj The anchorview object
11945 * @param style The style to use for the underlying hover
11947 * @see elm_object_style_set()
11949 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11951 * Get the style that the hover should use
11953 * Get the style the hover created by anchorview will use.
11955 * @param obj The anchorview object
11956 * @return The style to use by the hover. NULL means the default is used.
11958 * @see elm_object_style_set()
11960 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11962 * Ends the hover popup in the anchorview
11964 * When an anchor is clicked, the anchorview widget will create a hover
11965 * object to use as a popup with user provided content. This function
11966 * terminates this popup, returning the anchorview to its normal state.
11968 * @param obj The anchorview object
11970 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11972 * Set bouncing behaviour when the scrolled content reaches an edge
11974 * Tell the internal scroller object whether it should bounce or not
11975 * when it reaches the respective edges for each axis.
11977 * @param obj The anchorview object
11978 * @param h_bounce Whether to bounce or not in the horizontal axis
11979 * @param v_bounce Whether to bounce or not in the vertical axis
11981 * @see elm_scroller_bounce_set()
11983 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11985 * Get the set bouncing behaviour of the internal scroller
11987 * Get whether the internal scroller should bounce when the edge of each
11988 * axis is reached scrolling.
11990 * @param obj The anchorview object
11991 * @param h_bounce Pointer where to store the bounce state of the horizontal
11993 * @param v_bounce Pointer where to store the bounce state of the vertical
11996 * @see elm_scroller_bounce_get()
11998 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12000 * Appends a custom item provider to the given anchorview
12002 * Appends the given function to the list of items providers. This list is
12003 * called, one function at a time, with the given @p data pointer, the
12004 * anchorview object and, in the @p item parameter, the item name as
12005 * referenced in its href string. Following functions in the list will be
12006 * called in order until one of them returns something different to NULL,
12007 * which should be an Evas_Object which will be used in place of the item
12010 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12011 * href=item/name\>\</item\>
12013 * @param obj The anchorview object
12014 * @param func The function to add to the list of providers
12015 * @param data User data that will be passed to the callback function
12017 * @see elm_entry_item_provider_append()
12019 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);
12021 * Prepend a custom item provider to the given anchorview
12023 * Like elm_anchorview_item_provider_append(), but it adds the function
12024 * @p func to the beginning of the list, instead of the end.
12026 * @param obj The anchorview object
12027 * @param func The function to add to the list of providers
12028 * @param data User data that will be passed to the callback function
12030 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);
12032 * Remove a custom item provider from the list of the given anchorview
12034 * Removes the function and data pairing that matches @p func and @p data.
12035 * That is, unless the same function and same user data are given, the
12036 * function will not be removed from the list. This allows us to add the
12037 * same callback several times, with different @p data pointers and be
12038 * able to remove them later without conflicts.
12040 * @param obj The anchorview object
12041 * @param func The function to remove from the list
12042 * @param data The data matching the function to remove from the list
12044 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);
12051 * @defgroup Anchorblock Anchorblock
12053 * @image html img/widget/anchorblock/preview-00.png
12054 * @image latex img/widget/anchorblock/preview-00.eps
12056 * Anchorblock is for displaying text that contains markup with anchors
12057 * like <c>\<a href=1234\>something\</\></c> in it.
12059 * Besides being styled differently, the anchorblock widget provides the
12060 * necessary functionality so that clicking on these anchors brings up a
12061 * popup with user defined content such as "call", "add to contacts" or
12062 * "open web page". This popup is provided using the @ref Hover widget.
12064 * This widget emits the following signals:
12065 * @li "anchor,clicked": will be called when an anchor is clicked. The
12066 * @p event_info parameter on the callback will be a pointer of type
12067 * ::Elm_Entry_Anchorblock_Info.
12073 * Since examples are usually better than plain words, we might as well
12074 * try @ref tutorial_anchorblock_example "one".
12077 * @addtogroup Anchorblock
12081 * @typedef Elm_Entry_Anchorblock_Info
12083 * The info sent in the callback for "anchor,clicked" signals emitted by
12084 * the Anchorblock widget.
12086 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12088 * @struct _Elm_Entry_Anchorblock_Info
12090 * The info sent in the callback for "anchor,clicked" signals emitted by
12091 * the Anchorblock widget.
12093 struct _Elm_Entry_Anchorblock_Info
12095 const char *name; /**< Name of the anchor, as indicated in its href
12097 int button; /**< The mouse button used to click on it */
12098 Evas_Object *hover; /**< The hover object to use for the popup */
12100 Evas_Coord x, y, w, h;
12101 } anchor, /**< Geometry selection of text used as anchor */
12102 hover_parent; /**< Geometry of the object used as parent by the
12104 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12105 for content on the left side of
12106 the hover. Before calling the
12107 callback, the widget will make the
12108 necessary calculations to check
12109 which sides are fit to be set with
12110 content, based on the position the
12111 hover is activated and its distance
12112 to the edges of its parent object
12114 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12115 the right side of the hover.
12116 See @ref hover_left */
12117 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12118 of the hover. See @ref hover_left */
12119 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12120 below the hover. See @ref
12124 * Add a new Anchorblock object
12126 * @param parent The parent object
12127 * @return The new object or NULL if it cannot be created
12129 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12131 * Set the text to show in the anchorblock
12133 * Sets the text of the anchorblock to @p text. This text can include markup
12134 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12135 * of text that will be specially styled and react to click events, ended
12136 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12137 * "anchor,clicked" signal that you can attach a callback to with
12138 * evas_object_smart_callback_add(). The name of the anchor given in the
12139 * event info struct will be the one set in the href attribute, in this
12140 * case, anchorname.
12142 * Other markup can be used to style the text in different ways, but it's
12143 * up to the style defined in the theme which tags do what.
12144 * @deprecated use elm_object_text_set() instead.
12146 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12148 * Get the markup text set for the anchorblock
12150 * Retrieves the text set on the anchorblock, with markup tags included.
12152 * @param obj The anchorblock object
12153 * @return The markup text set or @c NULL if nothing was set or an error
12155 * @deprecated use elm_object_text_set() instead.
12157 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12159 * Set the parent of the hover popup
12161 * Sets the parent object to use by the hover created by the anchorblock
12162 * when an anchor is clicked. See @ref Hover for more details on this.
12164 * @param obj The anchorblock object
12165 * @param parent The object to use as parent for the hover
12167 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12169 * Get the parent of the hover popup
12171 * Get the object used as parent for the hover created by the anchorblock
12172 * widget. See @ref Hover for more details on this.
12173 * If no parent is set, the same anchorblock object will be used.
12175 * @param obj The anchorblock object
12176 * @return The object used as parent for the hover, NULL if none is set.
12178 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12180 * Set the style that the hover should use
12182 * When creating the popup hover, anchorblock will request that it's
12183 * themed according to @p style.
12185 * @param obj The anchorblock object
12186 * @param style The style to use for the underlying hover
12188 * @see elm_object_style_set()
12190 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12192 * Get the style that the hover should use
12194 * Get the style, the hover created by anchorblock will use.
12196 * @param obj The anchorblock object
12197 * @return The style to use by the hover. NULL means the default is used.
12199 * @see elm_object_style_set()
12201 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12203 * Ends the hover popup in the anchorblock
12205 * When an anchor is clicked, the anchorblock widget will create a hover
12206 * object to use as a popup with user provided content. This function
12207 * terminates this popup, returning the anchorblock to its normal state.
12209 * @param obj The anchorblock object
12211 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12213 * Appends a custom item provider to the given anchorblock
12215 * Appends the given function to the list of items providers. This list is
12216 * called, one function at a time, with the given @p data pointer, the
12217 * anchorblock object and, in the @p item parameter, the item name as
12218 * referenced in its href string. Following functions in the list will be
12219 * called in order until one of them returns something different to NULL,
12220 * which should be an Evas_Object which will be used in place of the item
12223 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12224 * href=item/name\>\</item\>
12226 * @param obj The anchorblock object
12227 * @param func The function to add to the list of providers
12228 * @param data User data that will be passed to the callback function
12230 * @see elm_entry_item_provider_append()
12232 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);
12234 * Prepend a custom item provider to the given anchorblock
12236 * Like elm_anchorblock_item_provider_append(), but it adds the function
12237 * @p func to the beginning of the list, instead of the end.
12239 * @param obj The anchorblock object
12240 * @param func The function to add to the list of providers
12241 * @param data User data that will be passed to the callback function
12243 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);
12245 * Remove a custom item provider from the list of the given anchorblock
12247 * Removes the function and data pairing that matches @p func and @p data.
12248 * That is, unless the same function and same user data are given, the
12249 * function will not be removed from the list. This allows us to add the
12250 * same callback several times, with different @p data pointers and be
12251 * able to remove them later without conflicts.
12253 * @param obj The anchorblock object
12254 * @param func The function to remove from the list
12255 * @param data The data matching the function to remove from the list
12257 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);
12263 * @defgroup Bubble Bubble
12265 * @image html img/widget/bubble/preview-00.png
12266 * @image latex img/widget/bubble/preview-00.eps
12267 * @image html img/widget/bubble/preview-01.png
12268 * @image latex img/widget/bubble/preview-01.eps
12269 * @image html img/widget/bubble/preview-02.png
12270 * @image latex img/widget/bubble/preview-02.eps
12272 * @brief The Bubble is a widget to show text similar to how speech is
12273 * represented in comics.
12275 * The bubble widget contains 5 important visual elements:
12276 * @li The frame is a rectangle with rounded edjes and an "arrow".
12277 * @li The @p icon is an image to which the frame's arrow points to.
12278 * @li The @p label is a text which appears to the right of the icon if the
12279 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12281 * @li The @p info is a text which appears to the right of the label. Info's
12282 * font is of a ligther color than label.
12283 * @li The @p content is an evas object that is shown inside the frame.
12285 * The position of the arrow, icon, label and info depends on which corner is
12286 * selected. The four available corners are:
12287 * @li "top_left" - Default
12289 * @li "bottom_left"
12290 * @li "bottom_right"
12292 * Signals that you can add callbacks for are:
12293 * @li "clicked" - This is called when a user has clicked the bubble.
12295 * Default contents parts of the bubble that you can use for are:
12296 * @li "default" - A content of the bubble
12297 * @li "icon" - An icon of the bubble
12299 * Default text parts of the button widget that you can use for are:
12300 * @li NULL - Label of the bubble
12302 * For an example of using a buble see @ref bubble_01_example_page "this".
12308 * Add a new bubble to the parent
12310 * @param parent The parent object
12311 * @return The new object or NULL if it cannot be created
12313 * This function adds a text bubble to the given parent evas object.
12315 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12317 * Set the label of the bubble
12319 * @param obj The bubble object
12320 * @param label The string to set in the label
12322 * This function sets the title of the bubble. Where this appears depends on
12323 * the selected corner.
12324 * @deprecated use elm_object_text_set() instead.
12326 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12328 * Get the label of the bubble
12330 * @param obj The bubble object
12331 * @return The string of set in the label
12333 * This function gets the title of the bubble.
12334 * @deprecated use elm_object_text_get() instead.
12336 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12338 * Set the info of the bubble
12340 * @param obj The bubble object
12341 * @param info The given info about the bubble
12343 * This function sets the info of the bubble. Where this appears depends on
12344 * the selected corner.
12345 * @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
12347 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12349 * Get the info of the bubble
12351 * @param obj The bubble object
12353 * @return The "info" string of the bubble
12355 * This function gets the info text.
12356 * @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
12358 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12360 * Set the content to be shown in the bubble
12362 * Once the content object is set, a previously set one will be deleted.
12363 * If you want to keep the old content object, use the
12364 * elm_bubble_content_unset() function.
12366 * @param obj The bubble object
12367 * @param content The given content of the bubble
12369 * This function sets the content shown on the middle of the bubble.
12371 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12373 * Get the content shown in the bubble
12375 * Return the content object which is set for this widget.
12377 * @param obj The bubble object
12378 * @return The content that is being used
12380 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12382 * Unset the content shown in the bubble
12384 * Unparent and return the content object which was set for this widget.
12386 * @param obj The bubble object
12387 * @return The content that was being used
12389 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12391 * Set the icon of the bubble
12393 * Once the icon object is set, a previously set one will be deleted.
12394 * If you want to keep the old content object, use the
12395 * elm_icon_content_unset() function.
12397 * @param obj The bubble object
12398 * @param icon The given icon for the bubble
12400 * @deprecated use elm_object_part_content_set() instead
12403 EINA_DEPRECATED EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12405 * Get the icon of the bubble
12407 * @param obj The bubble object
12408 * @return The icon for the bubble
12410 * This function gets the icon shown on the top left of bubble.
12412 * @deprecated use elm_object_part_content_get() instead
12415 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12417 * Unset the icon of the bubble
12419 * Unparent and return the icon object which was set for this widget.
12421 * @param obj The bubble object
12422 * @return The icon that was being used
12424 * @deprecated use elm_object_part_content_unset() instead
12427 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12429 * Set the corner of the bubble
12431 * @param obj The bubble object.
12432 * @param corner The given corner for the bubble.
12434 * This function sets the corner of the bubble. The corner will be used to
12435 * determine where the arrow in the frame points to and where label, icon and
12438 * Possible values for corner are:
12439 * @li "top_left" - Default
12441 * @li "bottom_left"
12442 * @li "bottom_right"
12444 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12446 * Get the corner of the bubble
12448 * @param obj The bubble object.
12449 * @return The given corner for the bubble.
12451 * This function gets the selected corner of the bubble.
12453 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12455 EINA_DEPRECATED EAPI void elm_bubble_sweep_layout_set(Evas_Object *obj, Evas_Object *sweep) EINA_ARG_NONNULL(1);
12456 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_sweep_layout_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12463 * @defgroup Photo Photo
12465 * For displaying the photo of a person (contact). Simple, yet
12466 * with a very specific purpose.
12468 * Signals that you can add callbacks for are:
12470 * "clicked" - This is called when a user has clicked the photo
12471 * "drag,start" - Someone started dragging the image out of the object
12472 * "drag,end" - Dragged item was dropped (somewhere)
12478 * Add a new photo to the parent
12480 * @param parent The parent object
12481 * @return The new object or NULL if it cannot be created
12485 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12488 * Set the file that will be used as photo
12490 * @param obj The photo object
12491 * @param file The path to file that will be used as photo
12493 * @return (1 = success, 0 = error)
12497 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12500 * Set the file that will be used as thumbnail in the photo.
12502 * @param obj The photo object.
12503 * @param file The path to file that will be used as thumb.
12504 * @param group The key used in case of an EET file.
12508 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12511 * Set the size that will be used on the photo
12513 * @param obj The photo object
12514 * @param size The size that the photo will be
12518 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12521 * Set if the photo should be completely visible or not.
12523 * @param obj The photo object
12524 * @param fill if true the photo will be completely visible
12528 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12531 * Set editability of the photo.
12533 * An editable photo can be dragged to or from, and can be cut or
12534 * pasted too. Note that pasting an image or dropping an item on
12535 * the image will delete the existing content.
12537 * @param obj The photo object.
12538 * @param set To set of clear editablity.
12540 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12546 /* gesture layer */
12548 * @defgroup Elm_Gesture_Layer Gesture Layer
12549 * Gesture Layer Usage:
12551 * Use Gesture Layer to detect gestures.
12552 * The advantage is that you don't have to implement
12553 * gesture detection, just set callbacks of gesture state.
12554 * By using gesture layer we make standard interface.
12556 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12557 * with a parent object parameter.
12558 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12559 * call. Usually with same object as target (2nd parameter).
12561 * Now you need to tell gesture layer what gestures you follow.
12562 * This is done with @ref elm_gesture_layer_cb_set call.
12563 * By setting the callback you actually saying to gesture layer:
12564 * I would like to know when the gesture @ref Elm_Gesture_Types
12565 * switches to state @ref Elm_Gesture_State.
12567 * Next, you need to implement the actual action that follows the input
12568 * in your callback.
12570 * Note that if you like to stop being reported about a gesture, just set
12571 * all callbacks referring this gesture to NULL.
12572 * (again with @ref elm_gesture_layer_cb_set)
12574 * The information reported by gesture layer to your callback is depending
12575 * on @ref Elm_Gesture_Types:
12576 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12577 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12578 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12580 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12581 * @ref ELM_GESTURE_MOMENTUM.
12583 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12584 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12585 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12586 * Note that we consider a flick as a line-gesture that should be completed
12587 * in flick-time-limit as defined in @ref Config.
12589 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12591 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12594 * Gesture Layer Tweaks:
12596 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12597 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12599 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12600 * so gesture starts when user touches (a *DOWN event) touch-surface
12601 * and ends when no fingers touches surface (a *UP event).
12605 * @enum _Elm_Gesture_Types
12606 * Enum of supported gesture types.
12607 * @ingroup Elm_Gesture_Layer
12609 enum _Elm_Gesture_Types
12611 ELM_GESTURE_FIRST = 0,
12613 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12614 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12615 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12616 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12618 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12620 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12621 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12623 ELM_GESTURE_ZOOM, /**< Zoom */
12624 ELM_GESTURE_ROTATE, /**< Rotate */
12630 * @typedef Elm_Gesture_Types
12631 * gesture types enum
12632 * @ingroup Elm_Gesture_Layer
12634 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12637 * @enum _Elm_Gesture_State
12638 * Enum of gesture states.
12639 * @ingroup Elm_Gesture_Layer
12641 enum _Elm_Gesture_State
12643 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12644 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12645 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12646 ELM_GESTURE_STATE_END, /**< Gesture completed */
12647 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12651 * @typedef Elm_Gesture_State
12652 * gesture states enum
12653 * @ingroup Elm_Gesture_Layer
12655 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12658 * @struct _Elm_Gesture_Taps_Info
12659 * Struct holds taps info for user
12660 * @ingroup Elm_Gesture_Layer
12662 struct _Elm_Gesture_Taps_Info
12664 Evas_Coord x, y; /**< Holds center point between fingers */
12665 unsigned int n; /**< Number of fingers tapped */
12666 unsigned int timestamp; /**< event timestamp */
12670 * @typedef Elm_Gesture_Taps_Info
12671 * holds taps info for user
12672 * @ingroup Elm_Gesture_Layer
12674 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12677 * @struct _Elm_Gesture_Momentum_Info
12678 * Struct holds momentum info for user
12679 * x1 and y1 are not necessarily in sync
12680 * x1 holds x value of x direction starting point
12681 * and same holds for y1.
12682 * This is noticeable when doing V-shape movement
12683 * @ingroup Elm_Gesture_Layer
12685 struct _Elm_Gesture_Momentum_Info
12686 { /* Report line ends, timestamps, and momentum computed */
12687 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12688 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12689 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12690 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12692 unsigned int tx; /**< Timestamp of start of final x-swipe */
12693 unsigned int ty; /**< Timestamp of start of final y-swipe */
12695 Evas_Coord mx; /**< Momentum on X */
12696 Evas_Coord my; /**< Momentum on Y */
12698 unsigned int n; /**< Number of fingers */
12702 * @typedef Elm_Gesture_Momentum_Info
12703 * holds momentum info for user
12704 * @ingroup Elm_Gesture_Layer
12706 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12709 * @struct _Elm_Gesture_Line_Info
12710 * Struct holds line info for user
12711 * @ingroup Elm_Gesture_Layer
12713 struct _Elm_Gesture_Line_Info
12714 { /* Report line ends, timestamps, and momentum computed */
12715 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12716 double angle; /**< Angle (direction) of lines */
12720 * @typedef Elm_Gesture_Line_Info
12721 * Holds line info for user
12722 * @ingroup Elm_Gesture_Layer
12724 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12727 * @struct _Elm_Gesture_Zoom_Info
12728 * Struct holds zoom info for user
12729 * @ingroup Elm_Gesture_Layer
12731 struct _Elm_Gesture_Zoom_Info
12733 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12734 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12735 double zoom; /**< Zoom value: 1.0 means no zoom */
12736 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12740 * @typedef Elm_Gesture_Zoom_Info
12741 * Holds zoom info for user
12742 * @ingroup Elm_Gesture_Layer
12744 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12747 * @struct _Elm_Gesture_Rotate_Info
12748 * Struct holds rotation info for user
12749 * @ingroup Elm_Gesture_Layer
12751 struct _Elm_Gesture_Rotate_Info
12753 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12754 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12755 double base_angle; /**< Holds start-angle */
12756 double angle; /**< Rotation value: 0.0 means no rotation */
12757 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12761 * @typedef Elm_Gesture_Rotate_Info
12762 * Holds rotation info for user
12763 * @ingroup Elm_Gesture_Layer
12765 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12768 * @typedef Elm_Gesture_Event_Cb
12769 * User callback used to stream gesture info from gesture layer
12770 * @param data user data
12771 * @param event_info gesture report info
12772 * Returns a flag field to be applied on the causing event.
12773 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12774 * upon the event, in an irreversible way.
12776 * @ingroup Elm_Gesture_Layer
12778 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12781 * Use function to set callbacks to be notified about
12782 * change of state of gesture.
12783 * When a user registers a callback with this function
12784 * this means this gesture has to be tested.
12786 * When ALL callbacks for a gesture are set to NULL
12787 * it means user isn't interested in gesture-state
12788 * and it will not be tested.
12790 * @param obj Pointer to gesture-layer.
12791 * @param idx The gesture you would like to track its state.
12792 * @param cb callback function pointer.
12793 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12794 * @param data user info to be sent to callback (usually, Smart Data)
12796 * @ingroup Elm_Gesture_Layer
12798 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);
12801 * Call this function to get repeat-events settings.
12803 * @param obj Pointer to gesture-layer.
12805 * @return repeat events settings.
12806 * @see elm_gesture_layer_hold_events_set()
12807 * @ingroup Elm_Gesture_Layer
12809 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12812 * This function called in order to make gesture-layer repeat events.
12813 * Set this of you like to get the raw events only if gestures were not detected.
12814 * Clear this if you like gesture layer to fwd events as testing gestures.
12816 * @param obj Pointer to gesture-layer.
12817 * @param r Repeat: TRUE/FALSE
12819 * @ingroup Elm_Gesture_Layer
12821 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12824 * This function sets step-value for zoom action.
12825 * Set step to any positive value.
12826 * Cancel step setting by setting to 0.0
12828 * @param obj Pointer to gesture-layer.
12829 * @param s new zoom step value.
12831 * @ingroup Elm_Gesture_Layer
12833 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12836 * This function sets step-value for rotate action.
12837 * Set step to any positive value.
12838 * Cancel step setting by setting to 0.0
12840 * @param obj Pointer to gesture-layer.
12841 * @param s new roatate step value.
12843 * @ingroup Elm_Gesture_Layer
12845 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12848 * This function called to attach gesture-layer to an Evas_Object.
12849 * @param obj Pointer to gesture-layer.
12850 * @param t Pointer to underlying object (AKA Target)
12852 * @return TRUE, FALSE on success, failure.
12854 * @ingroup Elm_Gesture_Layer
12856 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12859 * Call this function to construct a new gesture-layer object.
12860 * This does not activate the gesture layer. You have to
12861 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12863 * @param parent the parent object.
12865 * @return Pointer to new gesture-layer object.
12867 * @ingroup Elm_Gesture_Layer
12869 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12872 * @defgroup Thumb Thumb
12874 * @image html img/widget/thumb/preview-00.png
12875 * @image latex img/widget/thumb/preview-00.eps
12877 * A thumb object is used for displaying the thumbnail of an image or video.
12878 * You must have compiled Elementary with Ethumb_Client support and the DBus
12879 * service must be present and auto-activated in order to have thumbnails to
12882 * Once the thumbnail object becomes visible, it will check if there is a
12883 * previously generated thumbnail image for the file set on it. If not, it
12884 * will start generating this thumbnail.
12886 * Different config settings will cause different thumbnails to be generated
12887 * even on the same file.
12889 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12890 * Ethumb documentation to change this path, and to see other configuration
12893 * Signals that you can add callbacks for are:
12895 * - "clicked" - This is called when a user has clicked the thumb without dragging
12897 * - "clicked,double" - This is called when a user has double-clicked the thumb.
12898 * - "press" - This is called when a user has pressed down the thumb.
12899 * - "generate,start" - The thumbnail generation started.
12900 * - "generate,stop" - The generation process stopped.
12901 * - "generate,error" - The generation failed.
12902 * - "load,error" - The thumbnail image loading failed.
12904 * available styles:
12908 * An example of use of thumbnail:
12910 * - @ref thumb_example_01
12914 * @addtogroup Thumb
12919 * @enum _Elm_Thumb_Animation_Setting
12920 * @typedef Elm_Thumb_Animation_Setting
12922 * Used to set if a video thumbnail is animating or not.
12926 typedef enum _Elm_Thumb_Animation_Setting
12928 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12929 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
12930 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
12931 ELM_THUMB_ANIMATION_LAST
12932 } Elm_Thumb_Animation_Setting;
12935 * Add a new thumb object to the parent.
12937 * @param parent The parent object.
12938 * @return The new object or NULL if it cannot be created.
12940 * @see elm_thumb_file_set()
12941 * @see elm_thumb_ethumb_client_get()
12945 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12947 * Reload thumbnail if it was generated before.
12949 * @param obj The thumb object to reload
12951 * This is useful if the ethumb client configuration changed, like its
12952 * size, aspect or any other property one set in the handle returned
12953 * by elm_thumb_ethumb_client_get().
12955 * If the options didn't change, the thumbnail won't be generated again, but
12956 * the old one will still be used.
12958 * @see elm_thumb_file_set()
12962 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12964 * Set the file that will be used as thumbnail.
12966 * @param obj The thumb object.
12967 * @param file The path to file that will be used as thumb.
12968 * @param key The key used in case of an EET file.
12970 * The file can be an image or a video (in that case, acceptable extensions are:
12971 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12972 * function elm_thumb_animate().
12974 * @see elm_thumb_file_get()
12975 * @see elm_thumb_reload()
12976 * @see elm_thumb_animate()
12980 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12982 * Get the image or video path and key used to generate the thumbnail.
12984 * @param obj The thumb object.
12985 * @param file Pointer to filename.
12986 * @param key Pointer to key.
12988 * @see elm_thumb_file_set()
12989 * @see elm_thumb_path_get()
12993 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12995 * Get the path and key to the image or video generated by ethumb.
12997 * One just need to make sure that the thumbnail was generated before getting
12998 * its path; otherwise, the path will be NULL. One way to do that is by asking
12999 * for the path when/after the "generate,stop" smart callback is called.
13001 * @param obj The thumb object.
13002 * @param file Pointer to thumb path.
13003 * @param key Pointer to thumb key.
13005 * @see elm_thumb_file_get()
13009 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13011 * Set the animation state for the thumb object. If its content is an animated
13012 * video, you may start/stop the animation or tell it to play continuously and
13015 * @param obj The thumb object.
13016 * @param setting The animation setting.
13018 * @see elm_thumb_file_set()
13022 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13024 * Get the animation state for the thumb object.
13026 * @param obj The thumb object.
13027 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13030 * @see elm_thumb_animate_set()
13034 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13036 * Get the ethumb_client handle so custom configuration can be made.
13038 * @return Ethumb_Client instance or NULL.
13040 * This must be called before the objects are created to be sure no object is
13041 * visible and no generation started.
13043 * Example of usage:
13046 * #include <Elementary.h>
13047 * #ifndef ELM_LIB_QUICKLAUNCH
13049 * elm_main(int argc, char **argv)
13051 * Ethumb_Client *client;
13053 * elm_need_ethumb();
13057 * client = elm_thumb_ethumb_client_get();
13060 * ERR("could not get ethumb_client");
13063 * ethumb_client_size_set(client, 100, 100);
13064 * ethumb_client_crop_align_set(client, 0.5, 0.5);
13067 * // Create elm_thumb objects here
13077 * @note There's only one client handle for Ethumb, so once a configuration
13078 * change is done to it, any other request for thumbnails (for any thumbnail
13079 * object) will use that configuration. Thus, this configuration is global.
13083 EAPI void *elm_thumb_ethumb_client_get(void);
13085 * Get the ethumb_client connection state.
13087 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13090 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
13092 * Make the thumbnail 'editable'.
13094 * @param obj Thumb object.
13095 * @param set Turn on or off editability. Default is @c EINA_FALSE.
13097 * This means the thumbnail is a valid drag target for drag and drop, and can be
13098 * cut or pasted too.
13100 * @see elm_thumb_editable_get()
13104 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13105 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13107 * Make the thumbnail 'editable'.
13109 * @param obj Thumb object.
13110 * @return Editability.
13112 * This means the thumbnail is a valid drag target for drag and drop, and can be
13113 * cut or pasted too.
13115 * @see elm_thumb_editable_set()
13119 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13126 * @defgroup Web Web
13128 * @image html img/widget/web/preview-00.png
13129 * @image latex img/widget/web/preview-00.eps
13131 * A web object is used for displaying web pages (HTML/CSS/JS)
13132 * using WebKit-EFL. You must have compiled Elementary with
13135 * Signals that you can add callbacks for are:
13136 * @li "download,request": A file download has been requested. Event info is
13137 * a pointer to a Elm_Web_Download
13138 * @li "editorclient,contents,changed": Editor client's contents changed
13139 * @li "editorclient,selection,changed": Editor client's selection changed
13140 * @li "frame,created": A new frame was created. Event info is an
13141 * Evas_Object which can be handled with WebKit's ewk_frame API
13142 * @li "icon,received": An icon was received by the main frame
13143 * @li "inputmethod,changed": Input method changed. Event info is an
13144 * Eina_Bool indicating whether it's enabled or not
13145 * @li "js,windowobject,clear": JS window object has been cleared
13146 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13147 * is a char *link[2], where the first string contains the URL the link
13148 * points to, and the second one the title of the link
13149 * @li "link,hover,out": Mouse cursor left the link
13150 * @li "load,document,finished": Loading of a document finished. Event info
13151 * is the frame that finished loading
13152 * @li "load,error": Load failed. Event info is a pointer to
13153 * Elm_Web_Frame_Load_Error
13154 * @li "load,finished": Load finished. Event info is NULL on success, on
13155 * error it's a pointer to Elm_Web_Frame_Load_Error
13156 * @li "load,newwindow,show": A new window was created and is ready to be
13158 * @li "load,progress": Overall load progress. Event info is a pointer to
13159 * a double containing a value between 0.0 and 1.0
13160 * @li "load,provisional": Started provisional load
13161 * @li "load,started": Loading of a document started
13162 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13163 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13164 * the menubar is visible, or EINA_FALSE in case it's not
13165 * @li "menubar,visible,set": Informs menubar visibility. Event info is
13166 * an Eina_Bool indicating the visibility
13167 * @li "popup,created": A dropdown widget was activated, requesting its
13168 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13169 * @li "popup,willdelete": The web object is ready to destroy the popup
13170 * object created. Event info is a pointer to Elm_Web_Menu
13171 * @li "ready": Page is fully loaded
13172 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13173 * info is a pointer to Eina_Bool where the visibility state should be set
13174 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13175 * is an Eina_Bool with the visibility state set
13176 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13177 * a string with the new text
13178 * @li "statusbar,visible,get": Queries visibility of the status bar.
13179 * Event info is a pointer to Eina_Bool where the visibility state should be
13181 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13182 * an Eina_Bool with the visibility value
13183 * @li "title,changed": Title of the main frame changed. Event info is a
13184 * string with the new title
13185 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13186 * is a pointer to Eina_Bool where the visibility state should be set
13187 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13188 * info is an Eina_Bool with the visibility state
13189 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13190 * a string with the text to show
13191 * @li "uri,changed": URI of the main frame changed. Event info is a string
13193 * @li "view,resized": The web object internal's view changed sized
13194 * @li "windows,close,request": A JavaScript request to close the current
13195 * window was requested
13196 * @li "zoom,animated,end": Animated zoom finished
13198 * available styles:
13201 * An example of use of web:
13203 * - @ref web_example_01 TBD
13212 * Structure used to report load errors.
13214 * Load errors are reported as signal by elm_web. All the strings are
13215 * temporary references and should @b not be used after the signal
13216 * callback returns. If it's required, make copies with strdup() or
13217 * eina_stringshare_add() (they are not even guaranteed to be
13218 * stringshared, so must use eina_stringshare_add() and not
13219 * eina_stringshare_ref()).
13221 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13223 * Structure used to report load errors.
13225 * Load errors are reported as signal by elm_web. All the strings are
13226 * temporary references and should @b not be used after the signal
13227 * callback returns. If it's required, make copies with strdup() or
13228 * eina_stringshare_add() (they are not even guaranteed to be
13229 * stringshared, so must use eina_stringshare_add() and not
13230 * eina_stringshare_ref()).
13232 struct _Elm_Web_Frame_Load_Error
13234 int code; /**< Numeric error code */
13235 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13236 const char *domain; /**< Error domain name */
13237 const char *description; /**< Error description (already localized) */
13238 const char *failing_url; /**< The URL that failed to load */
13239 Evas_Object *frame; /**< Frame object that produced the error */
13243 * The possibles types that the items in a menu can be
13245 typedef enum _Elm_Web_Menu_Item_Type
13247 ELM_WEB_MENU_SEPARATOR,
13248 ELM_WEB_MENU_GROUP,
13249 ELM_WEB_MENU_OPTION
13250 } Elm_Web_Menu_Item_Type;
13253 * Structure describing the items in a menu
13255 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13257 * Structure describing the items in a menu
13259 struct _Elm_Web_Menu_Item
13261 const char *text; /**< The text for the item */
13262 Elm_Web_Menu_Item_Type type; /**< The type of the item */
13266 * Structure describing the menu of a popup
13268 * This structure will be passed as the @c event_info for the "popup,create"
13269 * signal, which is emitted when a dropdown menu is opened. Users wanting
13270 * to handle these popups by themselves should listen to this signal and
13271 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13272 * property as @c EINA_FALSE means that the user will not handle the popup
13273 * and the default implementation will be used.
13275 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13276 * will be emitted to notify the user that it can destroy any objects and
13277 * free all data related to it.
13279 * @see elm_web_popup_selected_set()
13280 * @see elm_web_popup_destroy()
13282 typedef struct _Elm_Web_Menu Elm_Web_Menu;
13284 * Structure describing the menu of a popup
13286 * This structure will be passed as the @c event_info for the "popup,create"
13287 * signal, which is emitted when a dropdown menu is opened. Users wanting
13288 * to handle these popups by themselves should listen to this signal and
13289 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13290 * property as @c EINA_FALSE means that the user will not handle the popup
13291 * and the default implementation will be used.
13293 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13294 * will be emitted to notify the user that it can destroy any objects and
13295 * free all data related to it.
13297 * @see elm_web_popup_selected_set()
13298 * @see elm_web_popup_destroy()
13300 struct _Elm_Web_Menu
13302 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13303 int x; /**< The X position of the popup, relative to the elm_web object */
13304 int y; /**< The Y position of the popup, relative to the elm_web object */
13305 int width; /**< Width of the popup menu */
13306 int height; /**< Height of the popup menu */
13308 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. */
13311 typedef struct _Elm_Web_Download Elm_Web_Download;
13312 struct _Elm_Web_Download
13318 * Types of zoom available.
13320 typedef enum _Elm_Web_Zoom_Mode
13322 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13323 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13324 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13325 ELM_WEB_ZOOM_MODE_LAST
13326 } Elm_Web_Zoom_Mode;
13328 * Opaque handler containing the features (such as statusbar, menubar, etc)
13329 * that are to be set on a newly requested window.
13331 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13333 * Callback type for the create_window hook.
13335 * The function parameters are:
13336 * @li @p data User data pointer set when setting the hook function
13337 * @li @p obj The elm_web object requesting the new window
13338 * @li @p js Set to @c EINA_TRUE if the request was originated from
13339 * JavaScript. @c EINA_FALSE otherwise.
13340 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13341 * the features requested for the new window.
13343 * The returned value of the function should be the @c elm_web widget where
13344 * the request will be loaded. That is, if a new window or tab is created,
13345 * the elm_web widget in it should be returned, and @b NOT the window
13347 * Returning @c NULL should cancel the request.
13349 * @see elm_web_window_create_hook_set()
13351 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13353 * Callback type for the JS alert hook.
13355 * The function parameters are:
13356 * @li @p data User data pointer set when setting the hook function
13357 * @li @p obj The elm_web object requesting the new window
13358 * @li @p message The message to show in the alert dialog
13360 * The function should return the object representing the alert dialog.
13361 * Elm_Web will run a second main loop to handle the dialog and normal
13362 * flow of the application will be restored when the object is deleted, so
13363 * the user should handle the popup properly in order to delete the object
13364 * when the action is finished.
13365 * If the function returns @c NULL the popup will be ignored.
13367 * @see elm_web_dialog_alert_hook_set()
13369 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13371 * Callback type for the JS confirm hook.
13373 * The function parameters are:
13374 * @li @p data User data pointer set when setting the hook function
13375 * @li @p obj The elm_web object requesting the new window
13376 * @li @p message The message to show in the confirm dialog
13377 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13378 * the user selected @c Ok, @c EINA_FALSE otherwise.
13380 * The function should return the object representing the confirm dialog.
13381 * Elm_Web will run a second main loop to handle the dialog and normal
13382 * flow of the application will be restored when the object is deleted, so
13383 * the user should handle the popup properly in order to delete the object
13384 * when the action is finished.
13385 * If the function returns @c NULL the popup will be ignored.
13387 * @see elm_web_dialog_confirm_hook_set()
13389 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13391 * Callback type for the JS prompt hook.
13393 * The function parameters are:
13394 * @li @p data User data pointer set when setting the hook function
13395 * @li @p obj The elm_web object requesting the new window
13396 * @li @p message The message to show in the prompt dialog
13397 * @li @p def_value The default value to present the user in the entry
13398 * @li @p value Pointer where to store the value given by the user. Must
13399 * be a malloc'ed string or @c NULL if the user cancelled the popup.
13400 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13401 * the user selected @c Ok, @c EINA_FALSE otherwise.
13403 * The function should return the object representing the prompt dialog.
13404 * Elm_Web will run a second main loop to handle the dialog and normal
13405 * flow of the application will be restored when the object is deleted, so
13406 * the user should handle the popup properly in order to delete the object
13407 * when the action is finished.
13408 * If the function returns @c NULL the popup will be ignored.
13410 * @see elm_web_dialog_prompt_hook_set()
13412 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13414 * Callback type for the JS file selector hook.
13416 * The function parameters are:
13417 * @li @p data User data pointer set when setting the hook function
13418 * @li @p obj The elm_web object requesting the new window
13419 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13420 * @li @p accept_types Mime types accepted
13421 * @li @p selected Pointer where to store the list of malloc'ed strings
13422 * containing the path to each file selected. Must be @c NULL if the file
13423 * dialog is cancelled
13424 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13425 * the user selected @c Ok, @c EINA_FALSE otherwise.
13427 * The function should return the object representing the file selector
13429 * Elm_Web will run a second main loop to handle the dialog and normal
13430 * flow of the application will be restored when the object is deleted, so
13431 * the user should handle the popup properly in order to delete the object
13432 * when the action is finished.
13433 * If the function returns @c NULL the popup will be ignored.
13435 * @see elm_web_dialog_file selector_hook_set()
13437 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);
13439 * Callback type for the JS console message hook.
13441 * When a console message is added from JavaScript, any set function to the
13442 * console message hook will be called for the user to handle. There is no
13443 * default implementation of this hook.
13445 * The function parameters are:
13446 * @li @p data User data pointer set when setting the hook function
13447 * @li @p obj The elm_web object that originated the message
13448 * @li @p message The message sent
13449 * @li @p line_number The line number
13450 * @li @p source_id Source id
13452 * @see elm_web_console_message_hook_set()
13454 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13456 * Add a new web object to the parent.
13458 * @param parent The parent object.
13459 * @return The new object or NULL if it cannot be created.
13461 * @see elm_web_uri_set()
13462 * @see elm_web_webkit_view_get()
13464 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13467 * Get internal ewk_view object from web object.
13469 * Elementary may not provide some low level features of EWebKit,
13470 * instead of cluttering the API with proxy methods we opted to
13471 * return the internal reference. Be careful using it as it may
13472 * interfere with elm_web behavior.
13474 * @param obj The web object.
13475 * @return The internal ewk_view object or NULL if it does not
13476 * exist. (Failure to create or Elementary compiled without
13479 * @see elm_web_add()
13481 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13484 * Sets the function to call when a new window is requested
13486 * This hook will be called when a request to create a new window is
13487 * issued from the web page loaded.
13488 * There is no default implementation for this feature, so leaving this
13489 * unset or passing @c NULL in @p func will prevent new windows from
13492 * @param obj The web object where to set the hook function
13493 * @param func The hook function to be called when a window is requested
13494 * @param data User data
13496 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13498 * Sets the function to call when an alert dialog
13500 * This hook will be called when a JavaScript alert dialog is requested.
13501 * If no function is set or @c NULL is passed in @p func, the default
13502 * implementation will take place.
13504 * @param obj The web object where to set the hook function
13505 * @param func The callback function to be used
13506 * @param data User data
13508 * @see elm_web_inwin_mode_set()
13510 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13512 * Sets the function to call when an confirm dialog
13514 * This hook will be called when a JavaScript confirm dialog is requested.
13515 * If no function is set or @c NULL is passed in @p func, the default
13516 * implementation will take place.
13518 * @param obj The web object where to set the hook function
13519 * @param func The callback function to be used
13520 * @param data User data
13522 * @see elm_web_inwin_mode_set()
13524 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13526 * Sets the function to call when an prompt dialog
13528 * This hook will be called when a JavaScript prompt dialog is requested.
13529 * If no function is set or @c NULL is passed in @p func, the default
13530 * implementation will take place.
13532 * @param obj The web object where to set the hook function
13533 * @param func The callback function to be used
13534 * @param data User data
13536 * @see elm_web_inwin_mode_set()
13538 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13540 * Sets the function to call when an file selector dialog
13542 * This hook will be called when a JavaScript file selector dialog is
13544 * If no function is set or @c NULL is passed in @p func, the default
13545 * implementation will take place.
13547 * @param obj The web object where to set the hook function
13548 * @param func The callback function to be used
13549 * @param data User data
13551 * @see elm_web_inwin_mode_set()
13553 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13555 * Sets the function to call when a console message is emitted from JS
13557 * This hook will be called when a console message is emitted from
13558 * JavaScript. There is no default implementation for this feature.
13560 * @param obj The web object where to set the hook function
13561 * @param func The callback function to be used
13562 * @param data User data
13564 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13566 * Gets the status of the tab propagation
13568 * @param obj The web object to query
13569 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13571 * @see elm_web_tab_propagate_set()
13573 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
13575 * Sets whether to use tab propagation
13577 * If tab propagation is enabled, whenever the user presses the Tab key,
13578 * Elementary will handle it and switch focus to the next widget.
13579 * The default value is disabled, where WebKit will handle the Tab key to
13580 * cycle focus though its internal objects, jumping to the next widget
13581 * only when that cycle ends.
13583 * @param obj The web object
13584 * @param propagate Whether to propagate Tab keys to Elementary or not
13586 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13588 * Sets the URI for the web object
13590 * It must be a full URI, with resource included, in the form
13591 * http://www.enlightenment.org or file:///tmp/something.html
13593 * @param obj The web object
13594 * @param uri The URI to set
13595 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13597 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
13599 * Gets the current URI for the object
13601 * The returned string must not be freed and is guaranteed to be
13604 * @param obj The web object
13605 * @return A stringshared internal string with the current URI, or NULL on
13608 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
13610 * Gets the current title
13612 * The returned string must not be freed and is guaranteed to be
13615 * @param obj The web object
13616 * @return A stringshared internal string with the current title, or NULL on
13619 EAPI const char *elm_web_title_get(const Evas_Object *obj);
13621 * Sets the background color to be used by the web object
13623 * This is the color that will be used by default when the loaded page
13624 * does not set it's own. Color values are pre-multiplied.
13626 * @param obj The web object
13627 * @param r Red component
13628 * @param g Green component
13629 * @param b Blue component
13630 * @param a Alpha component
13632 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13634 * Gets the background color to be used by the web object
13636 * This is the color that will be used by default when the loaded page
13637 * does not set it's own. Color values are pre-multiplied.
13639 * @param obj The web object
13640 * @param r Red component
13641 * @param g Green component
13642 * @param b Blue component
13643 * @param a Alpha component
13645 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13647 * Gets a copy of the currently selected text
13649 * The string returned must be freed by the user when it's done with it.
13651 * @param obj The web object
13652 * @return A newly allocated string, or NULL if nothing is selected or an
13655 EAPI char *elm_view_selection_get(const Evas_Object *obj);
13657 * Tells the web object which index in the currently open popup was selected
13659 * When the user handles the popup creation from the "popup,created" signal,
13660 * it needs to tell the web object which item was selected by calling this
13661 * function with the index corresponding to the item.
13663 * @param obj The web object
13664 * @param index The index selected
13666 * @see elm_web_popup_destroy()
13668 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
13670 * Dismisses an open dropdown popup
13672 * When the popup from a dropdown widget is to be dismissed, either after
13673 * selecting an option or to cancel it, this function must be called, which
13674 * will later emit an "popup,willdelete" signal to notify the user that
13675 * any memory and objects related to this popup can be freed.
13677 * @param obj The web object
13678 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13679 * if there was no menu to destroy
13681 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
13683 * Searches the given string in a document.
13685 * @param obj The web object where to search the text
13686 * @param string String to search
13687 * @param case_sensitive If search should be case sensitive or not
13688 * @param forward If search is from cursor and on or backwards
13689 * @param wrap If search should wrap at the end
13691 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13694 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13696 * Marks matches of the given string in a document.
13698 * @param obj The web object where to search text
13699 * @param string String to match
13700 * @param case_sensitive If match should be case sensitive or not
13701 * @param highlight If matches should be highlighted
13702 * @param limit Maximum amount of matches, or zero to unlimited
13704 * @return number of matched @a string
13706 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13708 * Clears all marked matches in the document
13710 * @param obj The web object
13712 * @return EINA_TRUE on success, EINA_FALSE otherwise
13714 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
13716 * Sets whether to highlight the matched marks
13718 * If enabled, marks set with elm_web_text_matches_mark() will be
13721 * @param obj The web object
13722 * @param highlight Whether to highlight the marks or not
13724 * @return EINA_TRUE on success, EINA_FALSE otherwise
13726 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13728 * Gets whether highlighting marks is enabled
13730 * @param The web object
13732 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13735 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
13737 * Gets the overall loading progress of the page
13739 * Returns the estimated loading progress of the page, with a value between
13740 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13741 * included in the page.
13743 * @param The web object
13745 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13748 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
13750 * Stops loading the current page
13752 * Cancels the loading of the current page in the web object. This will
13753 * cause a "load,error" signal to be emitted, with the is_cancellation
13754 * flag set to EINA_TRUE.
13756 * @param obj The web object
13758 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13760 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
13762 * Requests a reload of the current document in the object
13764 * @param obj The web object
13766 * @return EINA_TRUE on success, EINA_FALSE otherwise
13768 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
13770 * Requests a reload of the current document, avoiding any existing caches
13772 * @param obj The web object
13774 * @return EINA_TRUE on success, EINA_FALSE otherwise
13776 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
13778 * Goes back one step in the browsing history
13780 * This is equivalent to calling elm_web_object_navigate(obj, -1);
13782 * @param obj The web object
13784 * @return EINA_TRUE on success, EINA_FALSE otherwise
13786 * @see elm_web_history_enable_set()
13787 * @see elm_web_back_possible()
13788 * @see elm_web_forward()
13789 * @see elm_web_navigate()
13791 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
13793 * Goes forward one step in the browsing history
13795 * This is equivalent to calling elm_web_object_navigate(obj, 1);
13797 * @param obj The web object
13799 * @return EINA_TRUE on success, EINA_FALSE otherwise
13801 * @see elm_web_history_enable_set()
13802 * @see elm_web_forward_possible()
13803 * @see elm_web_back()
13804 * @see elm_web_navigate()
13806 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
13808 * Jumps the given number of steps in the browsing history
13810 * The @p steps value can be a negative integer to back in history, or a
13811 * positive to move forward.
13813 * @param obj The web object
13814 * @param steps The number of steps to jump
13816 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13817 * history exists to jump the given number of steps
13819 * @see elm_web_history_enable_set()
13820 * @see elm_web_navigate_possible()
13821 * @see elm_web_back()
13822 * @see elm_web_forward()
13824 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
13826 * Queries whether it's possible to go back in history
13828 * @param obj The web object
13830 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13833 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
13835 * Queries whether it's possible to go forward in history
13837 * @param obj The web object
13839 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13842 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
13844 * Queries whether it's possible to jump the given number of steps
13846 * The @p steps value can be a negative integer to back in history, or a
13847 * positive to move forward.
13849 * @param obj The web object
13850 * @param steps The number of steps to check for
13852 * @return EINA_TRUE if enough history exists to perform the given jump,
13853 * EINA_FALSE otherwise
13855 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
13857 * Gets whether browsing history is enabled for the given object
13859 * @param obj The web object
13861 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
13863 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
13865 * Enables or disables the browsing history
13867 * @param obj The web object
13868 * @param enable Whether to enable or disable the browsing history
13870 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
13872 * Sets the zoom level of the web object
13874 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
13875 * values meaning zoom in and lower meaning zoom out. This function will
13876 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
13877 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
13879 * @param obj The web object
13880 * @param zoom The zoom level to set
13882 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
13884 * Gets the current zoom level set on the web object
13886 * Note that this is the zoom level set on the web object and not that
13887 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
13888 * the two zoom levels should match, but for the other two modes the
13889 * Webkit zoom is calculated internally to match the chosen mode without
13890 * changing the zoom level set for the web object.
13892 * @param obj The web object
13894 * @return The zoom level set on the object
13896 EAPI double elm_web_zoom_get(const Evas_Object *obj);
13898 * Sets the zoom mode to use
13900 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
13901 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
13903 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
13904 * with the elm_web_zoom_set() function.
13905 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
13906 * make sure the entirety of the web object's contents are shown.
13907 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
13908 * fit the contents in the web object's size, without leaving any space
13911 * @param obj The web object
13912 * @param mode The mode to set
13914 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
13916 * Gets the currently set zoom mode
13918 * @param obj The web object
13920 * @return The current zoom mode set for the object, or
13921 * ::ELM_WEB_ZOOM_MODE_LAST on error
13923 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
13925 * Shows the given region in the web object
13927 * @param obj The web object
13928 * @param x The x coordinate of the region to show
13929 * @param y The y coordinate of the region to show
13930 * @param w The width of the region to show
13931 * @param h The height of the region to show
13933 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
13935 * Brings in the region to the visible area
13937 * Like elm_web_region_show(), but it animates the scrolling of the object
13940 * @param obj The web object
13941 * @param x The x coordinate of the region to show
13942 * @param y The y coordinate of the region to show
13943 * @param w The width of the region to show
13944 * @param h The height of the region to show
13946 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
13948 * Sets the default dialogs to use an Inwin instead of a normal window
13950 * If set, then the default implementation for the JavaScript dialogs and
13951 * file selector will be opened in an Inwin. Otherwise they will use a
13952 * normal separated window.
13954 * @param obj The web object
13955 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
13957 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
13959 * Gets whether Inwin mode is set for the current object
13961 * @param obj The web object
13963 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
13965 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
13967 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
13968 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
13969 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);
13970 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
13977 * @defgroup Hoversel Hoversel
13979 * @image html img/widget/hoversel/preview-00.png
13980 * @image latex img/widget/hoversel/preview-00.eps
13982 * A hoversel is a button that pops up a list of items (automatically
13983 * choosing the direction to display) that have a label and, optionally, an
13984 * icon to select from. It is a convenience widget to avoid the need to do
13985 * all the piecing together yourself. It is intended for a small number of
13986 * items in the hoversel menu (no more than 8), though is capable of many
13989 * Signals that you can add callbacks for are:
13990 * "clicked" - the user clicked the hoversel button and popped up the sel
13991 * "selected" - an item in the hoversel list is selected. event_info is the item
13992 * "dismissed" - the hover is dismissed
13994 * See @ref tutorial_hoversel for an example.
13997 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
13999 * @brief Add a new Hoversel object
14001 * @param parent The parent object
14002 * @return The new object or NULL if it cannot be created
14004 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14006 * @brief This sets the hoversel to expand horizontally.
14008 * @param obj The hoversel object
14009 * @param horizontal If true, the hover will expand horizontally to the
14012 * @note The initial button will display horizontally regardless of this
14015 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14017 * @brief This returns whether the hoversel is set to expand horizontally.
14019 * @param obj The hoversel object
14020 * @return If true, the hover will expand horizontally to the right.
14022 * @see elm_hoversel_horizontal_set()
14024 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14026 * @brief Set the Hover parent
14028 * @param obj The hoversel object
14029 * @param parent The parent to use
14031 * Sets the hover parent object, the area that will be darkened when the
14032 * hoversel is clicked. Should probably be the window that the hoversel is
14033 * in. See @ref Hover objects for more information.
14035 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14037 * @brief Get the Hover parent
14039 * @param obj The hoversel object
14040 * @return The used parent
14042 * Gets the hover parent object.
14044 * @see elm_hoversel_hover_parent_set()
14046 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14048 * @brief Set the hoversel button label
14050 * @param obj The hoversel object
14051 * @param label The label text.
14053 * This sets the label of the button that is always visible (before it is
14054 * clicked and expanded).
14056 * @deprecated elm_object_text_set()
14058 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14060 * @brief Get the hoversel button label
14062 * @param obj The hoversel object
14063 * @return The label text.
14065 * @deprecated elm_object_text_get()
14067 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14069 * @brief Set the icon of the hoversel button
14071 * @param obj The hoversel object
14072 * @param icon The icon object
14074 * Sets the icon of the button that is always visible (before it is clicked
14075 * and expanded). Once the icon object is set, a previously set one will be
14076 * deleted, if you want to keep that old content object, use the
14077 * elm_hoversel_icon_unset() function.
14079 * @see elm_object_content_set() for the button widget
14081 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14083 * @brief Get the icon of the hoversel button
14085 * @param obj The hoversel object
14086 * @return The icon object
14088 * Get the icon of the button that is always visible (before it is clicked
14089 * and expanded). Also see elm_object_content_get() for the button widget.
14091 * @see elm_hoversel_icon_set()
14093 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14095 * @brief Get and unparent the icon of the hoversel button
14097 * @param obj The hoversel object
14098 * @return The icon object that was being used
14100 * Unparent and return the icon of the button that is always visible
14101 * (before it is clicked and expanded).
14103 * @see elm_hoversel_icon_set()
14104 * @see elm_object_content_unset() for the button widget
14106 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14108 * @brief This triggers the hoversel popup from code, the same as if the user
14109 * had clicked the button.
14111 * @param obj The hoversel object
14113 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14115 * @brief This dismisses the hoversel popup as if the user had clicked
14116 * outside the hover.
14118 * @param obj The hoversel object
14120 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14122 * @brief Returns whether the hoversel is expanded.
14124 * @param obj The hoversel object
14125 * @return This will return EINA_TRUE if the hoversel is expanded or
14126 * EINA_FALSE if it is not expanded.
14128 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14130 * @brief This will remove all the children items from the hoversel.
14132 * @param obj The hoversel object
14134 * @warning Should @b not be called while the hoversel is active; use
14135 * elm_hoversel_expanded_get() to check first.
14137 * @see elm_hoversel_item_del_cb_set()
14138 * @see elm_hoversel_item_del()
14140 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14142 * @brief Get the list of items within the given hoversel.
14144 * @param obj The hoversel object
14145 * @return Returns a list of Elm_Hoversel_Item*
14147 * @see elm_hoversel_item_add()
14149 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14151 * @brief Add an item to the hoversel button
14153 * @param obj The hoversel object
14154 * @param label The text label to use for the item (NULL if not desired)
14155 * @param icon_file An image file path on disk to use for the icon or standard
14156 * icon name (NULL if not desired)
14157 * @param icon_type The icon type if relevant
14158 * @param func Convenience function to call when this item is selected
14159 * @param data Data to pass to item-related functions
14160 * @return A handle to the item added.
14162 * This adds an item to the hoversel to show when it is clicked. Note: if you
14163 * need to use an icon from an edje file then use
14164 * elm_hoversel_item_icon_set() right after the this function, and set
14165 * icon_file to NULL here.
14167 * For more information on what @p icon_file and @p icon_type are see the
14168 * @ref Icon "icon documentation".
14170 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);
14172 * @brief Delete an item from the hoversel
14174 * @param item The item to delete
14176 * This deletes the item from the hoversel (should not be called while the
14177 * hoversel is active; use elm_hoversel_expanded_get() to check first).
14179 * @see elm_hoversel_item_add()
14180 * @see elm_hoversel_item_del_cb_set()
14182 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14184 * @brief Set the function to be called when an item from the hoversel is
14187 * @param item The item to set the callback on
14188 * @param func The function called
14190 * That function will receive these parameters:
14191 * @li void *item_data
14192 * @li Evas_Object *the_item_object
14193 * @li Elm_Hoversel_Item *the_object_struct
14195 * @see elm_hoversel_item_add()
14197 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14199 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14200 * that will be passed to associated function callbacks.
14202 * @param item The item to get the data from
14203 * @return The data pointer set with elm_hoversel_item_add()
14205 * @see elm_hoversel_item_add()
14207 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14209 * @brief This returns the label text of the given hoversel item.
14211 * @param item The item to get the label
14212 * @return The label text of the hoversel item
14214 * @see elm_hoversel_item_add()
14216 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14218 * @brief This sets the icon for the given hoversel item.
14220 * @param item The item to set the icon
14221 * @param icon_file An image file path on disk to use for the icon or standard
14223 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14224 * to NULL if the icon is not an edje file
14225 * @param icon_type The icon type
14227 * The icon can be loaded from the standard set, from an image file, or from
14230 * @see elm_hoversel_item_add()
14232 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);
14234 * @brief Get the icon object of the hoversel item
14236 * @param item The item to get the icon from
14237 * @param icon_file The image file path on disk used for the icon or standard
14239 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14240 * if the icon is not an edje file
14241 * @param icon_type The icon type
14243 * @see elm_hoversel_item_icon_set()
14244 * @see elm_hoversel_item_add()
14246 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);
14252 * @defgroup Toolbar Toolbar
14253 * @ingroup Elementary
14255 * @image html img/widget/toolbar/preview-00.png
14256 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14258 * @image html img/toolbar.png
14259 * @image latex img/toolbar.eps width=\textwidth
14261 * A toolbar is a widget that displays a list of items inside
14262 * a box. It can be scrollable, show a menu with items that don't fit
14263 * to toolbar size or even crop them.
14265 * Only one item can be selected at a time.
14267 * Items can have multiple states, or show menus when selected by the user.
14269 * Smart callbacks one can listen to:
14270 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14271 * - "language,changed" - when the program language changes
14273 * Available styles for it:
14275 * - @c "transparent" - no background or shadow, just show the content
14277 * List of examples:
14278 * @li @ref toolbar_example_01
14279 * @li @ref toolbar_example_02
14280 * @li @ref toolbar_example_03
14284 * @addtogroup Toolbar
14289 * @enum _Elm_Toolbar_Shrink_Mode
14290 * @typedef Elm_Toolbar_Shrink_Mode
14292 * Set toolbar's items display behavior, it can be scrollabel,
14293 * show a menu with exceeding items, or simply hide them.
14295 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14298 * Values <b> don't </b> work as bitmask, only one can be choosen.
14300 * @see elm_toolbar_mode_shrink_set()
14301 * @see elm_toolbar_mode_shrink_get()
14305 typedef enum _Elm_Toolbar_Shrink_Mode
14307 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
14308 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
14309 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14310 ELM_TOOLBAR_SHRINK_MENU, /**< Inserts a button to pop up a menu with exceeding items. */
14311 ELM_TOOLBAR_SHRINK_LAST /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14312 } Elm_Toolbar_Shrink_Mode;
14314 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(). */
14316 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(). */
14319 * Add a new toolbar widget to the given parent Elementary
14320 * (container) object.
14322 * @param parent The parent object.
14323 * @return a new toolbar widget handle or @c NULL, on errors.
14325 * This function inserts a new toolbar widget on the canvas.
14329 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14332 * Set the icon size, in pixels, to be used by toolbar items.
14334 * @param obj The toolbar object
14335 * @param icon_size The icon size in pixels
14337 * @note Default value is @c 32. It reads value from elm config.
14339 * @see elm_toolbar_icon_size_get()
14343 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14346 * Get the icon size, in pixels, to be used by toolbar items.
14348 * @param obj The toolbar object.
14349 * @return The icon size in pixels.
14351 * @see elm_toolbar_icon_size_set() for details.
14355 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14358 * Sets icon lookup order, for toolbar items' icons.
14360 * @param obj The toolbar object.
14361 * @param order The icon lookup order.
14363 * Icons added before calling this function will not be affected.
14364 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14366 * @see elm_toolbar_icon_order_lookup_get()
14370 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14373 * Gets the icon lookup order.
14375 * @param obj The toolbar object.
14376 * @return The icon lookup order.
14378 * @see elm_toolbar_icon_order_lookup_set() for details.
14382 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14385 * Set whether the toolbar should always have an item selected.
14387 * @param obj The toolbar object.
14388 * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14391 * This will cause the toolbar to always have an item selected, and clicking
14392 * the selected item will not cause a selected event to be emitted. Enabling this mode
14393 * will immediately select the first toolbar item.
14395 * Always-selected is disabled by default.
14397 * @see elm_toolbar_always_select_mode_get().
14401 EAPI void elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14404 * Get whether the toolbar should always have an item selected.
14406 * @param obj The toolbar object.
14407 * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14408 * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14410 * @see elm_toolbar_always_select_mode_set() for details.
14414 EAPI Eina_Bool elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14417 * Set whether the toolbar items' should be selected by the user or not.
14419 * @param obj The toolbar object.
14420 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14423 * This will turn off the ability to select items entirely and they will
14424 * neither appear selected nor emit selected signals. The clicked
14425 * callback function will still be called.
14427 * Selection is enabled by default.
14429 * @see elm_toolbar_no_select_mode_get().
14433 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14436 * Set whether the toolbar items' should be selected by the user or not.
14438 * @param obj The toolbar object.
14439 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14440 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14442 * @see elm_toolbar_no_select_mode_set() for details.
14446 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14449 * Append item to the toolbar.
14451 * @param obj The toolbar object.
14452 * @param icon A string with icon name or the absolute path of an image file.
14453 * @param label The label of the item.
14454 * @param func The function to call when the item is clicked.
14455 * @param data The data to associate with the item for related callbacks.
14456 * @return The created item or @c NULL upon failure.
14458 * A new item will be created and appended to the toolbar, i.e., will
14459 * be set as @b last item.
14461 * Items created with this method can be deleted with
14462 * elm_toolbar_item_del().
14464 * Associated @p data can be properly freed when item is deleted if a
14465 * callback function is set with elm_toolbar_item_del_cb_set().
14467 * If a function is passed as argument, it will be called everytime this item
14468 * is selected, i.e., the user clicks over an unselected item.
14469 * If such function isn't needed, just passing
14470 * @c NULL as @p func is enough. The same should be done for @p data.
14472 * Toolbar will load icon image from fdo or current theme.
14473 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14474 * If an absolute path is provided it will load it direct from a file.
14476 * @see elm_toolbar_item_icon_set()
14477 * @see elm_toolbar_item_del()
14478 * @see elm_toolbar_item_del_cb_set()
14482 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);
14485 * Prepend item to the toolbar.
14487 * @param obj The toolbar object.
14488 * @param icon A string with icon name or the absolute path of an image file.
14489 * @param label The label of the item.
14490 * @param func The function to call when the item is clicked.
14491 * @param data The data to associate with the item for related callbacks.
14492 * @return The created item or @c NULL upon failure.
14494 * A new item will be created and prepended to the toolbar, i.e., will
14495 * be set as @b first item.
14497 * Items created with this method can be deleted with
14498 * elm_toolbar_item_del().
14500 * Associated @p data can be properly freed when item is deleted if a
14501 * callback function is set with elm_toolbar_item_del_cb_set().
14503 * If a function is passed as argument, it will be called everytime this item
14504 * is selected, i.e., the user clicks over an unselected item.
14505 * If such function isn't needed, just passing
14506 * @c NULL as @p func is enough. The same should be done for @p data.
14508 * Toolbar will load icon image from fdo or current theme.
14509 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14510 * If an absolute path is provided it will load it direct from a file.
14512 * @see elm_toolbar_item_icon_set()
14513 * @see elm_toolbar_item_del()
14514 * @see elm_toolbar_item_del_cb_set()
14518 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);
14521 * Insert a new item into the toolbar object before item @p before.
14523 * @param obj The toolbar object.
14524 * @param before The toolbar item to insert before.
14525 * @param icon A string with icon name or the absolute path of an image file.
14526 * @param label The label of the item.
14527 * @param func The function to call when the item is clicked.
14528 * @param data The data to associate with the item for related callbacks.
14529 * @return The created item or @c NULL upon failure.
14531 * A new item will be created and added to the toolbar. Its position in
14532 * this toolbar will be just before item @p before.
14534 * Items created with this method can be deleted with
14535 * elm_toolbar_item_del().
14537 * Associated @p data can be properly freed when item is deleted if a
14538 * callback function is set with elm_toolbar_item_del_cb_set().
14540 * If a function is passed as argument, it will be called everytime this item
14541 * is selected, i.e., the user clicks over an unselected item.
14542 * If such function isn't needed, just passing
14543 * @c NULL as @p func is enough. The same should be done for @p data.
14545 * Toolbar will load icon image from fdo or current theme.
14546 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14547 * If an absolute path is provided it will load it direct from a file.
14549 * @see elm_toolbar_item_icon_set()
14550 * @see elm_toolbar_item_del()
14551 * @see elm_toolbar_item_del_cb_set()
14555 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);
14558 * Insert a new item into the toolbar object after item @p after.
14560 * @param obj The toolbar object.
14561 * @param after The toolbar item to insert after.
14562 * @param icon A string with icon name or the absolute path of an image file.
14563 * @param label The label of the item.
14564 * @param func The function to call when the item is clicked.
14565 * @param data The data to associate with the item for related callbacks.
14566 * @return The created item or @c NULL upon failure.
14568 * A new item will be created and added to the toolbar. Its position in
14569 * this toolbar will be just after item @p after.
14571 * Items created with this method can be deleted with
14572 * elm_toolbar_item_del().
14574 * Associated @p data can be properly freed when item is deleted if a
14575 * callback function is set with elm_toolbar_item_del_cb_set().
14577 * If a function is passed as argument, it will be called everytime this item
14578 * is selected, i.e., the user clicks over an unselected item.
14579 * If such function isn't needed, just passing
14580 * @c NULL as @p func is enough. The same should be done for @p data.
14582 * Toolbar will load icon image from fdo or current theme.
14583 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14584 * If an absolute path is provided it will load it direct from a file.
14586 * @see elm_toolbar_item_icon_set()
14587 * @see elm_toolbar_item_del()
14588 * @see elm_toolbar_item_del_cb_set()
14592 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);
14595 * Get the first item in the given toolbar widget's list of
14598 * @param obj The toolbar object
14599 * @return The first item or @c NULL, if it has no items (and on
14602 * @see elm_toolbar_item_append()
14603 * @see elm_toolbar_last_item_get()
14607 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14610 * Get the last item in the given toolbar widget's list of
14613 * @param obj The toolbar object
14614 * @return The last item or @c NULL, if it has no items (and on
14617 * @see elm_toolbar_item_prepend()
14618 * @see elm_toolbar_first_item_get()
14622 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14625 * Get the item after @p item in toolbar.
14627 * @param item The toolbar item.
14628 * @return The item after @p item, or @c NULL if none or on failure.
14630 * @note If it is the last item, @c NULL will be returned.
14632 * @see elm_toolbar_item_append()
14636 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14639 * Get the item before @p item in toolbar.
14641 * @param item The toolbar item.
14642 * @return The item before @p item, or @c NULL if none or on failure.
14644 * @note If it is the first item, @c NULL will be returned.
14646 * @see elm_toolbar_item_prepend()
14650 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14653 * Get the toolbar object from an item.
14655 * @param item The item.
14656 * @return The toolbar object.
14658 * This returns the toolbar object itself that an item belongs to.
14662 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14665 * Set the priority of a toolbar item.
14667 * @param item The toolbar item.
14668 * @param priority The item priority. The default is zero.
14670 * This is used only when the toolbar shrink mode is set to
14671 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14672 * When space is less than required, items with low priority
14673 * will be removed from the toolbar and added to a dynamically-created menu,
14674 * while items with higher priority will remain on the toolbar,
14675 * with the same order they were added.
14677 * @see elm_toolbar_item_priority_get()
14681 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14684 * Get the priority of a toolbar item.
14686 * @param item The toolbar item.
14687 * @return The @p item priority, or @c 0 on failure.
14689 * @see elm_toolbar_item_priority_set() for details.
14693 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14696 * Get the label of item.
14698 * @param item The item of toolbar.
14699 * @return The label of item.
14701 * The return value is a pointer to the label associated to @p item when
14702 * it was created, with function elm_toolbar_item_append() or similar,
14704 * with function elm_toolbar_item_label_set. If no label
14705 * was passed as argument, it will return @c NULL.
14707 * @see elm_toolbar_item_label_set() for more details.
14708 * @see elm_toolbar_item_append()
14712 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14715 * Set the label of item.
14717 * @param item The item of toolbar.
14718 * @param text The label of item.
14720 * The label to be displayed by the item.
14721 * Label will be placed at icons bottom (if set).
14723 * If a label was passed as argument on item creation, with function
14724 * elm_toolbar_item_append() or similar, it will be already
14725 * displayed by the item.
14727 * @see elm_toolbar_item_label_get()
14728 * @see elm_toolbar_item_append()
14732 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14735 * Return the data associated with a given toolbar widget item.
14737 * @param item The toolbar widget item handle.
14738 * @return The data associated with @p item.
14740 * @see elm_toolbar_item_data_set()
14744 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14747 * Set the data associated with a given toolbar widget item.
14749 * @param item The toolbar widget item handle.
14750 * @param data The new data pointer to set to @p item.
14752 * This sets new item data on @p item.
14754 * @warning The old data pointer won't be touched by this function, so
14755 * the user had better to free that old data himself/herself.
14759 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14762 * Returns a pointer to a toolbar item by its label.
14764 * @param obj The toolbar object.
14765 * @param label The label of the item to find.
14767 * @return The pointer to the toolbar item matching @p label or @c NULL
14772 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14775 * Get whether the @p item is selected or not.
14777 * @param item The toolbar item.
14778 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14779 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14781 * @see elm_toolbar_selected_item_set() for details.
14782 * @see elm_toolbar_item_selected_get()
14786 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14789 * Set the selected state of an item.
14791 * @param item The toolbar item
14792 * @param selected The selected state
14794 * This sets the selected state of the given item @p it.
14795 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14797 * If a new item is selected the previosly selected will be unselected.
14798 * Previoulsy selected item can be get with function
14799 * elm_toolbar_selected_item_get().
14801 * Selected items will be highlighted.
14803 * @see elm_toolbar_item_selected_get()
14804 * @see elm_toolbar_selected_item_get()
14808 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14811 * Get the selected item.
14813 * @param obj The toolbar object.
14814 * @return The selected toolbar item.
14816 * The selected item can be unselected with function
14817 * elm_toolbar_item_selected_set().
14819 * The selected item always will be highlighted on toolbar.
14821 * @see elm_toolbar_selected_items_get()
14825 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14828 * Set the icon associated with @p item.
14830 * @param obj The parent of this item.
14831 * @param item The toolbar item.
14832 * @param icon A string with icon name or the absolute path of an image file.
14834 * Toolbar will load icon image from fdo or current theme.
14835 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14836 * If an absolute path is provided it will load it direct from a file.
14838 * @see elm_toolbar_icon_order_lookup_set()
14839 * @see elm_toolbar_icon_order_lookup_get()
14843 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
14846 * Get the string used to set the icon of @p item.
14848 * @param item The toolbar item.
14849 * @return The string associated with the icon object.
14851 * @see elm_toolbar_item_icon_set() for details.
14855 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14858 * Get the object of @p item.
14860 * @param item The toolbar item.
14861 * @return The object
14865 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14868 * Get the icon object of @p item.
14870 * @param item The toolbar item.
14871 * @return The icon object
14873 * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
14877 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14880 * Set the icon associated with @p item to an image in a binary buffer.
14882 * @param item The toolbar item.
14883 * @param img The binary data that will be used as an image
14884 * @param size The size of binary data @p img
14885 * @param format Optional format of @p img to pass to the image loader
14886 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
14888 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
14890 * @note The icon image set by this function can be changed by
14891 * elm_toolbar_item_icon_set().
14895 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);
14898 * Delete them item from the toolbar.
14900 * @param item The item of toolbar to be deleted.
14902 * @see elm_toolbar_item_append()
14903 * @see elm_toolbar_item_del_cb_set()
14907 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14910 * Set the function called when a toolbar item is freed.
14912 * @param item The item to set the callback on.
14913 * @param func The function called.
14915 * If there is a @p func, then it will be called prior item's memory release.
14916 * That will be called with the following arguments:
14918 * @li item's Evas object;
14921 * This way, a data associated to a toolbar item could be properly freed.
14925 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14928 * Get a value whether toolbar item is disabled or not.
14930 * @param item The item.
14931 * @return The disabled state.
14933 * @see elm_toolbar_item_disabled_set() for more details.
14937 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14940 * Sets the disabled/enabled state of a toolbar item.
14942 * @param item The item.
14943 * @param disabled The disabled state.
14945 * A disabled item cannot be selected or unselected. It will also
14946 * change its appearance (generally greyed out). This sets the
14947 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
14952 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14955 * Set or unset item as a separator.
14957 * @param item The toolbar item.
14958 * @param setting @c EINA_TRUE to set item @p item as separator or
14959 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
14961 * Items aren't set as separator by default.
14963 * If set as separator it will display separator theme, so won't display
14966 * @see elm_toolbar_item_separator_get()
14970 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
14973 * Get a value whether item is a separator or not.
14975 * @param item The toolbar item.
14976 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
14977 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
14979 * @see elm_toolbar_item_separator_set() for details.
14983 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14986 * Set the shrink state of toolbar @p obj.
14988 * @param obj The toolbar object.
14989 * @param shrink_mode Toolbar's items display behavior.
14991 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
14992 * but will enforce a minimun size so all the items will fit, won't scroll
14993 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
14994 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
14995 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
14999 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15002 * Get the shrink mode of toolbar @p obj.
15004 * @param obj The toolbar object.
15005 * @return Toolbar's items display behavior.
15007 * @see elm_toolbar_mode_shrink_set() for details.
15011 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15014 * Enable/disable homogenous mode.
15016 * @param obj The toolbar object
15017 * @param homogeneous Assume the items within the toolbar are of the
15018 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15020 * This will enable the homogeneous mode where items are of the same size.
15021 * @see elm_toolbar_homogeneous_get()
15025 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15028 * Get whether the homogenous mode is enabled.
15030 * @param obj The toolbar object.
15031 * @return Assume the items within the toolbar are of the same height
15032 * and width (EINA_TRUE = on, EINA_FALSE = off).
15034 * @see elm_toolbar_homogeneous_set()
15038 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15041 * Enable/disable homogenous mode.
15043 * @param obj The toolbar object
15044 * @param homogeneous Assume the items within the toolbar are of the
15045 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15047 * This will enable the homogeneous mode where items are of the same size.
15048 * @see elm_toolbar_homogeneous_get()
15050 * @deprecated use elm_toolbar_homogeneous_set() instead.
15054 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
15057 * Get whether the homogenous mode is enabled.
15059 * @param obj The toolbar object.
15060 * @return Assume the items within the toolbar are of the same height
15061 * and width (EINA_TRUE = on, EINA_FALSE = off).
15063 * @see elm_toolbar_homogeneous_set()
15064 * @deprecated use elm_toolbar_homogeneous_get() instead.
15068 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15071 * Set the parent object of the toolbar items' menus.
15073 * @param obj The toolbar object.
15074 * @param parent The parent of the menu objects.
15076 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15078 * For more details about setting the parent for toolbar menus, see
15079 * elm_menu_parent_set().
15081 * @see elm_menu_parent_set() for details.
15082 * @see elm_toolbar_item_menu_set() for details.
15086 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15089 * Get the parent object of the toolbar items' menus.
15091 * @param obj The toolbar object.
15092 * @return The parent of the menu objects.
15094 * @see elm_toolbar_menu_parent_set() for details.
15098 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15101 * Set the alignment of the items.
15103 * @param obj The toolbar object.
15104 * @param align The new alignment, a float between <tt> 0.0 </tt>
15105 * and <tt> 1.0 </tt>.
15107 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15108 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15111 * Centered items by default.
15113 * @see elm_toolbar_align_get()
15117 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15120 * Get the alignment of the items.
15122 * @param obj The toolbar object.
15123 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15126 * @see elm_toolbar_align_set() for details.
15130 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15133 * Set whether the toolbar item opens a menu.
15135 * @param item The toolbar item.
15136 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15138 * A toolbar item can be set to be a menu, using this function.
15140 * Once it is set to be a menu, it can be manipulated through the
15141 * menu-like function elm_toolbar_menu_parent_set() and the other
15142 * elm_menu functions, using the Evas_Object @c menu returned by
15143 * elm_toolbar_item_menu_get().
15145 * So, items to be displayed in this item's menu should be added with
15146 * elm_menu_item_add().
15148 * The following code exemplifies the most basic usage:
15150 * tb = elm_toolbar_add(win)
15151 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15152 * elm_toolbar_item_menu_set(item, EINA_TRUE);
15153 * elm_toolbar_menu_parent_set(tb, win);
15154 * menu = elm_toolbar_item_menu_get(item);
15155 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15156 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15160 * @see elm_toolbar_item_menu_get()
15164 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15167 * Get toolbar item's menu.
15169 * @param item The toolbar item.
15170 * @return Item's menu object or @c NULL on failure.
15172 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15173 * this function will set it.
15175 * @see elm_toolbar_item_menu_set() for details.
15179 EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15182 * Add a new state to @p item.
15184 * @param item The item.
15185 * @param icon A string with icon name or the absolute path of an image file.
15186 * @param label The label of the new state.
15187 * @param func The function to call when the item is clicked when this
15188 * state is selected.
15189 * @param data The data to associate with the state.
15190 * @return The toolbar item state, or @c NULL upon failure.
15192 * Toolbar will load icon image from fdo or current theme.
15193 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15194 * If an absolute path is provided it will load it direct from a file.
15196 * States created with this function can be removed with
15197 * elm_toolbar_item_state_del().
15199 * @see elm_toolbar_item_state_del()
15200 * @see elm_toolbar_item_state_sel()
15201 * @see elm_toolbar_item_state_get()
15205 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);
15208 * Delete a previoulsy added state to @p item.
15210 * @param item The toolbar item.
15211 * @param state The state to be deleted.
15212 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15214 * @see elm_toolbar_item_state_add()
15216 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15219 * Set @p state as the current state of @p it.
15221 * @param it The item.
15222 * @param state The state to use.
15223 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15225 * If @p state is @c NULL, it won't select any state and the default item's
15226 * icon and label will be used. It's the same behaviour than
15227 * elm_toolbar_item_state_unser().
15229 * @see elm_toolbar_item_state_unset()
15233 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15236 * Unset the state of @p it.
15238 * @param it The item.
15240 * The default icon and label from this item will be displayed.
15242 * @see elm_toolbar_item_state_set() for more details.
15246 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15249 * Get the current state of @p it.
15251 * @param item The item.
15252 * @return The selected state or @c NULL if none is selected or on failure.
15254 * @see elm_toolbar_item_state_set() for details.
15255 * @see elm_toolbar_item_state_unset()
15256 * @see elm_toolbar_item_state_add()
15260 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15263 * Get the state after selected state in toolbar's @p item.
15265 * @param it The toolbar item to change state.
15266 * @return The state after current state, or @c NULL on failure.
15268 * If last state is selected, this function will return first state.
15270 * @see elm_toolbar_item_state_set()
15271 * @see elm_toolbar_item_state_add()
15275 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15278 * Get the state before selected state in toolbar's @p item.
15280 * @param it The toolbar item to change state.
15281 * @return The state before current state, or @c NULL on failure.
15283 * If first state is selected, this function will return last state.
15285 * @see elm_toolbar_item_state_set()
15286 * @see elm_toolbar_item_state_add()
15290 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15293 * Set the text to be shown in a given toolbar item's tooltips.
15295 * @param item Target item.
15296 * @param text The text to set in the content.
15298 * Setup the text as tooltip to object. The item can have only one tooltip,
15299 * so any previous tooltip data - set with this function or
15300 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15302 * @see elm_object_tooltip_text_set() for more details.
15306 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15309 * Set the content to be shown in the tooltip item.
15311 * Setup the tooltip to item. The item can have only one tooltip,
15312 * so any previous tooltip data is removed. @p func(with @p data) will
15313 * be called every time that need show the tooltip and it should
15314 * return a valid Evas_Object. This object is then managed fully by
15315 * tooltip system and is deleted when the tooltip is gone.
15317 * @param item the toolbar item being attached a tooltip.
15318 * @param func the function used to create the tooltip contents.
15319 * @param data what to provide to @a func as callback data/context.
15320 * @param del_cb called when data is not needed anymore, either when
15321 * another callback replaces @a func, the tooltip is unset with
15322 * elm_toolbar_item_tooltip_unset() or the owner @a item
15323 * dies. This callback receives as the first parameter the
15324 * given @a data, and @c event_info is the item.
15326 * @see elm_object_tooltip_content_cb_set() for more details.
15330 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);
15333 * Unset tooltip from item.
15335 * @param item toolbar item to remove previously set tooltip.
15337 * Remove tooltip from item. The callback provided as del_cb to
15338 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15339 * it is not used anymore.
15341 * @see elm_object_tooltip_unset() for more details.
15342 * @see elm_toolbar_item_tooltip_content_cb_set()
15346 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15349 * Sets a different style for this item tooltip.
15351 * @note before you set a style you should define a tooltip with
15352 * elm_toolbar_item_tooltip_content_cb_set() or
15353 * elm_toolbar_item_tooltip_text_set()
15355 * @param item toolbar item with tooltip already set.
15356 * @param style the theme style to use (default, transparent, ...)
15358 * @see elm_object_tooltip_style_set() for more details.
15362 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15365 * Get the style for this item tooltip.
15367 * @param item toolbar item with tooltip already set.
15368 * @return style the theme style in use, defaults to "default". If the
15369 * object does not have a tooltip set, then NULL is returned.
15371 * @see elm_object_tooltip_style_get() for more details.
15372 * @see elm_toolbar_item_tooltip_style_set()
15376 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15379 * Set the type of mouse pointer/cursor decoration to be shown,
15380 * when the mouse pointer is over the given toolbar widget item
15382 * @param item toolbar item to customize cursor on
15383 * @param cursor the cursor type's name
15385 * This function works analogously as elm_object_cursor_set(), but
15386 * here the cursor's changing area is restricted to the item's
15387 * area, and not the whole widget's. Note that that item cursors
15388 * have precedence over widget cursors, so that a mouse over an
15389 * item with custom cursor set will always show @b that cursor.
15391 * If this function is called twice for an object, a previously set
15392 * cursor will be unset on the second call.
15394 * @see elm_object_cursor_set()
15395 * @see elm_toolbar_item_cursor_get()
15396 * @see elm_toolbar_item_cursor_unset()
15400 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15403 * Get the type of mouse pointer/cursor decoration set to be shown,
15404 * when the mouse pointer is over the given toolbar widget item
15406 * @param item toolbar item with custom cursor set
15407 * @return the cursor type's name or @c NULL, if no custom cursors
15408 * were set to @p item (and on errors)
15410 * @see elm_object_cursor_get()
15411 * @see elm_toolbar_item_cursor_set()
15412 * @see elm_toolbar_item_cursor_unset()
15416 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15419 * Unset any custom mouse pointer/cursor decoration set to be
15420 * shown, when the mouse pointer is over the given toolbar widget
15421 * item, thus making it show the @b default cursor again.
15423 * @param item a toolbar item
15425 * Use this call to undo any custom settings on this item's cursor
15426 * decoration, bringing it back to defaults (no custom style set).
15428 * @see elm_object_cursor_unset()
15429 * @see elm_toolbar_item_cursor_set()
15433 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15436 * Set a different @b style for a given custom cursor set for a
15439 * @param item toolbar item with custom cursor set
15440 * @param style the <b>theme style</b> to use (e.g. @c "default",
15441 * @c "transparent", etc)
15443 * This function only makes sense when one is using custom mouse
15444 * cursor decorations <b>defined in a theme file</b>, which can have,
15445 * given a cursor name/type, <b>alternate styles</b> on it. It
15446 * works analogously as elm_object_cursor_style_set(), but here
15447 * applyed only to toolbar item objects.
15449 * @warning Before you set a cursor style you should have definen a
15450 * custom cursor previously on the item, with
15451 * elm_toolbar_item_cursor_set()
15453 * @see elm_toolbar_item_cursor_engine_only_set()
15454 * @see elm_toolbar_item_cursor_style_get()
15458 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15461 * Get the current @b style set for a given toolbar item's custom
15464 * @param item toolbar item with custom cursor set.
15465 * @return style the cursor style in use. If the object does not
15466 * have a cursor set, then @c NULL is returned.
15468 * @see elm_toolbar_item_cursor_style_set() for more details
15472 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15475 * Set if the (custom)cursor for a given toolbar item should be
15476 * searched in its theme, also, or should only rely on the
15477 * rendering engine.
15479 * @param item item with custom (custom) cursor already set on
15480 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15481 * only on those provided by the rendering engine, @c EINA_FALSE to
15482 * have them searched on the widget's theme, as well.
15484 * @note This call is of use only if you've set a custom cursor
15485 * for toolbar items, with elm_toolbar_item_cursor_set().
15487 * @note By default, cursors will only be looked for between those
15488 * provided by the rendering engine.
15492 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15495 * Get if the (custom) cursor for a given toolbar item is being
15496 * searched in its theme, also, or is only relying on the rendering
15499 * @param item a toolbar item
15500 * @return @c EINA_TRUE, if cursors are being looked for only on
15501 * those provided by the rendering engine, @c EINA_FALSE if they
15502 * are being searched on the widget's theme, as well.
15504 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15508 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15511 * Change a toolbar's orientation
15512 * @param obj The toolbar object
15513 * @param vertical If @c EINA_TRUE, the toolbar is vertical
15514 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15516 * @deprecated use elm_toolbar_horizontal_set() instead.
15518 EINA_DEPRECATED EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15521 * Change a toolbar's orientation
15522 * @param obj The toolbar object
15523 * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15524 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15527 EAPI void elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15530 * Get a toolbar's orientation
15531 * @param obj The toolbar object
15532 * @return If @c EINA_TRUE, the toolbar is vertical
15533 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15535 * @deprecated use elm_toolbar_horizontal_get() instead.
15537 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15540 * Get a toolbar's orientation
15541 * @param obj The toolbar object
15542 * @return If @c EINA_TRUE, the toolbar is horizontal
15543 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15546 EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15552 * @defgroup Tooltips Tooltips
15554 * The Tooltip is an (internal, for now) smart object used to show a
15555 * content in a frame on mouse hover of objects(or widgets), with
15556 * tips/information about them.
15561 EAPI double elm_tooltip_delay_get(void);
15562 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
15563 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15564 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15565 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15566 EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15567 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15568 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);
15569 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15570 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15571 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15574 * @defgroup Cursors Cursors
15576 * The Elementary cursor is an internal smart object used to
15577 * customize the mouse cursor displayed over objects (or
15578 * widgets). In the most common scenario, the cursor decoration
15579 * comes from the graphical @b engine Elementary is running
15580 * on. Those engines may provide different decorations for cursors,
15581 * and Elementary provides functions to choose them (think of X11
15582 * cursors, as an example).
15584 * There's also the possibility of, besides using engine provided
15585 * cursors, also use ones coming from Edje theming files. Both
15586 * globally and per widget, Elementary makes it possible for one to
15587 * make the cursors lookup to be held on engines only or on
15588 * Elementary's theme file, too. To set cursor's hot spot,
15589 * two data items should be added to cursor's theme: "hot_x" and
15590 * "hot_y", that are the offset from upper-left corner of the cursor
15591 * (coordinates 0,0).
15597 * Set the cursor to be shown when mouse is over the object
15599 * Set the cursor that will be displayed when mouse is over the
15600 * object. The object can have only one cursor set to it, so if
15601 * this function is called twice for an object, the previous set
15603 * If using X cursors, a definition of all the valid cursor names
15604 * is listed on Elementary_Cursors.h. If an invalid name is set
15605 * the default cursor will be used.
15607 * @param obj the object being set a cursor.
15608 * @param cursor the cursor name to be used.
15612 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15615 * Get the cursor to be shown when mouse is over the object
15617 * @param obj an object with cursor already set.
15618 * @return the cursor name.
15622 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15625 * Unset cursor for object
15627 * Unset cursor for object, and set the cursor to default if the mouse
15628 * was over this object.
15630 * @param obj Target object
15631 * @see elm_object_cursor_set()
15635 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15638 * Sets a different style for this object cursor.
15640 * @note before you set a style you should define a cursor with
15641 * elm_object_cursor_set()
15643 * @param obj an object with cursor already set.
15644 * @param style the theme style to use (default, transparent, ...)
15648 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15651 * Get the style for this object cursor.
15653 * @param obj an object with cursor already set.
15654 * @return style the theme style in use, defaults to "default". If the
15655 * object does not have a cursor set, then NULL is returned.
15659 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15662 * Set if the cursor set should be searched on the theme or should use
15663 * the provided by the engine, only.
15665 * @note before you set if should look on theme you should define a cursor
15666 * with elm_object_cursor_set(). By default it will only look for cursors
15667 * provided by the engine.
15669 * @param obj an object with cursor already set.
15670 * @param engine_only boolean to define it cursors should be looked only
15671 * between the provided by the engine or searched on widget's theme as well.
15675 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15678 * Get the cursor engine only usage for this object cursor.
15680 * @param obj an object with cursor already set.
15681 * @return engine_only boolean to define it cursors should be
15682 * looked only between the provided by the engine or searched on
15683 * widget's theme as well. If the object does not have a cursor
15684 * set, then EINA_FALSE is returned.
15688 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15691 * Get the configured cursor engine only usage
15693 * This gets the globally configured exclusive usage of engine cursors.
15695 * @return 1 if only engine cursors should be used
15698 EAPI int elm_cursor_engine_only_get(void);
15701 * Set the configured cursor engine only usage
15703 * This sets the globally configured exclusive usage of engine cursors.
15704 * It won't affect cursors set before changing this value.
15706 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15707 * look for them on theme before.
15708 * @return EINA_TRUE if value is valid and setted (0 or 1)
15711 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
15718 * @defgroup Menu Menu
15720 * @image html img/widget/menu/preview-00.png
15721 * @image latex img/widget/menu/preview-00.eps
15723 * A menu is a list of items displayed above its parent. When the menu is
15724 * showing its parent is darkened. Each item can have a sub-menu. The menu
15725 * object can be used to display a menu on a right click event, in a toolbar,
15728 * Signals that you can add callbacks for are:
15729 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15730 * event_info is NULL.
15732 * @see @ref tutorial_menu
15735 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15737 * @brief Add a new menu to the parent
15739 * @param parent The parent object.
15740 * @return The new object or NULL if it cannot be created.
15742 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15744 * @brief Set the parent for the given menu widget
15746 * @param obj The menu object.
15747 * @param parent The new parent.
15749 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15751 * @brief Get the parent for the given menu widget
15753 * @param obj The menu object.
15754 * @return The parent.
15756 * @see elm_menu_parent_set()
15758 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15760 * @brief Move the menu to a new position
15762 * @param obj The menu object.
15763 * @param x The new position.
15764 * @param y The new position.
15766 * Sets the top-left position of the menu to (@p x,@p y).
15768 * @note @p x and @p y coordinates are relative to parent.
15770 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15772 * @brief Close a opened menu
15774 * @param obj the menu object
15777 * Hides the menu and all it's sub-menus.
15779 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15781 * @brief Returns a list of @p item's items.
15783 * @param obj The menu object
15784 * @return An Eina_List* of @p item's items
15786 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15788 * @brief Get the Evas_Object of an Elm_Menu_Item
15790 * @param item The menu item object.
15791 * @return The edje object containing the swallowed content
15793 * @warning Don't manipulate this object!
15795 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15797 * @brief Add an item at the end of the given menu widget
15799 * @param obj The menu object.
15800 * @param parent The parent menu item (optional)
15801 * @param icon A icon display on the item. The icon will be destryed by the menu.
15802 * @param label The label of the item.
15803 * @param func Function called when the user select the item.
15804 * @param data Data sent by the callback.
15805 * @return Returns the new item.
15807 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);
15809 * @brief Add an object swallowed in an item at the end of the given menu
15812 * @param obj The menu object.
15813 * @param parent The parent menu item (optional)
15814 * @param subobj The object to swallow
15815 * @param func Function called when the user select the item.
15816 * @param data Data sent by the callback.
15817 * @return Returns the new item.
15819 * Add an evas object as an item to the menu.
15821 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);
15823 * @brief Set the label of a menu item
15825 * @param item The menu item object.
15826 * @param label The label to set for @p item
15828 * @warning Don't use this funcion on items created with
15829 * elm_menu_item_add_object() or elm_menu_item_separator_add().
15831 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15833 * @brief Get the label of a menu item
15835 * @param item The menu item object.
15836 * @return The label of @p item
15838 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15840 * @brief Set the icon of a menu item to the standard icon with name @p icon
15842 * @param item The menu item object.
15843 * @param icon The icon object to set for the content of @p item
15845 * Once this icon is set, any previously set icon will be deleted.
15847 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
15849 * @brief Get the string representation from the icon of a menu item
15851 * @param item The menu item object.
15852 * @return The string representation of @p item's icon or NULL
15854 * @see elm_menu_item_object_icon_name_set()
15856 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15858 * @brief Set the content object of a menu item
15860 * @param item The menu item object
15861 * @param The content object or NULL
15862 * @return EINA_TRUE on success, else EINA_FALSE
15864 * Use this function to change the object swallowed by a menu item, deleting
15865 * any previously swallowed object.
15867 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
15869 * @brief Get the content object of a menu item
15871 * @param item The menu item object
15872 * @return The content object or NULL
15873 * @note If @p item was added with elm_menu_item_add_object, this
15874 * function will return the object passed, else it will return the
15877 * @see elm_menu_item_object_content_set()
15879 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15881 EINA_DEPRECATED extern inline void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2)
15883 elm_menu_item_object_icon_name_set(item, icon);
15886 EINA_DEPRECATED extern inline Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1)
15888 return elm_menu_item_object_content_get(item);
15891 EINA_DEPRECATED extern inline const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1)
15893 return elm_menu_item_object_icon_name_get(item);
15897 * @brief Set the selected state of @p item.
15899 * @param item The menu item object.
15900 * @param selected The selected/unselected state of the item
15902 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15904 * @brief Get the selected state of @p item.
15906 * @param item The menu item object.
15907 * @return The selected/unselected state of the item
15909 * @see elm_menu_item_selected_set()
15911 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15913 * @brief Set the disabled state of @p item.
15915 * @param item The menu item object.
15916 * @param disabled The enabled/disabled state of the item
15918 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15920 * @brief Get the disabled state of @p item.
15922 * @param item The menu item object.
15923 * @return The enabled/disabled state of the item
15925 * @see elm_menu_item_disabled_set()
15927 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15929 * @brief Add a separator item to menu @p obj under @p parent.
15931 * @param obj The menu object
15932 * @param parent The item to add the separator under
15933 * @return The created item or NULL on failure
15935 * This is item is a @ref Separator.
15937 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
15939 * @brief Returns whether @p item is a separator.
15941 * @param item The item to check
15942 * @return If true, @p item is a separator
15944 * @see elm_menu_item_separator_add()
15946 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15948 * @brief Deletes an item from the menu.
15950 * @param item The item to delete.
15952 * @see elm_menu_item_add()
15954 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15956 * @brief Set the function called when a menu item is deleted.
15958 * @param item The item to set the callback on
15959 * @param func The function called
15961 * @see elm_menu_item_add()
15962 * @see elm_menu_item_del()
15964 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15966 * @brief Returns the data associated with menu item @p item.
15968 * @param item The item
15969 * @return The data associated with @p item or NULL if none was set.
15971 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
15973 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15975 * @brief Sets the data to be associated with menu item @p item.
15977 * @param item The item
15978 * @param data The data to be associated with @p item
15980 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
15982 * @brief Returns a list of @p item's subitems.
15984 * @param item The item
15985 * @return An Eina_List* of @p item's subitems
15987 * @see elm_menu_add()
15989 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15991 * @brief Get the position of a menu item
15993 * @param item The menu item
15994 * @return The item's index
15996 * This function returns the index position of a menu item in a menu.
15997 * For a sub-menu, this number is relative to the first item in the sub-menu.
15999 * @note Index values begin with 0
16001 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16003 * @brief @brief Return a menu item's owner menu
16005 * @param item The menu item
16006 * @return The menu object owning @p item, or NULL on failure
16008 * Use this function to get the menu object owning an item.
16010 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16012 * @brief Get the selected item in the menu
16014 * @param obj The menu object
16015 * @return The selected item, or NULL if none
16017 * @see elm_menu_item_selected_get()
16018 * @see elm_menu_item_selected_set()
16020 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16022 * @brief Get the last item in the menu
16024 * @param obj The menu object
16025 * @return The last item, or NULL if none
16027 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16029 * @brief Get the first item in the menu
16031 * @param obj The menu object
16032 * @return The first item, or NULL if none
16034 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16036 * @brief Get the next item in the menu.
16038 * @param item The menu item object.
16039 * @return The item after it, or NULL if none
16041 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16043 * @brief Get the previous item in the menu.
16045 * @param item The menu item object.
16046 * @return The item before it, or NULL if none
16048 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16054 * @defgroup List List
16055 * @ingroup Elementary
16057 * @image html img/widget/list/preview-00.png
16058 * @image latex img/widget/list/preview-00.eps width=\textwidth
16060 * @image html img/list.png
16061 * @image latex img/list.eps width=\textwidth
16063 * A list widget is a container whose children are displayed vertically or
16064 * horizontally, in order, and can be selected.
16065 * The list can accept only one or multiple items selection. Also has many
16066 * modes of items displaying.
16068 * A list is a very simple type of list widget. For more robust
16069 * lists, @ref Genlist should probably be used.
16071 * Smart callbacks one can listen to:
16072 * - @c "activated" - The user has double-clicked or pressed
16073 * (enter|return|spacebar) on an item. The @c event_info parameter
16074 * is the item that was activated.
16075 * - @c "clicked,double" - The user has double-clicked an item.
16076 * The @c event_info parameter is the item that was double-clicked.
16077 * - "selected" - when the user selected an item
16078 * - "unselected" - when the user unselected an item
16079 * - "longpressed" - an item in the list is long-pressed
16080 * - "edge,top" - the list is scrolled until the top edge
16081 * - "edge,bottom" - the list is scrolled until the bottom edge
16082 * - "edge,left" - the list is scrolled until the left edge
16083 * - "edge,right" - the list is scrolled until the right edge
16084 * - "language,changed" - the program's language changed
16086 * Available styles for it:
16089 * List of examples:
16090 * @li @ref list_example_01
16091 * @li @ref list_example_02
16092 * @li @ref list_example_03
16101 * @enum _Elm_List_Mode
16102 * @typedef Elm_List_Mode
16104 * Set list's resize behavior, transverse axis scroll and
16105 * items cropping. See each mode's description for more details.
16107 * @note Default value is #ELM_LIST_SCROLL.
16109 * Values <b> don't </b> work as bitmask, only one can be choosen.
16111 * @see elm_list_mode_set()
16112 * @see elm_list_mode_get()
16116 typedef enum _Elm_List_Mode
16118 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. */
16119 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). */
16120 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. */
16121 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. */
16122 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16125 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(). */
16128 * Add a new list widget to the given parent Elementary
16129 * (container) object.
16131 * @param parent The parent object.
16132 * @return a new list widget handle or @c NULL, on errors.
16134 * This function inserts a new list widget on the canvas.
16138 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16143 * @param obj The list object
16145 * @note Call before running show() on the list object.
16146 * @warning If not called, it won't display the list properly.
16149 * li = elm_list_add(win);
16150 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16151 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16153 * evas_object_show(li);
16158 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16161 * Enable or disable multiple items selection on the list object.
16163 * @param obj The list object
16164 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16167 * Disabled by default. If disabled, the user can select a single item of
16168 * the list each time. Selected items are highlighted on list.
16169 * If enabled, many items can be selected.
16171 * If a selected item is selected again, it will be unselected.
16173 * @see elm_list_multi_select_get()
16177 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16180 * Get a value whether multiple items selection is enabled or not.
16182 * @see elm_list_multi_select_set() for details.
16184 * @param obj The list object.
16185 * @return @c EINA_TRUE means multiple items selection is enabled.
16186 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16187 * @c EINA_FALSE is returned.
16191 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16194 * Set which mode to use for the list object.
16196 * @param obj The list object
16197 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16198 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16200 * Set list's resize behavior, transverse axis scroll and
16201 * items cropping. See each mode's description for more details.
16203 * @note Default value is #ELM_LIST_SCROLL.
16205 * Only one can be set, if a previous one was set, it will be changed
16206 * by the new mode set. Bitmask won't work as well.
16208 * @see elm_list_mode_get()
16212 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16215 * Get the mode the list is at.
16217 * @param obj The list object
16218 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16219 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16221 * @note see elm_list_mode_set() for more information.
16225 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16228 * Enable or disable horizontal mode on the list object.
16230 * @param obj The list object.
16231 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16232 * disable it, i.e., to enable vertical mode.
16234 * @note Vertical mode is set by default.
16236 * On horizontal mode items are displayed on list from left to right,
16237 * instead of from top to bottom. Also, the list will scroll horizontally.
16238 * Each item will presents left icon on top and right icon, or end, at
16241 * @see elm_list_horizontal_get()
16245 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16248 * Get a value whether horizontal mode is enabled or not.
16250 * @param obj The list object.
16251 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16252 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16253 * @c EINA_FALSE is returned.
16255 * @see elm_list_horizontal_set() for details.
16259 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16262 * Enable or disable always select mode on the list object.
16264 * @param obj The list object
16265 * @param always_select @c EINA_TRUE to enable always select mode or
16266 * @c EINA_FALSE to disable it.
16268 * @note Always select mode is disabled by default.
16270 * Default behavior of list items is to only call its callback function
16271 * the first time it's pressed, i.e., when it is selected. If a selected
16272 * item is pressed again, and multi-select is disabled, it won't call
16273 * this function (if multi-select is enabled it will unselect the item).
16275 * If always select is enabled, it will call the callback function
16276 * everytime a item is pressed, so it will call when the item is selected,
16277 * and again when a selected item is pressed.
16279 * @see elm_list_always_select_mode_get()
16280 * @see elm_list_multi_select_set()
16284 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16287 * Get a value whether always select mode is enabled or not, meaning that
16288 * an item will always call its callback function, even if already selected.
16290 * @param obj The list object
16291 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16292 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16293 * @c EINA_FALSE is returned.
16295 * @see elm_list_always_select_mode_set() for details.
16299 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16302 * Set bouncing behaviour when the scrolled content reaches an edge.
16304 * Tell the internal scroller object whether it should bounce or not
16305 * when it reaches the respective edges for each axis.
16307 * @param obj The list object
16308 * @param h_bounce Whether to bounce or not in the horizontal axis.
16309 * @param v_bounce Whether to bounce or not in the vertical axis.
16311 * @see elm_scroller_bounce_set()
16315 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16318 * Get the bouncing behaviour of the internal scroller.
16320 * Get whether the internal scroller should bounce when the edge of each
16321 * axis is reached scrolling.
16323 * @param obj The list object.
16324 * @param h_bounce Pointer where to store the bounce state of the horizontal
16326 * @param v_bounce Pointer where to store the bounce state of the vertical
16329 * @see elm_scroller_bounce_get()
16330 * @see elm_list_bounce_set()
16334 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16337 * Set the scrollbar policy.
16339 * @param obj The list object
16340 * @param policy_h Horizontal scrollbar policy.
16341 * @param policy_v Vertical scrollbar policy.
16343 * This sets the scrollbar visibility policy for the given scroller.
16344 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16345 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16346 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16347 * This applies respectively for the horizontal and vertical scrollbars.
16349 * The both are disabled by default, i.e., are set to
16350 * #ELM_SCROLLER_POLICY_OFF.
16354 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16357 * Get the scrollbar policy.
16359 * @see elm_list_scroller_policy_get() for details.
16361 * @param obj The list object.
16362 * @param policy_h Pointer where to store horizontal scrollbar policy.
16363 * @param policy_v Pointer where to store vertical scrollbar policy.
16367 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);
16370 * Append a new item to the list object.
16372 * @param obj The list object.
16373 * @param label The label of the list item.
16374 * @param icon The icon object to use for the left side of the item. An
16375 * icon can be any Evas object, but usually it is an icon created
16376 * with elm_icon_add().
16377 * @param end The icon object to use for the right side of the item. An
16378 * icon can be any Evas object.
16379 * @param func The function to call when the item is clicked.
16380 * @param data The data to associate with the item for related callbacks.
16382 * @return The created item or @c NULL upon failure.
16384 * A new item will be created and appended to the list, i.e., will
16385 * be set as @b last item.
16387 * Items created with this method can be deleted with
16388 * elm_list_item_del().
16390 * Associated @p data can be properly freed when item is deleted if a
16391 * callback function is set with elm_list_item_del_cb_set().
16393 * If a function is passed as argument, it will be called everytime this item
16394 * is selected, i.e., the user clicks over an unselected item.
16395 * If always select is enabled it will call this function every time
16396 * user clicks over an item (already selected or not).
16397 * If such function isn't needed, just passing
16398 * @c NULL as @p func is enough. The same should be done for @p data.
16400 * Simple example (with no function callback or data associated):
16402 * li = elm_list_add(win);
16403 * ic = elm_icon_add(win);
16404 * elm_icon_file_set(ic, "path/to/image", NULL);
16405 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16406 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16408 * evas_object_show(li);
16411 * @see elm_list_always_select_mode_set()
16412 * @see elm_list_item_del()
16413 * @see elm_list_item_del_cb_set()
16414 * @see elm_list_clear()
16415 * @see elm_icon_add()
16419 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);
16422 * Prepend a new item to the list object.
16424 * @param obj The list object.
16425 * @param label The label of the list item.
16426 * @param icon The icon object to use for the left side of the item. An
16427 * icon can be any Evas object, but usually it is an icon created
16428 * with elm_icon_add().
16429 * @param end The icon object to use for the right side of the item. An
16430 * icon can be any Evas object.
16431 * @param func The function to call when the item is clicked.
16432 * @param data The data to associate with the item for related callbacks.
16434 * @return The created item or @c NULL upon failure.
16436 * A new item will be created and prepended to the list, i.e., will
16437 * be set as @b first item.
16439 * Items created with this method can be deleted with
16440 * elm_list_item_del().
16442 * Associated @p data can be properly freed when item is deleted if a
16443 * callback function is set with elm_list_item_del_cb_set().
16445 * If a function is passed as argument, it will be called everytime this item
16446 * is selected, i.e., the user clicks over an unselected item.
16447 * If always select is enabled it will call this function every time
16448 * user clicks over an item (already selected or not).
16449 * If such function isn't needed, just passing
16450 * @c NULL as @p func is enough. The same should be done for @p data.
16452 * @see elm_list_item_append() for a simple code example.
16453 * @see elm_list_always_select_mode_set()
16454 * @see elm_list_item_del()
16455 * @see elm_list_item_del_cb_set()
16456 * @see elm_list_clear()
16457 * @see elm_icon_add()
16461 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);
16464 * Insert a new item into the list object before item @p before.
16466 * @param obj The list object.
16467 * @param before The list item to insert before.
16468 * @param label The label of the list item.
16469 * @param icon The icon object to use for the left side of the item. An
16470 * icon can be any Evas object, but usually it is an icon created
16471 * with elm_icon_add().
16472 * @param end The icon object to use for the right side of the item. An
16473 * icon can be any Evas object.
16474 * @param func The function to call when the item is clicked.
16475 * @param data The data to associate with the item for related callbacks.
16477 * @return The created item or @c NULL upon failure.
16479 * A new item will be created and added to the list. Its position in
16480 * this list will be just before item @p before.
16482 * Items created with this method can be deleted with
16483 * elm_list_item_del().
16485 * Associated @p data can be properly freed when item is deleted if a
16486 * callback function is set with elm_list_item_del_cb_set().
16488 * If a function is passed as argument, it will be called everytime this item
16489 * is selected, i.e., the user clicks over an unselected item.
16490 * If always select is enabled it will call this function every time
16491 * user clicks over an item (already selected or not).
16492 * If such function isn't needed, just passing
16493 * @c NULL as @p func is enough. The same should be done for @p data.
16495 * @see elm_list_item_append() for a simple code example.
16496 * @see elm_list_always_select_mode_set()
16497 * @see elm_list_item_del()
16498 * @see elm_list_item_del_cb_set()
16499 * @see elm_list_clear()
16500 * @see elm_icon_add()
16504 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);
16507 * Insert a new item into the list object after item @p after.
16509 * @param obj The list object.
16510 * @param after The list item to insert after.
16511 * @param label The label of the list item.
16512 * @param icon The icon object to use for the left side of the item. An
16513 * icon can be any Evas object, but usually it is an icon created
16514 * with elm_icon_add().
16515 * @param end The icon object to use for the right side of the item. An
16516 * icon can be any Evas object.
16517 * @param func The function to call when the item is clicked.
16518 * @param data The data to associate with the item for related callbacks.
16520 * @return The created item or @c NULL upon failure.
16522 * A new item will be created and added to the list. Its position in
16523 * this list will be just after item @p after.
16525 * Items created with this method can be deleted with
16526 * elm_list_item_del().
16528 * Associated @p data can be properly freed when item is deleted if a
16529 * callback function is set with elm_list_item_del_cb_set().
16531 * If a function is passed as argument, it will be called everytime this item
16532 * is selected, i.e., the user clicks over an unselected item.
16533 * If always select is enabled it will call this function every time
16534 * user clicks over an item (already selected or not).
16535 * If such function isn't needed, just passing
16536 * @c NULL as @p func is enough. The same should be done for @p data.
16538 * @see elm_list_item_append() for a simple code example.
16539 * @see elm_list_always_select_mode_set()
16540 * @see elm_list_item_del()
16541 * @see elm_list_item_del_cb_set()
16542 * @see elm_list_clear()
16543 * @see elm_icon_add()
16547 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);
16550 * Insert a new item into the sorted list object.
16552 * @param obj The list object.
16553 * @param label The label of the list item.
16554 * @param icon The icon object to use for the left side of the item. An
16555 * icon can be any Evas object, but usually it is an icon created
16556 * with elm_icon_add().
16557 * @param end The icon object to use for the right side of the item. An
16558 * icon can be any Evas object.
16559 * @param func The function to call when the item is clicked.
16560 * @param data The data to associate with the item for related callbacks.
16561 * @param cmp_func The comparing function to be used to sort list
16562 * items <b>by #Elm_List_Item item handles</b>. This function will
16563 * receive two items and compare them, returning a non-negative integer
16564 * if the second item should be place after the first, or negative value
16565 * if should be placed before.
16567 * @return The created item or @c NULL upon failure.
16569 * @note This function inserts values into a list object assuming it was
16570 * sorted and the result will be sorted.
16572 * A new item will be created and added to the list. Its position in
16573 * this list will be found comparing the new item with previously inserted
16574 * items using function @p cmp_func.
16576 * Items created with this method can be deleted with
16577 * elm_list_item_del().
16579 * Associated @p data can be properly freed when item is deleted if a
16580 * callback function is set with elm_list_item_del_cb_set().
16582 * If a function is passed as argument, it will be called everytime this item
16583 * is selected, i.e., the user clicks over an unselected item.
16584 * If always select is enabled it will call this function every time
16585 * user clicks over an item (already selected or not).
16586 * If such function isn't needed, just passing
16587 * @c NULL as @p func is enough. The same should be done for @p data.
16589 * @see elm_list_item_append() for a simple code example.
16590 * @see elm_list_always_select_mode_set()
16591 * @see elm_list_item_del()
16592 * @see elm_list_item_del_cb_set()
16593 * @see elm_list_clear()
16594 * @see elm_icon_add()
16598 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);
16601 * Remove all list's items.
16603 * @param obj The list object
16605 * @see elm_list_item_del()
16606 * @see elm_list_item_append()
16610 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16613 * Get a list of all the list items.
16615 * @param obj The list object
16616 * @return An @c Eina_List of list items, #Elm_List_Item,
16617 * or @c NULL on failure.
16619 * @see elm_list_item_append()
16620 * @see elm_list_item_del()
16621 * @see elm_list_clear()
16625 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16628 * Get the selected item.
16630 * @param obj The list object.
16631 * @return The selected list item.
16633 * The selected item can be unselected with function
16634 * elm_list_item_selected_set().
16636 * The selected item always will be highlighted on list.
16638 * @see elm_list_selected_items_get()
16642 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16645 * Return a list of the currently selected list items.
16647 * @param obj The list object.
16648 * @return An @c Eina_List of list items, #Elm_List_Item,
16649 * or @c NULL on failure.
16651 * Multiple items can be selected if multi select is enabled. It can be
16652 * done with elm_list_multi_select_set().
16654 * @see elm_list_selected_item_get()
16655 * @see elm_list_multi_select_set()
16659 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16662 * Set the selected state of an item.
16664 * @param item The list item
16665 * @param selected The selected state
16667 * This sets the selected state of the given item @p it.
16668 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16670 * If a new item is selected the previosly selected will be unselected,
16671 * unless multiple selection is enabled with elm_list_multi_select_set().
16672 * Previoulsy selected item can be get with function
16673 * elm_list_selected_item_get().
16675 * Selected items will be highlighted.
16677 * @see elm_list_item_selected_get()
16678 * @see elm_list_selected_item_get()
16679 * @see elm_list_multi_select_set()
16683 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16686 * Get whether the @p item is selected or not.
16688 * @param item The list item.
16689 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16690 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16692 * @see elm_list_selected_item_set() for details.
16693 * @see elm_list_item_selected_get()
16697 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16700 * Set or unset item as a separator.
16702 * @param it The list item.
16703 * @param setting @c EINA_TRUE to set item @p it as separator or
16704 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16706 * Items aren't set as separator by default.
16708 * If set as separator it will display separator theme, so won't display
16711 * @see elm_list_item_separator_get()
16715 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16718 * Get a value whether item is a separator or not.
16720 * @see elm_list_item_separator_set() for details.
16722 * @param it The list item.
16723 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16724 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16728 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16731 * Show @p item in the list view.
16733 * @param item The list item to be shown.
16735 * It won't animate list until item is visible. If such behavior is wanted,
16736 * use elm_list_bring_in() intead.
16740 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16743 * Bring in the given item to list view.
16745 * @param item The item.
16747 * This causes list to jump to the given item @p item and show it
16748 * (by scrolling), if it is not fully visible.
16750 * This may use animation to do so and take a period of time.
16752 * If animation isn't wanted, elm_list_item_show() can be used.
16756 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16759 * Delete them item from the list.
16761 * @param item The item of list to be deleted.
16763 * If deleting all list items is required, elm_list_clear()
16764 * should be used instead of getting items list and deleting each one.
16766 * @see elm_list_clear()
16767 * @see elm_list_item_append()
16768 * @see elm_list_item_del_cb_set()
16772 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16775 * Set the function called when a list item is freed.
16777 * @param item The item to set the callback on
16778 * @param func The function called
16780 * If there is a @p func, then it will be called prior item's memory release.
16781 * That will be called with the following arguments:
16783 * @li item's Evas object;
16786 * This way, a data associated to a list item could be properly freed.
16790 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16793 * Get the data associated to the item.
16795 * @param item The list item
16796 * @return The data associated to @p item
16798 * The return value is a pointer to data associated to @p item when it was
16799 * created, with function elm_list_item_append() or similar. If no data
16800 * was passed as argument, it will return @c NULL.
16802 * @see elm_list_item_append()
16806 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16809 * Get the left side icon associated to the item.
16811 * @param item The list item
16812 * @return The left side icon associated to @p item
16814 * The return value is a pointer to the icon associated to @p item when
16816 * created, with function elm_list_item_append() or similar, or later
16817 * with function elm_list_item_icon_set(). If no icon
16818 * was passed as argument, it will return @c NULL.
16820 * @see elm_list_item_append()
16821 * @see elm_list_item_icon_set()
16825 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16828 * Set the left side icon associated to the item.
16830 * @param item The list item
16831 * @param icon The left side icon object to associate with @p item
16833 * The icon object to use at left side of the item. An
16834 * icon can be any Evas object, but usually it is an icon created
16835 * with elm_icon_add().
16837 * Once the icon object is set, a previously set one will be deleted.
16838 * @warning Setting the same icon for two items will cause the icon to
16839 * dissapear from the first item.
16841 * If an icon was passed as argument on item creation, with function
16842 * elm_list_item_append() or similar, it will be already
16843 * associated to the item.
16845 * @see elm_list_item_append()
16846 * @see elm_list_item_icon_get()
16850 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16853 * Get the right side icon associated to the item.
16855 * @param item The list item
16856 * @return The right side icon associated to @p item
16858 * The return value is a pointer to the icon associated to @p item when
16860 * created, with function elm_list_item_append() or similar, or later
16861 * with function elm_list_item_icon_set(). If no icon
16862 * was passed as argument, it will return @c NULL.
16864 * @see elm_list_item_append()
16865 * @see elm_list_item_icon_set()
16869 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16872 * Set the right side icon associated to the item.
16874 * @param item The list item
16875 * @param end The right side icon object to associate with @p item
16877 * The icon object to use at right side of the item. An
16878 * icon can be any Evas object, but usually it is an icon created
16879 * with elm_icon_add().
16881 * Once the icon object is set, a previously set one will be deleted.
16882 * @warning Setting the same icon for two items will cause the icon to
16883 * dissapear from the first item.
16885 * If an icon was passed as argument on item creation, with function
16886 * elm_list_item_append() or similar, it will be already
16887 * associated to the item.
16889 * @see elm_list_item_append()
16890 * @see elm_list_item_end_get()
16894 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
16895 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16898 * Gets the base object of the item.
16900 * @param item The list item
16901 * @return The base object associated with @p item
16903 * Base object is the @c Evas_Object that represents that item.
16907 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16910 * Get the label of item.
16912 * @param item The item of list.
16913 * @return The label of item.
16915 * The return value is a pointer to the label associated to @p item when
16916 * it was created, with function elm_list_item_append(), or later
16917 * with function elm_list_item_label_set. If no label
16918 * was passed as argument, it will return @c NULL.
16920 * @see elm_list_item_label_set() for more details.
16921 * @see elm_list_item_append()
16925 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16928 * Set the label of item.
16930 * @param item The item of list.
16931 * @param text The label of item.
16933 * The label to be displayed by the item.
16934 * Label will be placed between left and right side icons (if set).
16936 * If a label was passed as argument on item creation, with function
16937 * elm_list_item_append() or similar, it will be already
16938 * displayed by the item.
16940 * @see elm_list_item_label_get()
16941 * @see elm_list_item_append()
16945 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16949 * Get the item before @p it in list.
16951 * @param it The list item.
16952 * @return The item before @p it, or @c NULL if none or on failure.
16954 * @note If it is the first item, @c NULL will be returned.
16956 * @see elm_list_item_append()
16957 * @see elm_list_items_get()
16961 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16964 * Get the item after @p it in list.
16966 * @param it The list item.
16967 * @return The item after @p it, or @c NULL if none or on failure.
16969 * @note If it is the last item, @c NULL will be returned.
16971 * @see elm_list_item_append()
16972 * @see elm_list_items_get()
16976 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16979 * Sets the disabled/enabled state of a list item.
16981 * @param it The item.
16982 * @param disabled The disabled state.
16984 * A disabled item cannot be selected or unselected. It will also
16985 * change its appearance (generally greyed out). This sets the
16986 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
16991 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16994 * Get a value whether list item is disabled or not.
16996 * @param it The item.
16997 * @return The disabled state.
16999 * @see elm_list_item_disabled_set() for more details.
17003 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17006 * Set the text to be shown in a given list item's tooltips.
17008 * @param item Target item.
17009 * @param text The text to set in the content.
17011 * Setup the text as tooltip to object. The item can have only one tooltip,
17012 * so any previous tooltip data - set with this function or
17013 * elm_list_item_tooltip_content_cb_set() - is removed.
17015 * @see elm_object_tooltip_text_set() for more details.
17019 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17023 * @brief Disable size restrictions on an object's tooltip
17024 * @param item The tooltip's anchor object
17025 * @param disable If EINA_TRUE, size restrictions are disabled
17026 * @return EINA_FALSE on failure, EINA_TRUE on success
17028 * This function allows a tooltip to expand beyond its parant window's canvas.
17029 * It will instead be limited only by the size of the display.
17031 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17033 * @brief Retrieve size restriction state of an object's tooltip
17034 * @param obj The tooltip's anchor object
17035 * @return If EINA_TRUE, size restrictions are disabled
17037 * This function returns whether a tooltip is allowed to expand beyond
17038 * its parant window's canvas.
17039 * It will instead be limited only by the size of the display.
17041 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17044 * Set the content to be shown in the tooltip item.
17046 * Setup the tooltip to item. The item can have only one tooltip,
17047 * so any previous tooltip data is removed. @p func(with @p data) will
17048 * be called every time that need show the tooltip and it should
17049 * return a valid Evas_Object. This object is then managed fully by
17050 * tooltip system and is deleted when the tooltip is gone.
17052 * @param item the list item being attached a tooltip.
17053 * @param func the function used to create the tooltip contents.
17054 * @param data what to provide to @a func as callback data/context.
17055 * @param del_cb called when data is not needed anymore, either when
17056 * another callback replaces @a func, the tooltip is unset with
17057 * elm_list_item_tooltip_unset() or the owner @a item
17058 * dies. This callback receives as the first parameter the
17059 * given @a data, and @c event_info is the item.
17061 * @see elm_object_tooltip_content_cb_set() for more details.
17065 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);
17068 * Unset tooltip from item.
17070 * @param item list item to remove previously set tooltip.
17072 * Remove tooltip from item. The callback provided as del_cb to
17073 * elm_list_item_tooltip_content_cb_set() will be called to notify
17074 * it is not used anymore.
17076 * @see elm_object_tooltip_unset() for more details.
17077 * @see elm_list_item_tooltip_content_cb_set()
17081 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17084 * Sets a different style for this item tooltip.
17086 * @note before you set a style you should define a tooltip with
17087 * elm_list_item_tooltip_content_cb_set() or
17088 * elm_list_item_tooltip_text_set()
17090 * @param item list item with tooltip already set.
17091 * @param style the theme style to use (default, transparent, ...)
17093 * @see elm_object_tooltip_style_set() for more details.
17097 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17100 * Get the style for this item tooltip.
17102 * @param item list item with tooltip already set.
17103 * @return style the theme style in use, defaults to "default". If the
17104 * object does not have a tooltip set, then NULL is returned.
17106 * @see elm_object_tooltip_style_get() for more details.
17107 * @see elm_list_item_tooltip_style_set()
17111 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17114 * Set the type of mouse pointer/cursor decoration to be shown,
17115 * when the mouse pointer is over the given list widget item
17117 * @param item list item to customize cursor on
17118 * @param cursor the cursor type's name
17120 * This function works analogously as elm_object_cursor_set(), but
17121 * here the cursor's changing area is restricted to the item's
17122 * area, and not the whole widget's. Note that that item cursors
17123 * have precedence over widget cursors, so that a mouse over an
17124 * item with custom cursor set will always show @b that cursor.
17126 * If this function is called twice for an object, a previously set
17127 * cursor will be unset on the second call.
17129 * @see elm_object_cursor_set()
17130 * @see elm_list_item_cursor_get()
17131 * @see elm_list_item_cursor_unset()
17135 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17138 * Get the type of mouse pointer/cursor decoration set to be shown,
17139 * when the mouse pointer is over the given list widget item
17141 * @param item list item with custom cursor set
17142 * @return the cursor type's name or @c NULL, if no custom cursors
17143 * were set to @p item (and on errors)
17145 * @see elm_object_cursor_get()
17146 * @see elm_list_item_cursor_set()
17147 * @see elm_list_item_cursor_unset()
17151 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17154 * Unset any custom mouse pointer/cursor decoration set to be
17155 * shown, when the mouse pointer is over the given list widget
17156 * item, thus making it show the @b default cursor again.
17158 * @param item a list item
17160 * Use this call to undo any custom settings on this item's cursor
17161 * decoration, bringing it back to defaults (no custom style set).
17163 * @see elm_object_cursor_unset()
17164 * @see elm_list_item_cursor_set()
17168 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17171 * Set a different @b style for a given custom cursor set for a
17174 * @param item list item with custom cursor set
17175 * @param style the <b>theme style</b> to use (e.g. @c "default",
17176 * @c "transparent", etc)
17178 * This function only makes sense when one is using custom mouse
17179 * cursor decorations <b>defined in a theme file</b>, which can have,
17180 * given a cursor name/type, <b>alternate styles</b> on it. It
17181 * works analogously as elm_object_cursor_style_set(), but here
17182 * applyed only to list item objects.
17184 * @warning Before you set a cursor style you should have definen a
17185 * custom cursor previously on the item, with
17186 * elm_list_item_cursor_set()
17188 * @see elm_list_item_cursor_engine_only_set()
17189 * @see elm_list_item_cursor_style_get()
17193 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17196 * Get the current @b style set for a given list item's custom
17199 * @param item list item with custom cursor set.
17200 * @return style the cursor style in use. If the object does not
17201 * have a cursor set, then @c NULL is returned.
17203 * @see elm_list_item_cursor_style_set() for more details
17207 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17210 * Set if the (custom)cursor for a given list item should be
17211 * searched in its theme, also, or should only rely on the
17212 * rendering engine.
17214 * @param item item with custom (custom) cursor already set on
17215 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17216 * only on those provided by the rendering engine, @c EINA_FALSE to
17217 * have them searched on the widget's theme, as well.
17219 * @note This call is of use only if you've set a custom cursor
17220 * for list items, with elm_list_item_cursor_set().
17222 * @note By default, cursors will only be looked for between those
17223 * provided by the rendering engine.
17227 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17230 * Get if the (custom) cursor for a given list item is being
17231 * searched in its theme, also, or is only relying on the rendering
17234 * @param item a list item
17235 * @return @c EINA_TRUE, if cursors are being looked for only on
17236 * those provided by the rendering engine, @c EINA_FALSE if they
17237 * are being searched on the widget's theme, as well.
17239 * @see elm_list_item_cursor_engine_only_set(), for more details
17243 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17250 * @defgroup Slider Slider
17251 * @ingroup Elementary
17253 * @image html img/widget/slider/preview-00.png
17254 * @image latex img/widget/slider/preview-00.eps width=\textwidth
17256 * The slider adds a dragable āsliderā widget for selecting the value of
17257 * something within a range.
17259 * A slider can be horizontal or vertical. It can contain an Icon and has a
17260 * primary label as well as a units label (that is formatted with floating
17261 * point values and thus accepts a printf-style format string, like
17262 * ā%1.2f unitsā. There is also an indicator string that may be somewhere
17263 * else (like on the slider itself) that also accepts a format string like
17264 * units. Label, Icon Unit and Indicator strings/objects are optional.
17266 * A slider may be inverted which means values invert, with high vales being
17267 * on the left or top and low values on the right or bottom (as opposed to
17268 * normally being low on the left or top and high on the bottom and right).
17270 * The slider should have its minimum and maximum values set by the
17271 * application with elm_slider_min_max_set() and value should also be set by
17272 * the application before use with elm_slider_value_set(). The span of the
17273 * slider is its length (horizontally or vertically). This will be scaled by
17274 * the object or applications scaling factor. At any point code can query the
17275 * slider for its value with elm_slider_value_get().
17277 * Smart callbacks one can listen to:
17278 * - "changed" - Whenever the slider value is changed by the user.
17279 * - "slider,drag,start" - dragging the slider indicator around has started.
17280 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17281 * - "delay,changed" - A short time after the value is changed by the user.
17282 * This will be called only when the user stops dragging for
17283 * a very short period or when they release their
17284 * finger/mouse, so it avoids possibly expensive reactions to
17285 * the value change.
17287 * Available styles for it:
17290 * Default contents parts of the slider widget that you can use for are:
17291 * @li "icon" - A icon of the slider
17292 * @li "end" - A end part content of the slider
17294 * Default text parts of the silder widget that you can use for are:
17295 * @li "default" - Label of the silder
17296 * Here is an example on its usage:
17297 * @li @ref slider_example
17301 * @addtogroup Slider
17306 * Add a new slider widget to the given parent Elementary
17307 * (container) object.
17309 * @param parent The parent object.
17310 * @return a new slider widget handle or @c NULL, on errors.
17312 * This function inserts a new slider widget on the canvas.
17316 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17319 * Set the label of a given slider widget
17321 * @param obj The progress bar object
17322 * @param label The text label string, in UTF-8
17325 * @deprecated use elm_object_text_set() instead.
17327 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17330 * Get the label of a given slider widget
17332 * @param obj The progressbar object
17333 * @return The text label string, in UTF-8
17336 * @deprecated use elm_object_text_get() instead.
17338 EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17341 * Set the icon object of the slider object.
17343 * @param obj The slider object.
17344 * @param icon The icon object.
17346 * On horizontal mode, icon is placed at left, and on vertical mode,
17349 * @note Once the icon object is set, a previously set one will be deleted.
17350 * If you want to keep that old content object, use the
17351 * elm_slider_icon_unset() function.
17353 * @warning If the object being set does not have minimum size hints set,
17354 * it won't get properly displayed.
17357 * @deprecated use elm_object_part_content_set() instead.
17359 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17362 * Unset an icon set on a given slider widget.
17364 * @param obj The slider object.
17365 * @return The icon object that was being used, if any was set, or
17366 * @c NULL, otherwise (and on errors).
17368 * On horizontal mode, icon is placed at left, and on vertical mode,
17371 * This call will unparent and return the icon object which was set
17372 * for this widget, previously, on success.
17374 * @see elm_slider_icon_set() for more details
17375 * @see elm_slider_icon_get()
17376 * @deprecated use elm_object_part_content_unset() instead.
17380 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17383 * Retrieve the icon object set for a given slider widget.
17385 * @param obj The slider object.
17386 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17387 * otherwise (and on errors).
17389 * On horizontal mode, icon is placed at left, and on vertical mode,
17392 * @see elm_slider_icon_set() for more details
17393 * @see elm_slider_icon_unset()
17395 * @deprecated use elm_object_part_content_get() instead.
17399 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17402 * Set the end object of the slider object.
17404 * @param obj The slider object.
17405 * @param end The end object.
17407 * On horizontal mode, end is placed at left, and on vertical mode,
17408 * placed at bottom.
17410 * @note Once the icon object is set, a previously set one will be deleted.
17411 * If you want to keep that old content object, use the
17412 * elm_slider_end_unset() function.
17414 * @warning If the object being set does not have minimum size hints set,
17415 * it won't get properly displayed.
17417 * @deprecated use elm_object_part_content_set() instead.
17421 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17424 * Unset an end object set on a given slider widget.
17426 * @param obj The slider object.
17427 * @return The end object that was being used, if any was set, or
17428 * @c NULL, otherwise (and on errors).
17430 * On horizontal mode, end is placed at left, and on vertical mode,
17431 * placed at bottom.
17433 * This call will unparent and return the icon object which was set
17434 * for this widget, previously, on success.
17436 * @see elm_slider_end_set() for more details.
17437 * @see elm_slider_end_get()
17439 * @deprecated use elm_object_part_content_unset() instead
17444 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17447 * Retrieve the end object set for a given slider widget.
17449 * @param obj The slider object.
17450 * @return The end object's handle, if @p obj had one set, or @c NULL,
17451 * otherwise (and on errors).
17453 * On horizontal mode, icon is placed at right, and on vertical mode,
17454 * placed at bottom.
17456 * @see elm_slider_end_set() for more details.
17457 * @see elm_slider_end_unset()
17460 * @deprecated use elm_object_part_content_get() instead
17465 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17468 * Set the (exact) length of the bar region of a given slider widget.
17470 * @param obj The slider object.
17471 * @param size The length of the slider's bar region.
17473 * This sets the minimum width (when in horizontal mode) or height
17474 * (when in vertical mode) of the actual bar area of the slider
17475 * @p obj. This in turn affects the object's minimum size. Use
17476 * this when you're not setting other size hints expanding on the
17477 * given direction (like weight and alignment hints) and you would
17478 * like it to have a specific size.
17480 * @note Icon, end, label, indicator and unit text around @p obj
17481 * will require their
17482 * own space, which will make @p obj to require more the @p size,
17485 * @see elm_slider_span_size_get()
17489 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17492 * Get the length set for the bar region of a given slider widget
17494 * @param obj The slider object.
17495 * @return The length of the slider's bar region.
17497 * If that size was not set previously, with
17498 * elm_slider_span_size_set(), this call will return @c 0.
17502 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17505 * Set the format string for the unit label.
17507 * @param obj The slider object.
17508 * @param format The format string for the unit display.
17510 * Unit label is displayed all the time, if set, after slider's bar.
17511 * In horizontal mode, at right and in vertical mode, at bottom.
17513 * If @c NULL, unit label won't be visible. If not it sets the format
17514 * string for the label text. To the label text is provided a floating point
17515 * value, so the label text can display up to 1 floating point value.
17516 * Note that this is optional.
17518 * Use a format string such as "%1.2f meters" for example, and it will
17519 * display values like: "3.14 meters" for a value equal to 3.14159.
17521 * Default is unit label disabled.
17523 * @see elm_slider_indicator_format_get()
17527 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17530 * Get the unit label format of the slider.
17532 * @param obj The slider object.
17533 * @return The unit label format string in UTF-8.
17535 * Unit label is displayed all the time, if set, after slider's bar.
17536 * In horizontal mode, at right and in vertical mode, at bottom.
17538 * @see elm_slider_unit_format_set() for more
17539 * information on how this works.
17543 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17546 * Set the format string for the indicator label.
17548 * @param obj The slider object.
17549 * @param indicator The format string for the indicator display.
17551 * The slider may display its value somewhere else then unit label,
17552 * for example, above the slider knob that is dragged around. This function
17553 * sets the format string used for this.
17555 * If @c NULL, indicator label won't be visible. If not it sets the format
17556 * string for the label text. To the label text is provided a floating point
17557 * value, so the label text can display up to 1 floating point value.
17558 * Note that this is optional.
17560 * Use a format string such as "%1.2f meters" for example, and it will
17561 * display values like: "3.14 meters" for a value equal to 3.14159.
17563 * Default is indicator label disabled.
17565 * @see elm_slider_indicator_format_get()
17569 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17572 * Get the indicator label format of the slider.
17574 * @param obj The slider object.
17575 * @return The indicator label format string in UTF-8.
17577 * The slider may display its value somewhere else then unit label,
17578 * for example, above the slider knob that is dragged around. This function
17579 * gets the format string used for this.
17581 * @see elm_slider_indicator_format_set() for more
17582 * information on how this works.
17586 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17589 * Set the format function pointer for the indicator label
17591 * @param obj The slider object.
17592 * @param func The indicator format function.
17593 * @param free_func The freeing function for the format string.
17595 * Set the callback function to format the indicator string.
17597 * @see elm_slider_indicator_format_set() for more info on how this works.
17601 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);
17604 * Set the format function pointer for the units label
17606 * @param obj The slider object.
17607 * @param func The units format function.
17608 * @param free_func The freeing function for the format string.
17610 * Set the callback function to format the indicator string.
17612 * @see elm_slider_units_format_set() for more info on how this works.
17616 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);
17619 * Set the orientation of a given slider widget.
17621 * @param obj The slider object.
17622 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17623 * @b horizontal, @c EINA_FALSE to make it @b vertical.
17625 * Use this function to change how your slider is to be
17626 * disposed: vertically or horizontally.
17628 * By default it's displayed horizontally.
17630 * @see elm_slider_horizontal_get()
17634 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17637 * Retrieve the orientation of a given slider widget
17639 * @param obj The slider object.
17640 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17641 * @c EINA_FALSE if it's @b vertical (and on errors).
17643 * @see elm_slider_horizontal_set() for more details.
17647 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17650 * Set the minimum and maximum values for the slider.
17652 * @param obj The slider object.
17653 * @param min The minimum value.
17654 * @param max The maximum value.
17656 * Define the allowed range of values to be selected by the user.
17658 * If actual value is less than @p min, it will be updated to @p min. If it
17659 * is bigger then @p max, will be updated to @p max. Actual value can be
17660 * get with elm_slider_value_get().
17662 * By default, min is equal to 0.0, and max is equal to 1.0.
17664 * @warning Maximum must be greater than minimum, otherwise behavior
17667 * @see elm_slider_min_max_get()
17671 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17674 * Get the minimum and maximum values of the slider.
17676 * @param obj The slider object.
17677 * @param min Pointer where to store the minimum value.
17678 * @param max Pointer where to store the maximum value.
17680 * @note If only one value is needed, the other pointer can be passed
17683 * @see elm_slider_min_max_set() for details.
17687 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17690 * Set the value the slider displays.
17692 * @param obj The slider object.
17693 * @param val The value to be displayed.
17695 * Value will be presented on the unit label following format specified with
17696 * elm_slider_unit_format_set() and on indicator with
17697 * elm_slider_indicator_format_set().
17699 * @warning The value must to be between min and max values. This values
17700 * are set by elm_slider_min_max_set().
17702 * @see elm_slider_value_get()
17703 * @see elm_slider_unit_format_set()
17704 * @see elm_slider_indicator_format_set()
17705 * @see elm_slider_min_max_set()
17709 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17712 * Get the value displayed by the spinner.
17714 * @param obj The spinner object.
17715 * @return The value displayed.
17717 * @see elm_spinner_value_set() for details.
17721 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17724 * Invert a given slider widget's displaying values order
17726 * @param obj The slider object.
17727 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17728 * @c EINA_FALSE to bring it back to default, non-inverted values.
17730 * A slider may be @b inverted, in which state it gets its
17731 * values inverted, with high vales being on the left or top and
17732 * low values on the right or bottom, as opposed to normally have
17733 * the low values on the former and high values on the latter,
17734 * respectively, for horizontal and vertical modes.
17736 * @see elm_slider_inverted_get()
17740 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17743 * Get whether a given slider widget's displaying values are
17746 * @param obj The slider object.
17747 * @return @c EINA_TRUE, if @p obj has inverted values,
17748 * @c EINA_FALSE otherwise (and on errors).
17750 * @see elm_slider_inverted_set() for more details.
17754 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17757 * Set whether to enlarge slider indicator (augmented knob) or not.
17759 * @param obj The slider object.
17760 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17761 * let the knob always at default size.
17763 * By default, indicator will be bigger while dragged by the user.
17765 * @warning It won't display values set with
17766 * elm_slider_indicator_format_set() if you disable indicator.
17770 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17773 * Get whether a given slider widget's enlarging indicator or not.
17775 * @param obj The slider object.
17776 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17777 * @c EINA_FALSE otherwise (and on errors).
17779 * @see elm_slider_indicator_show_set() for details.
17783 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17790 * @addtogroup Actionslider Actionslider
17792 * @image html img/widget/actionslider/preview-00.png
17793 * @image latex img/widget/actionslider/preview-00.eps
17795 * An actionslider is a switcher for 2 or 3 labels with customizable magnet
17796 * properties. The user drags and releases the indicator, to choose a label.
17798 * Labels occupy the following positions.
17803 * Positions can be enabled or disabled.
17805 * Magnets can be set on the above positions.
17807 * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
17809 * @note By default all positions are set as enabled.
17811 * Signals that you can add callbacks for are:
17813 * "selected" - when user selects an enabled position (the label is passed
17816 * "pos_changed" - when the indicator reaches any of the positions("left",
17817 * "right" or "center").
17819 * See an example of actionslider usage @ref actionslider_example_page "here"
17823 typedef enum _Elm_Actionslider_Indicator_Pos
17825 ELM_ACTIONSLIDER_INDICATOR_NONE,
17826 ELM_ACTIONSLIDER_INDICATOR_LEFT,
17827 ELM_ACTIONSLIDER_INDICATOR_RIGHT,
17828 ELM_ACTIONSLIDER_INDICATOR_CENTER
17829 } Elm_Actionslider_Indicator_Pos;
17831 typedef enum _Elm_Actionslider_Magnet_Pos
17833 ELM_ACTIONSLIDER_MAGNET_NONE = 0,
17834 ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
17835 ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
17836 ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
17837 ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
17838 ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
17839 } Elm_Actionslider_Magnet_Pos;
17841 typedef enum _Elm_Actionslider_Label_Pos
17843 ELM_ACTIONSLIDER_LABEL_LEFT,
17844 ELM_ACTIONSLIDER_LABEL_RIGHT,
17845 ELM_ACTIONSLIDER_LABEL_CENTER,
17846 ELM_ACTIONSLIDER_LABEL_BUTTON
17847 } Elm_Actionslider_Label_Pos;
17849 /* smart callbacks called:
17850 * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
17854 * Add a new actionslider to the parent.
17856 * @param parent The parent object
17857 * @return The new actionslider object or NULL if it cannot be created
17859 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17862 * Set actionslider label.
17864 * @param[in] obj The actionslider object
17865 * @param[in] pos The position of the label.
17866 * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
17867 * @param label The label which is going to be set.
17869 EAPI void elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
17871 * Get actionslider labels.
17873 * @param obj The actionslider object
17874 * @param left_label A char** to place the left_label of @p obj into.
17875 * @param center_label A char** to place the center_label of @p obj into.
17876 * @param right_label A char** to place the right_label of @p obj into.
17878 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);
17880 * Get actionslider selected label.
17882 * @param obj The actionslider object
17883 * @return The selected label
17885 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17887 * Set actionslider indicator position.
17889 * @param obj The actionslider object.
17890 * @param pos The position of the indicator.
17892 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
17894 * Get actionslider indicator position.
17896 * @param obj The actionslider object.
17897 * @return The position of the indicator.
17899 EAPI Elm_Actionslider_Indicator_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17901 * Set actionslider magnet position. To make multiple positions magnets @c or
17902 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
17904 * @param obj The actionslider object.
17905 * @param pos Bit mask indicating the magnet positions.
17907 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
17909 * Get actionslider magnet position.
17911 * @param obj The actionslider object.
17912 * @return The positions with magnet property.
17914 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17916 * Set actionslider enabled position. To set multiple positions as enabled @c or
17917 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
17919 * @note All the positions are enabled by default.
17921 * @param obj The actionslider object.
17922 * @param pos Bit mask indicating the enabled positions.
17924 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
17926 * Get actionslider enabled position.
17928 * @param obj The actionslider object.
17929 * @return The enabled positions.
17931 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17933 * Set the label used on the indicator.
17935 * @param obj The actionslider object
17936 * @param label The label to be set on the indicator.
17937 * @deprecated use elm_object_text_set() instead.
17939 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17941 * Get the label used on the indicator object.
17943 * @param obj The actionslider object
17944 * @return The indicator label
17945 * @deprecated use elm_object_text_get() instead.
17947 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
17950 * Hold actionslider object movement.
17952 * @param[in] obj The actionslider object
17953 * @param[in] flag Actionslider hold/release
17954 * (EINA_TURE = hold/EIN_FALSE = release)
17956 * @ingroup Actionslider
17958 EAPI void elm_actionslider_hold(Evas_Object *obj, Eina_Bool flag) EINA_ARG_NONNULL(1);
17966 * @defgroup Genlist Genlist
17968 * @image html img/widget/genlist/preview-00.png
17969 * @image latex img/widget/genlist/preview-00.eps
17970 * @image html img/genlist.png
17971 * @image latex img/genlist.eps
17973 * This widget aims to have more expansive list than the simple list in
17974 * Elementary that could have more flexible items and allow many more entries
17975 * while still being fast and low on memory usage. At the same time it was
17976 * also made to be able to do tree structures. But the price to pay is more
17977 * complexity when it comes to usage. If all you want is a simple list with
17978 * icons and a single label, use the normal @ref List object.
17980 * Genlist has a fairly large API, mostly because it's relatively complex,
17981 * trying to be both expansive, powerful and efficient. First we will begin
17982 * an overview on the theory behind genlist.
17984 * @section Genlist_Item_Class Genlist item classes - creating items
17986 * In order to have the ability to add and delete items on the fly, genlist
17987 * implements a class (callback) system where the application provides a
17988 * structure with information about that type of item (genlist may contain
17989 * multiple different items with different classes, states and styles).
17990 * Genlist will call the functions in this struct (methods) when an item is
17991 * "realized" (i.e., created dynamically, while the user is scrolling the
17992 * grid). All objects will simply be deleted when no longer needed with
17993 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
17994 * following members:
17995 * - @c item_style - This is a constant string and simply defines the name
17996 * of the item style. It @b must be specified and the default should be @c
17999 * - @c func - A struct with pointers to functions that will be called when
18000 * an item is going to be actually created. All of them receive a @c data
18001 * parameter that will point to the same data passed to
18002 * elm_genlist_item_append() and related item creation functions, and a @c
18003 * obj parameter that points to the genlist object itself.
18005 * The function pointers inside @c func are @c label_get, @c icon_get, @c
18006 * state_get and @c del. The 3 first functions also receive a @c part
18007 * parameter described below. A brief description of these functions follows:
18009 * - @c label_get - The @c part parameter is the name string of one of the
18010 * existing text parts in the Edje group implementing the item's theme.
18011 * This function @b must return a strdup'()ed string, as the caller will
18012 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
18013 * - @c content_get - The @c part parameter is the name string of one of the
18014 * existing (content) swallow parts in the Edje group implementing the item's
18015 * theme. It must return @c NULL, when no content is desired, or a valid
18016 * object handle, otherwise. The object will be deleted by the genlist on
18017 * its deletion or when the item is "unrealized". See
18018 * #Elm_Genlist_Item_Icon_Get_Cb.
18019 * - @c func.state_get - The @c part parameter is the name string of one of
18020 * the state parts in the Edje group implementing the item's theme. Return
18021 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
18022 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
18023 * and @c "elm" as "emission" and "source" arguments, respectively, when
18024 * the state is true (the default is false), where @c XXX is the name of
18025 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
18026 * - @c func.del - This is intended for use when genlist items are deleted,
18027 * so any data attached to the item (e.g. its data parameter on creation)
18028 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
18030 * available item styles:
18032 * - default_style - The text part is a textblock
18034 * @image html img/widget/genlist/preview-04.png
18035 * @image latex img/widget/genlist/preview-04.eps
18039 * @image html img/widget/genlist/preview-01.png
18040 * @image latex img/widget/genlist/preview-01.eps
18042 * - icon_top_text_bottom
18044 * @image html img/widget/genlist/preview-02.png
18045 * @image latex img/widget/genlist/preview-02.eps
18049 * @image html img/widget/genlist/preview-03.png
18050 * @image latex img/widget/genlist/preview-03.eps
18052 * @section Genlist_Items Structure of items
18054 * An item in a genlist can have 0 or more text labels (they can be regular
18055 * text or textblock Evas objects - that's up to the style to determine), 0
18056 * or more contents (which are simply objects swallowed into the genlist item's
18057 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18058 * behavior left to the user to define. The Edje part names for each of
18059 * these properties will be looked up, in the theme file for the genlist,
18060 * under the Edje (string) data items named @c "labels", @c "contents" and @c
18061 * "states", respectively. For each of those properties, if more than one
18062 * part is provided, they must have names listed separated by spaces in the
18063 * data fields. For the default genlist item theme, we have @b one label
18064 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18065 * "elm.swallow.end") and @b no state parts.
18067 * A genlist item may be at one of several styles. Elementary provides one
18068 * by default - "default", but this can be extended by system or application
18069 * custom themes/overlays/extensions (see @ref Theme "themes" for more
18072 * @section Genlist_Manipulation Editing and Navigating
18074 * Items can be added by several calls. All of them return a @ref
18075 * Elm_Genlist_Item handle that is an internal member inside the genlist.
18076 * They all take a data parameter that is meant to be used for a handle to
18077 * the applications internal data (eg the struct with the original item
18078 * data). The parent parameter is the parent genlist item this belongs to if
18079 * it is a tree or an indexed group, and NULL if there is no parent. The
18080 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18081 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18082 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18083 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
18084 * is set then this item is group index item that is displayed at the top
18085 * until the next group comes. The func parameter is a convenience callback
18086 * that is called when the item is selected and the data parameter will be
18087 * the func_data parameter, obj be the genlist object and event_info will be
18088 * the genlist item.
18090 * elm_genlist_item_append() adds an item to the end of the list, or if
18091 * there is a parent, to the end of all the child items of the parent.
18092 * elm_genlist_item_prepend() is the same but adds to the beginning of
18093 * the list or children list. elm_genlist_item_insert_before() inserts at
18094 * item before another item and elm_genlist_item_insert_after() inserts after
18095 * the indicated item.
18097 * The application can clear the list with elm_gen_clear() which deletes
18098 * all the items in the list and elm_genlist_item_del() will delete a specific
18099 * item. elm_genlist_item_subitems_clear() will clear all items that are
18100 * children of the indicated parent item.
18102 * To help inspect list items you can jump to the item at the top of the list
18103 * with elm_genlist_first_item_get() which will return the item pointer, and
18104 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18105 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18106 * and previous items respectively relative to the indicated item. Using
18107 * these calls you can walk the entire item list/tree. Note that as a tree
18108 * the items are flattened in the list, so elm_genlist_item_parent_get() will
18109 * let you know which item is the parent (and thus know how to skip them if
18112 * @section Genlist_Muti_Selection Multi-selection
18114 * If the application wants multiple items to be able to be selected,
18115 * elm_genlist_multi_select_set() can enable this. If the list is
18116 * single-selection only (the default), then elm_genlist_selected_item_get()
18117 * will return the selected item, if any, or NULL I none is selected. If the
18118 * list is multi-select then elm_genlist_selected_items_get() will return a
18119 * list (that is only valid as long as no items are modified (added, deleted,
18120 * selected or unselected)).
18122 * @section Genlist_Usage_Hints Usage hints
18124 * There are also convenience functions. elm_gen_item_genlist_get() will
18125 * return the genlist object the item belongs to. elm_genlist_item_show()
18126 * will make the scroller scroll to show that specific item so its visible.
18127 * elm_genlist_item_data_get() returns the data pointer set by the item
18128 * creation functions.
18130 * If an item changes (state of boolean changes, label or contents change),
18131 * then use elm_genlist_item_update() to have genlist update the item with
18132 * the new state. Genlist will re-realize the item thus call the functions
18133 * in the _Elm_Genlist_Item_Class for that item.
18135 * To programmatically (un)select an item use elm_genlist_item_selected_set().
18136 * To get its selected state use elm_genlist_item_selected_get(). Similarly
18137 * to expand/contract an item and get its expanded state, use
18138 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18139 * again to make an item disabled (unable to be selected and appear
18140 * differently) use elm_genlist_item_disabled_set() to set this and
18141 * elm_genlist_item_disabled_get() to get the disabled state.
18143 * In general to indicate how the genlist should expand items horizontally to
18144 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18145 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18146 * mode means that if items are too wide to fit, the scroller will scroll
18147 * horizontally. Otherwise items are expanded to fill the width of the
18148 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18149 * to the viewport width and limited to that size. This can be combined with
18150 * a different style that uses edjes' ellipsis feature (cutting text off like
18153 * Items will only call their selection func and callback when first becoming
18154 * selected. Any further clicks will do nothing, unless you enable always
18155 * select with elm_gen_always_select_mode_set(). This means even if
18156 * selected, every click will make the selected callbacks be called.
18157 * elm_genlist_no_select_mode_set() will turn off the ability to select
18158 * items entirely and they will neither appear selected nor call selected
18159 * callback functions.
18161 * Remember that you can create new styles and add your own theme augmentation
18162 * per application with elm_theme_extension_add(). If you absolutely must
18163 * have a specific style that overrides any theme the user or system sets up
18164 * you can use elm_theme_overlay_add() to add such a file.
18166 * @section Genlist_Implementation Implementation
18168 * Evas tracks every object you create. Every time it processes an event
18169 * (mouse move, down, up etc.) it needs to walk through objects and find out
18170 * what event that affects. Even worse every time it renders display updates,
18171 * in order to just calculate what to re-draw, it needs to walk through many
18172 * many many objects. Thus, the more objects you keep active, the more
18173 * overhead Evas has in just doing its work. It is advisable to keep your
18174 * active objects to the minimum working set you need. Also remember that
18175 * object creation and deletion carries an overhead, so there is a
18176 * middle-ground, which is not easily determined. But don't keep massive lists
18177 * of objects you can't see or use. Genlist does this with list objects. It
18178 * creates and destroys them dynamically as you scroll around. It groups them
18179 * into blocks so it can determine the visibility etc. of a whole block at
18180 * once as opposed to having to walk the whole list. This 2-level list allows
18181 * for very large numbers of items to be in the list (tests have used up to
18182 * 2,000,000 items). Also genlist employs a queue for adding items. As items
18183 * may be different sizes, every item added needs to be calculated as to its
18184 * size and thus this presents a lot of overhead on populating the list, this
18185 * genlist employs a queue. Any item added is queued and spooled off over
18186 * time, actually appearing some time later, so if your list has many members
18187 * you may find it takes a while for them to all appear, with your process
18188 * consuming a lot of CPU while it is busy spooling.
18190 * Genlist also implements a tree structure, but it does so with callbacks to
18191 * the application, with the application filling in tree structures when
18192 * requested (allowing for efficient building of a very deep tree that could
18193 * even be used for file-management). See the above smart signal callbacks for
18196 * @section Genlist_Smart_Events Genlist smart events
18198 * Signals that you can add callbacks for are:
18199 * - @c "activated" - The user has double-clicked or pressed
18200 * (enter|return|spacebar) on an item. The @c event_info parameter is the
18201 * item that was activated.
18202 * - @c "clicked,double" - The user has double-clicked an item. The @c
18203 * event_info parameter is the item that was double-clicked.
18204 * - @c "selected" - This is called when a user has made an item selected.
18205 * The event_info parameter is the genlist item that was selected.
18206 * - @c "unselected" - This is called when a user has made an item
18207 * unselected. The event_info parameter is the genlist item that was
18209 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18210 * called and the item is now meant to be expanded. The event_info
18211 * parameter is the genlist item that was indicated to expand. It is the
18212 * job of this callback to then fill in the child items.
18213 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18214 * called and the item is now meant to be contracted. The event_info
18215 * parameter is the genlist item that was indicated to contract. It is the
18216 * job of this callback to then delete the child items.
18217 * - @c "expand,request" - This is called when a user has indicated they want
18218 * to expand a tree branch item. The callback should decide if the item can
18219 * expand (has any children) and then call elm_genlist_item_expanded_set()
18220 * appropriately to set the state. The event_info parameter is the genlist
18221 * item that was indicated to expand.
18222 * - @c "contract,request" - This is called when a user has indicated they
18223 * want to contract a tree branch item. The callback should decide if the
18224 * item can contract (has any children) and then call
18225 * elm_genlist_item_expanded_set() appropriately to set the state. The
18226 * event_info parameter is the genlist item that was indicated to contract.
18227 * - @c "realized" - This is called when the item in the list is created as a
18228 * real evas object. event_info parameter is the genlist item that was
18229 * created. The object may be deleted at any time, so it is up to the
18230 * caller to not use the object pointer from elm_genlist_item_object_get()
18231 * in a way where it may point to freed objects.
18232 * - @c "unrealized" - This is called just before an item is unrealized.
18233 * After this call content objects provided will be deleted and the item
18234 * object itself delete or be put into a floating cache.
18235 * - @c "drag,start,up" - This is called when the item in the list has been
18236 * dragged (not scrolled) up.
18237 * - @c "drag,start,down" - This is called when the item in the list has been
18238 * dragged (not scrolled) down.
18239 * - @c "drag,start,left" - This is called when the item in the list has been
18240 * dragged (not scrolled) left.
18241 * - @c "drag,start,right" - This is called when the item in the list has
18242 * been dragged (not scrolled) right.
18243 * - @c "drag,stop" - This is called when the item in the list has stopped
18245 * - @c "drag" - This is called when the item in the list is being dragged.
18246 * - @c "longpressed" - This is called when the item is pressed for a certain
18247 * amount of time. By default it's 1 second.
18248 * - @c "scroll,anim,start" - This is called when scrolling animation has
18250 * - @c "scroll,anim,stop" - This is called when scrolling animation has
18252 * - @c "scroll,drag,start" - This is called when dragging the content has
18254 * - @c "scroll,drag,stop" - This is called when dragging the content has
18256 * - @c "edge,top" - This is called when the genlist is scrolled until
18258 * - @c "edge,bottom" - This is called when the genlist is scrolled
18259 * until the bottom edge.
18260 * - @c "edge,left" - This is called when the genlist is scrolled
18261 * until the left edge.
18262 * - @c "edge,right" - This is called when the genlist is scrolled
18263 * until the right edge.
18264 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18266 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18268 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18270 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18272 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18273 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
18274 * multi-touch pinched in.
18275 * - @c "swipe" - This is called when the genlist is swiped.
18276 * - @c "moved" - This is called when a genlist item is moved.
18277 * - @c "language,changed" - This is called when the program's language is
18280 * @section Genlist_Examples Examples
18282 * Here is a list of examples that use the genlist, trying to show some of
18283 * its capabilities:
18284 * - @ref genlist_example_01
18285 * - @ref genlist_example_02
18286 * - @ref genlist_example_03
18287 * - @ref genlist_example_04
18288 * - @ref genlist_example_05
18292 * @addtogroup Genlist
18297 * @enum _Elm_Genlist_Item_Flags
18298 * @typedef Elm_Genlist_Item_Flags
18300 * Defines if the item is of any special type (has subitems or it's the
18301 * index of a group), or is just a simple item.
18305 typedef enum _Elm_Genlist_Item_Flags
18307 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18308 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18309 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18310 } Elm_Genlist_Item_Flags;
18311 typedef enum _Elm_Genlist_Item_Field_Flags
18313 ELM_GENLIST_ITEM_FIELD_ALL = 0,
18314 ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
18315 ELM_GENLIST_ITEM_FIELD_ICON = (1 << 1),
18316 ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
18317 } Elm_Genlist_Item_Field_Flags;
18318 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
18319 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18320 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
18321 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
18322 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
18323 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
18324 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj);
18325 typedef void (*GenlistItemMovedFunc) ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
18328 * @struct _Elm_Genlist_Item_Class
18330 * Genlist item class definition structs.
18332 * This struct contains the style and fetching functions that will define the
18333 * contents of each item.
18335 * @see @ref Genlist_Item_Class
18337 struct _Elm_Genlist_Item_Class
18339 const char *item_style;
18341 GenlistItemLabelGetFunc label_get;
18342 GenlistItemIconGetFunc icon_get;
18343 GenlistItemStateGetFunc state_get;
18344 GenlistItemDelFunc del;
18345 GenlistItemMovedFunc moved;
18347 const char *edit_item_style;
18348 const char *mode_item_style;
18350 #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18352 * Add a new genlist widget to the given parent Elementary
18353 * (container) object
18355 * @param parent The parent object
18356 * @return a new genlist widget handle or @c NULL, on errors
18358 * This function inserts a new genlist widget on the canvas.
18360 * @see elm_genlist_item_append()
18361 * @see elm_genlist_item_del()
18362 * @see elm_gen_clear()
18366 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18368 * Remove all items from a given genlist widget.
18370 * @param obj The genlist object
18372 * This removes (and deletes) all items in @p obj, leaving it empty.
18374 * @see elm_genlist_item_del(), to remove just one item.
18378 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18380 * Enable or disable multi-selection in the genlist
18382 * @param obj The genlist object
18383 * @param multi Multi-select enable/disable. Default is disabled.
18385 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18386 * the list. This allows more than 1 item to be selected. To retrieve the list
18387 * of selected items, use elm_genlist_selected_items_get().
18389 * @see elm_genlist_selected_items_get()
18390 * @see elm_genlist_multi_select_get()
18394 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18396 * Gets if multi-selection in genlist is enabled or disabled.
18398 * @param obj The genlist object
18399 * @return Multi-select enabled/disabled
18400 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18402 * @see elm_genlist_multi_select_set()
18406 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18408 * This sets the horizontal stretching mode.
18410 * @param obj The genlist object
18411 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18413 * This sets the mode used for sizing items horizontally. Valid modes
18414 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18415 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18416 * the scroller will scroll horizontally. Otherwise items are expanded
18417 * to fill the width of the viewport of the scroller. If it is
18418 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18419 * limited to that size.
18421 * @see elm_genlist_horizontal_get()
18425 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18427 * Gets the horizontal stretching mode.
18429 * @param obj The genlist object
18430 * @return The mode to use
18431 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18433 * @see elm_genlist_horizontal_set()
18437 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18439 * Set the always select mode.
18441 * @param obj The genlist object
18442 * @param always_select The always select mode (@c EINA_TRUE = on, @c
18443 * EINA_FALSE = off). Default is @c EINA_FALSE.
18445 * Items will only call their selection func and callback when first
18446 * becoming selected. Any further clicks will do nothing, unless you
18447 * enable always select with elm_genlist_always_select_mode_set().
18448 * This means that, even if selected, every click will make the selected
18449 * callbacks be called.
18451 * @see elm_genlist_always_select_mode_get()
18455 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18457 * Get the always select mode.
18459 * @param obj The genlist object
18460 * @return The always select mode
18461 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18463 * @see elm_genlist_always_select_mode_set()
18467 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18469 * Enable/disable the no select mode.
18471 * @param obj The genlist object
18472 * @param no_select The no select mode
18473 * (EINA_TRUE = on, EINA_FALSE = off)
18475 * This will turn off the ability to select items entirely and they
18476 * will neither appear selected nor call selected callback functions.
18478 * @see elm_genlist_no_select_mode_get()
18482 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18484 * Gets whether the no select mode is enabled.
18486 * @param obj The genlist object
18487 * @return The no select mode
18488 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18490 * @see elm_genlist_no_select_mode_set()
18494 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18496 * Enable/disable compress mode.
18498 * @param obj The genlist object
18499 * @param compress The compress mode
18500 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18502 * This will enable the compress mode where items are "compressed"
18503 * horizontally to fit the genlist scrollable viewport width. This is
18504 * special for genlist. Do not rely on
18505 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18506 * work as genlist needs to handle it specially.
18508 * @see elm_genlist_compress_mode_get()
18512 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18514 * Get whether the compress mode is enabled.
18516 * @param obj The genlist object
18517 * @return The compress mode
18518 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18520 * @see elm_genlist_compress_mode_set()
18524 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18526 * Enable/disable height-for-width mode.
18528 * @param obj The genlist object
18529 * @param setting The height-for-width mode (@c EINA_TRUE = on,
18530 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18532 * With height-for-width mode the item width will be fixed (restricted
18533 * to a minimum of) to the list width when calculating its size in
18534 * order to allow the height to be calculated based on it. This allows,
18535 * for instance, text block to wrap lines if the Edje part is
18536 * configured with "text.min: 0 1".
18538 * @note This mode will make list resize slower as it will have to
18539 * recalculate every item height again whenever the list width
18542 * @note When height-for-width mode is enabled, it also enables
18543 * compress mode (see elm_genlist_compress_mode_set()) and
18544 * disables homogeneous (see elm_genlist_homogeneous_set()).
18548 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18550 * Get whether the height-for-width mode is enabled.
18552 * @param obj The genlist object
18553 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18558 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18560 * Enable/disable horizontal and vertical bouncing effect.
18562 * @param obj The genlist object
18563 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18564 * EINA_FALSE = off). Default is @c EINA_FALSE.
18565 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18566 * EINA_FALSE = off). Default is @c EINA_TRUE.
18568 * This will enable or disable the scroller bouncing effect for the
18569 * genlist. See elm_scroller_bounce_set() for details.
18571 * @see elm_scroller_bounce_set()
18572 * @see elm_genlist_bounce_get()
18576 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18578 * Get whether the horizontal and vertical bouncing effect is enabled.
18580 * @param obj The genlist object
18581 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18583 * @param v_bounce Pointer to a bool to receive if the bounce vertically
18586 * @see elm_genlist_bounce_set()
18590 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18592 * Enable/disable homogenous mode.
18594 * @param obj The genlist object
18595 * @param homogeneous Assume the items within the genlist are of the
18596 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18599 * This will enable the homogeneous mode where items are of the same
18600 * height and width so that genlist may do the lazy-loading at its
18601 * maximum (which increases the performance for scrolling the list). This
18602 * implies 'compressed' mode.
18604 * @see elm_genlist_compress_mode_set()
18605 * @see elm_genlist_homogeneous_get()
18609 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18611 * Get whether the homogenous mode is enabled.
18613 * @param obj The genlist object
18614 * @return Assume the items within the genlist are of the same height
18615 * and width (EINA_TRUE = on, EINA_FALSE = off)
18617 * @see elm_genlist_homogeneous_set()
18621 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18623 * Set the maximum number of items within an item block
18625 * @param obj The genlist object
18626 * @param n Maximum number of items within an item block. Default is 32.
18628 * This will configure the block count to tune to the target with
18629 * particular performance matrix.
18631 * A block of objects will be used to reduce the number of operations due to
18632 * many objects in the screen. It can determine the visibility, or if the
18633 * object has changed, it theme needs to be updated, etc. doing this kind of
18634 * calculation to the entire block, instead of per object.
18636 * The default value for the block count is enough for most lists, so unless
18637 * you know you will have a lot of objects visible in the screen at the same
18638 * time, don't try to change this.
18640 * @see elm_genlist_block_count_get()
18641 * @see @ref Genlist_Implementation
18645 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18647 * Get the maximum number of items within an item block
18649 * @param obj The genlist object
18650 * @return Maximum number of items within an item block
18652 * @see elm_genlist_block_count_set()
18656 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18658 * Set the timeout in seconds for the longpress event.
18660 * @param obj The genlist object
18661 * @param timeout timeout in seconds. Default is 1.
18663 * This option will change how long it takes to send an event "longpressed"
18664 * after the mouse down signal is sent to the list. If this event occurs, no
18665 * "clicked" event will be sent.
18667 * @see elm_genlist_longpress_timeout_set()
18671 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18673 * Get the timeout in seconds for the longpress event.
18675 * @param obj The genlist object
18676 * @return timeout in seconds
18678 * @see elm_genlist_longpress_timeout_get()
18682 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18684 * Append a new item in a given genlist widget.
18686 * @param obj The genlist object
18687 * @param itc The item class for the item
18688 * @param data The item data
18689 * @param parent The parent item, or NULL if none
18690 * @param flags Item flags
18691 * @param func Convenience function called when the item is selected
18692 * @param func_data Data passed to @p func above.
18693 * @return A handle to the item added or @c NULL if not possible
18695 * This adds the given item to the end of the list or the end of
18696 * the children list if the @p parent is given.
18698 * @see elm_genlist_item_prepend()
18699 * @see elm_genlist_item_insert_before()
18700 * @see elm_genlist_item_insert_after()
18701 * @see elm_genlist_item_del()
18705 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);
18707 * Prepend a new item in a given genlist widget.
18709 * @param obj The genlist object
18710 * @param itc The item class for the item
18711 * @param data The item data
18712 * @param parent The parent item, or NULL if none
18713 * @param flags Item flags
18714 * @param func Convenience function called when the item is selected
18715 * @param func_data Data passed to @p func above.
18716 * @return A handle to the item added or NULL if not possible
18718 * This adds an item to the beginning of the list or beginning of the
18719 * children of the parent if given.
18721 * @see elm_genlist_item_append()
18722 * @see elm_genlist_item_insert_before()
18723 * @see elm_genlist_item_insert_after()
18724 * @see elm_genlist_item_del()
18728 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);
18730 * Insert an item before another in a genlist widget
18732 * @param obj The genlist object
18733 * @param itc The item class for the item
18734 * @param data The item data
18735 * @param before The item to place this new one before.
18736 * @param flags Item flags
18737 * @param func Convenience function called when the item is selected
18738 * @param func_data Data passed to @p func above.
18739 * @return A handle to the item added or @c NULL if not possible
18741 * This inserts an item before another in the list. It will be in the
18742 * same tree level or group as the item it is inserted before.
18744 * @see elm_genlist_item_append()
18745 * @see elm_genlist_item_prepend()
18746 * @see elm_genlist_item_insert_after()
18747 * @see elm_genlist_item_del()
18751 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);
18753 * Insert an item after another in a 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 after The item to place this new one after.
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 inserts an item after another in the list. It will be in the
18765 * same tree level or group as the item it is inserted after.
18767 * @see elm_genlist_item_append()
18768 * @see elm_genlist_item_prepend()
18769 * @see elm_genlist_item_insert_before()
18770 * @see elm_genlist_item_del()
18774 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);
18776 * Insert a new item into the sorted genlist object
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 comp The function called for the sort
18784 * @param func Convenience function called when item selected
18785 * @param func_data Data passed to @p func above.
18786 * @return A handle to the item added or NULL if not possible
18790 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);
18791 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);
18792 /* operations to retrieve existing items */
18794 * Get the selectd item in the genlist.
18796 * @param obj The genlist object
18797 * @return The selected item, or NULL if none is selected.
18799 * This gets the selected item in the list (if multi-selection is enabled, only
18800 * the item that was first selected in the list is returned - which is not very
18801 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18804 * If no item is selected, NULL is returned.
18806 * @see elm_genlist_selected_items_get()
18810 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18812 * Get a list of selected items in the genlist.
18814 * @param obj The genlist object
18815 * @return The list of selected items, or NULL if none are selected.
18817 * It returns a list of the selected items. This list pointer is only valid so
18818 * long as the selection doesn't change (no items are selected or unselected, or
18819 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18820 * pointers. The order of the items in this list is the order which they were
18821 * selected, i.e. the first item in this list is the first item that was
18822 * selected, and so on.
18824 * @note If not in multi-select mode, consider using function
18825 * elm_genlist_selected_item_get() instead.
18827 * @see elm_genlist_multi_select_set()
18828 * @see elm_genlist_selected_item_get()
18832 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18834 * Get the mode item style of items in the genlist
18835 * @param obj The genlist object
18836 * @return The mode item style string, or NULL if none is specified
18838 * This is a constant string and simply defines the name of the
18839 * style that will be used for mode animations. It can be
18840 * @c NULL if you don't plan to use Genlist mode. See
18841 * elm_genlist_item_mode_set() for more info.
18845 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18847 * Set the mode item style of items in the genlist
18848 * @param obj The genlist object
18849 * @param style The mode item style string, or NULL if none is desired
18851 * This is a constant string and simply defines the name of the
18852 * style that will be used for mode animations. It can be
18853 * @c NULL if you don't plan to use Genlist mode. See
18854 * elm_genlist_item_mode_set() for more info.
18858 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
18860 * Get a list of realized items in genlist
18862 * @param obj The genlist object
18863 * @return The list of realized items, nor NULL if none are realized.
18865 * This returns a list of the realized items in the genlist. The list
18866 * contains Elm_Genlist_Item pointers. The list must be freed by the
18867 * caller when done with eina_list_free(). The item pointers in the
18868 * list are only valid so long as those items are not deleted or the
18869 * genlist is not deleted.
18871 * @see elm_genlist_realized_items_update()
18875 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18877 * Get the item that is at the x, y canvas coords.
18879 * @param obj The gelinst object.
18880 * @param x The input x coordinate
18881 * @param y The input y coordinate
18882 * @param posret The position relative to the item returned here
18883 * @return The item at the coordinates or NULL if none
18885 * This returns the item at the given coordinates (which are canvas
18886 * relative, not object-relative). If an item is at that coordinate,
18887 * that item handle is returned, and if @p posret is not NULL, the
18888 * integer pointed to is set to a value of -1, 0 or 1, depending if
18889 * the coordinate is on the upper portion of that item (-1), on the
18890 * middle section (0) or on the lower part (1). If NULL is returned as
18891 * an item (no item found there), then posret may indicate -1 or 1
18892 * based if the coordinate is above or below all items respectively in
18897 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);
18899 * Get the first item in the genlist
18901 * This returns the first item in the list.
18903 * @param obj The genlist object
18904 * @return The first item, or NULL if none
18908 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18910 * Get the last item in the genlist
18912 * This returns the last item in the list.
18914 * @return The last item, or NULL if none
18918 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18920 * Set the scrollbar policy
18922 * @param obj The genlist object
18923 * @param policy_h Horizontal scrollbar policy.
18924 * @param policy_v Vertical scrollbar policy.
18926 * This sets the scrollbar visibility policy for the given genlist
18927 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
18928 * made visible if it is needed, and otherwise kept hidden.
18929 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
18930 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
18931 * respectively for the horizontal and vertical scrollbars. Default is
18932 * #ELM_SMART_SCROLLER_POLICY_AUTO
18934 * @see elm_genlist_scroller_policy_get()
18938 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
18940 * Get the scrollbar policy
18942 * @param obj The genlist object
18943 * @param policy_h Pointer to store the horizontal scrollbar policy.
18944 * @param policy_v Pointer to store the vertical scrollbar policy.
18946 * @see elm_genlist_scroller_policy_set()
18950 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);
18952 * Get the @b next item in a genlist widget's internal list of items,
18953 * given a handle to one of those items.
18955 * @param item The genlist item to fetch next from
18956 * @return The item after @p item, or @c NULL if there's none (and
18959 * This returns the item placed after the @p item, on the container
18962 * @see elm_genlist_item_prev_get()
18966 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18968 * Get the @b previous item in a genlist widget's internal list of items,
18969 * given a handle to one of those items.
18971 * @param item The genlist item to fetch previous from
18972 * @return The item before @p item, or @c NULL if there's none (and
18975 * This returns the item placed before the @p item, on the container
18978 * @see elm_genlist_item_next_get()
18982 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18984 * Get the genlist object's handle which contains a given genlist
18987 * @param item The item to fetch the container from
18988 * @return The genlist (parent) object
18990 * This returns the genlist object itself that an item belongs to.
18994 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18996 * Get the parent item of the given item
18998 * @param it The item
18999 * @return The parent of the item or @c NULL if it has no parent.
19001 * This returns the item that was specified as parent of the item @p it on
19002 * elm_genlist_item_append() and insertion related functions.
19006 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19008 * Remove all sub-items (children) of the given item
19010 * @param it The item
19012 * This removes all items that are children (and their descendants) of the
19013 * given item @p it.
19015 * @see elm_genlist_clear()
19016 * @see elm_genlist_item_del()
19020 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19022 * Set whether a given genlist item is selected or not
19024 * @param it The item
19025 * @param selected Use @c EINA_TRUE, to make it selected, @c
19026 * EINA_FALSE to make it unselected
19028 * This sets the selected state of an item. If multi selection is
19029 * not enabled on the containing genlist and @p selected is @c
19030 * EINA_TRUE, any other previously selected items will get
19031 * unselected in favor of this new one.
19033 * @see elm_genlist_item_selected_get()
19037 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
19039 * Get whether a given genlist item is selected or not
19041 * @param it The item
19042 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
19044 * @see elm_genlist_item_selected_set() for more details
19048 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19050 * Sets the expanded state of an item.
19052 * @param it The item
19053 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
19055 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19058 * The theme will respond to this change visually, and a signal "expanded" or
19059 * "contracted" will be sent from the genlist with a pointer to the item that
19060 * has been expanded/contracted.
19062 * Calling this function won't show or hide any child of this item (if it is
19063 * a parent). You must manually delete and create them on the callbacks fo
19064 * the "expanded" or "contracted" signals.
19066 * @see elm_genlist_item_expanded_get()
19070 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19072 * Get the expanded state of an item
19074 * @param it The item
19075 * @return The expanded state
19077 * This gets the expanded state of an item.
19079 * @see elm_genlist_item_expanded_set()
19083 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19085 * Get the depth of expanded item
19087 * @param it The genlist item object
19088 * @return The depth of expanded item
19092 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19094 * Set whether a given genlist item is disabled or not.
19096 * @param it The item
19097 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19098 * to enable it back.
19100 * A disabled item cannot be selected or unselected. It will also
19101 * change its appearance, to signal the user it's disabled.
19103 * @see elm_genlist_item_disabled_get()
19107 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19109 * Get whether a given genlist item is disabled or not.
19111 * @param it The item
19112 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19115 * @see elm_genlist_item_disabled_set() for more details
19119 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19121 * Sets the display only state of an item.
19123 * @param it The item
19124 * @param display_only @c EINA_TRUE if the item is display only, @c
19125 * EINA_FALSE otherwise.
19127 * A display only item cannot be selected or unselected. It is for
19128 * display only and not selecting or otherwise clicking, dragging
19129 * etc. by the user, thus finger size rules will not be applied to
19132 * It's good to set group index items to display only state.
19134 * @see elm_genlist_item_display_only_get()
19138 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19140 * Get the display only state of an item
19142 * @param it The item
19143 * @return @c EINA_TRUE if the item is display only, @c
19144 * EINA_FALSE otherwise.
19146 * @see elm_genlist_item_display_only_set()
19150 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19152 * Show the portion of a genlist's internal list containing a given
19153 * item, immediately.
19155 * @param it The item to display
19157 * This causes genlist to jump to the given item @p it and show it (by
19158 * immediately scrolling to that position), if it is not fully visible.
19160 * @see elm_genlist_item_bring_in()
19161 * @see elm_genlist_item_top_show()
19162 * @see elm_genlist_item_middle_show()
19166 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19168 * Animatedly bring in, to the visible are of a genlist, a given
19171 * @param it The item to display
19173 * This causes genlist to jump to the given item @p it and show it (by
19174 * animatedly scrolling), if it is not fully visible. This may use animation
19175 * to do so and take a period of time
19177 * @see elm_genlist_item_show()
19178 * @see elm_genlist_item_top_bring_in()
19179 * @see elm_genlist_item_middle_bring_in()
19183 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19185 * Show the portion of a genlist's internal list containing a given
19186 * item, immediately.
19188 * @param it The item to display
19190 * This causes genlist to jump to the given item @p it and show it (by
19191 * immediately scrolling to that position), if it is not fully visible.
19193 * The item will be positioned at the top of the genlist viewport.
19195 * @see elm_genlist_item_show()
19196 * @see elm_genlist_item_top_bring_in()
19200 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19202 * Animatedly bring in, to the visible are of a genlist, a given
19205 * @param it The item
19207 * This causes genlist to jump to the given item @p it and show it (by
19208 * animatedly scrolling), if it is not fully visible. This may use animation
19209 * to do so and take a period of time
19211 * The item will be positioned at the top of the genlist viewport.
19213 * @see elm_genlist_item_bring_in()
19214 * @see elm_genlist_item_top_show()
19218 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19220 * Show the portion of a genlist's internal list containing a given
19221 * item, immediately.
19223 * @param it The item to display
19225 * This causes genlist to jump to the given item @p it and show it (by
19226 * immediately scrolling to that position), if it is not fully visible.
19228 * The item will be positioned at the middle of the genlist viewport.
19230 * @see elm_genlist_item_show()
19231 * @see elm_genlist_item_middle_bring_in()
19235 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19237 * Animatedly bring in, to the visible are of a genlist, a given
19240 * @param it The item
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 * The item will be positioned at the middle of the genlist viewport.
19248 * @see elm_genlist_item_bring_in()
19249 * @see elm_genlist_item_middle_show()
19253 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19255 * Remove a genlist item from the its parent, deleting it.
19257 * @param item The item to be removed.
19258 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19260 * @see elm_genlist_clear(), to remove all items in a genlist at
19265 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19267 * Return the data associated to a given genlist item
19269 * @param item The genlist item.
19270 * @return the data associated to this item.
19272 * This returns the @c data value passed on the
19273 * elm_genlist_item_append() and related item addition calls.
19275 * @see elm_genlist_item_append()
19276 * @see elm_genlist_item_data_set()
19280 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19282 * Set the data associated to a given genlist item
19284 * @param item The genlist item
19285 * @param data The new data pointer to set on it
19287 * This @b overrides the @c data value passed on the
19288 * elm_genlist_item_append() and related item addition calls. This
19289 * function @b won't call elm_genlist_item_update() automatically,
19290 * so you'd issue it afterwards if you want to hove the item
19291 * updated to reflect the that new data.
19293 * @see elm_genlist_item_data_get()
19297 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19299 * Tells genlist to "orphan" icons fetchs by the item class
19301 * @param it The item
19303 * This instructs genlist to release references to icons in the item,
19304 * meaning that they will no longer be managed by genlist and are
19305 * floating "orphans" that can be re-used elsewhere if the user wants
19310 EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19311 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19313 * Get the real Evas object created to implement the view of a
19314 * given genlist item
19316 * @param item The genlist item.
19317 * @return the Evas object implementing this item's view.
19319 * This returns the actual Evas object used to implement the
19320 * specified genlist item's view. This may be @c NULL, as it may
19321 * not have been created or may have been deleted, at any time, by
19322 * the genlist. <b>Do not modify this object</b> (move, resize,
19323 * show, hide, etc.), as the genlist is controlling it. This
19324 * function is for querying, emitting custom signals or hooking
19325 * lower level callbacks for events on that object. Do not delete
19326 * this object under any circumstances.
19328 * @see elm_genlist_item_data_get()
19332 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19334 * Update the contents of an item
19336 * @param it The item
19338 * This updates an item by calling all the item class functions again
19339 * to get the icons, labels and states. Use this when the original
19340 * item data has changed and the changes are desired to be reflected.
19342 * Use elm_genlist_realized_items_update() to update all already realized
19345 * @see elm_genlist_realized_items_update()
19349 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19350 EAPI void elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
19352 * Update the item class of an item
19354 * @param it The item
19355 * @param itc The item class for the item
19357 * This sets another class fo the item, changing the way that it is
19358 * displayed. After changing the item class, elm_genlist_item_update() is
19359 * called on the item @p it.
19363 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19364 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19366 * Set the text to be shown in a given genlist item's tooltips.
19368 * @param item The genlist item
19369 * @param text The text to set in the content
19371 * This call will setup the text to be used as tooltip to that item
19372 * (analogous to elm_object_tooltip_text_set(), but being item
19373 * tooltips with higher precedence than object tooltips). It can
19374 * have only one tooltip at a time, so any previous tooltip data
19375 * will get removed.
19377 * In order to set an icon or something else as a tooltip, look at
19378 * elm_genlist_item_tooltip_content_cb_set().
19382 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19384 * Set the content to be shown in a given genlist item's tooltips
19386 * @param item The genlist item.
19387 * @param func The function returning the tooltip contents.
19388 * @param data What to provide to @a func as callback data/context.
19389 * @param del_cb Called when data is not needed anymore, either when
19390 * another callback replaces @p func, the tooltip is unset with
19391 * elm_genlist_item_tooltip_unset() or the owner @p item
19392 * dies. This callback receives as its first parameter the
19393 * given @p data, being @c event_info the item handle.
19395 * This call will setup the tooltip's contents to @p item
19396 * (analogous to elm_object_tooltip_content_cb_set(), but being
19397 * item tooltips with higher precedence than object tooltips). It
19398 * can have only one tooltip at a time, so any previous tooltip
19399 * content will get removed. @p func (with @p data) will be called
19400 * every time Elementary needs to show the tooltip and it should
19401 * return a valid Evas object, which will be fully managed by the
19402 * tooltip system, getting deleted when the tooltip is gone.
19404 * In order to set just a text as a tooltip, look at
19405 * elm_genlist_item_tooltip_text_set().
19409 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);
19411 * Unset a tooltip from a given genlist item
19413 * @param item genlist item to remove a previously set tooltip from.
19415 * This call removes any tooltip set on @p item. The callback
19416 * provided as @c del_cb to
19417 * elm_genlist_item_tooltip_content_cb_set() will be called to
19418 * notify it is not used anymore (and have resources cleaned, if
19421 * @see elm_genlist_item_tooltip_content_cb_set()
19425 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19427 * Set a different @b style for a given genlist item's tooltip.
19429 * @param item genlist item with tooltip set
19430 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19431 * "default", @c "transparent", etc)
19433 * Tooltips can have <b>alternate styles</b> to be displayed on,
19434 * which are defined by the theme set on Elementary. This function
19435 * works analogously as elm_object_tooltip_style_set(), but here
19436 * applied only to genlist item objects. The default style for
19437 * tooltips is @c "default".
19439 * @note before you set a style you should define a tooltip with
19440 * elm_genlist_item_tooltip_content_cb_set() or
19441 * elm_genlist_item_tooltip_text_set()
19443 * @see elm_genlist_item_tooltip_style_get()
19447 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19449 * Get the style set a given genlist item's tooltip.
19451 * @param item genlist item with tooltip already set on.
19452 * @return style the theme style in use, which defaults to
19453 * "default". If the object does not have a tooltip set,
19454 * then @c NULL is returned.
19456 * @see elm_genlist_item_tooltip_style_set() for more details
19460 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19462 * Set the type of mouse pointer/cursor decoration to be shown,
19463 * when the mouse pointer is over the given genlist widget item
19465 * @param item genlist item to customize cursor on
19466 * @param cursor the cursor type's name
19468 * This function works analogously as elm_object_cursor_set(), but
19469 * here the cursor's changing area is restricted to the item's
19470 * area, and not the whole widget's. Note that that item cursors
19471 * have precedence over widget cursors, so that a mouse over @p
19472 * item will always show cursor @p type.
19474 * If this function is called twice for an object, a previously set
19475 * cursor will be unset on the second call.
19477 * @see elm_object_cursor_set()
19478 * @see elm_genlist_item_cursor_get()
19479 * @see elm_genlist_item_cursor_unset()
19483 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19485 * Get the type of mouse pointer/cursor decoration set to be shown,
19486 * when the mouse pointer is over the given genlist widget item
19488 * @param item genlist item with custom cursor set
19489 * @return the cursor type's name or @c NULL, if no custom cursors
19490 * were set to @p item (and on errors)
19492 * @see elm_object_cursor_get()
19493 * @see elm_genlist_item_cursor_set() for more details
19494 * @see elm_genlist_item_cursor_unset()
19498 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19500 * Unset any custom mouse pointer/cursor decoration set to be
19501 * shown, when the mouse pointer is over the given genlist widget
19502 * item, thus making it show the @b default cursor again.
19504 * @param item a genlist item
19506 * Use this call to undo any custom settings on this item's cursor
19507 * decoration, bringing it back to defaults (no custom style set).
19509 * @see elm_object_cursor_unset()
19510 * @see elm_genlist_item_cursor_set() for more details
19514 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19516 * Set a different @b style for a given custom cursor set for a
19519 * @param item genlist item with custom cursor set
19520 * @param style the <b>theme style</b> to use (e.g. @c "default",
19521 * @c "transparent", etc)
19523 * This function only makes sense when one is using custom mouse
19524 * cursor decorations <b>defined in a theme file</b> , which can
19525 * have, given a cursor name/type, <b>alternate styles</b> on
19526 * it. It works analogously as elm_object_cursor_style_set(), but
19527 * here applied only to genlist item objects.
19529 * @warning Before you set a cursor style you should have defined a
19530 * custom cursor previously on the item, with
19531 * elm_genlist_item_cursor_set()
19533 * @see elm_genlist_item_cursor_engine_only_set()
19534 * @see elm_genlist_item_cursor_style_get()
19538 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19540 * Get the current @b style set for a given genlist item's custom
19543 * @param item genlist item with custom cursor set.
19544 * @return style the cursor style in use. If the object does not
19545 * have a cursor set, then @c NULL is returned.
19547 * @see elm_genlist_item_cursor_style_set() for more details
19551 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19553 * Set if the (custom) cursor for a given genlist item should be
19554 * searched in its theme, also, or should only rely on the
19555 * rendering engine.
19557 * @param item item with custom (custom) cursor already set on
19558 * @param engine_only Use @c EINA_TRUE to have cursors looked for
19559 * only on those provided by the rendering engine, @c EINA_FALSE to
19560 * have them searched on the widget's theme, as well.
19562 * @note This call is of use only if you've set a custom cursor
19563 * for genlist items, with elm_genlist_item_cursor_set().
19565 * @note By default, cursors will only be looked for between those
19566 * provided by the rendering engine.
19570 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19572 * Get if the (custom) cursor for a given genlist item is being
19573 * searched in its theme, also, or is only relying on the rendering
19576 * @param item a genlist item
19577 * @return @c EINA_TRUE, if cursors are being looked for only on
19578 * those provided by the rendering engine, @c EINA_FALSE if they
19579 * are being searched on the widget's theme, as well.
19581 * @see elm_genlist_item_cursor_engine_only_set(), for more details
19585 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19587 * Update the contents of all realized items.
19589 * @param obj The genlist object.
19591 * This updates all realized items by calling all the item class functions again
19592 * to get the icons, labels and states. Use this when the original
19593 * item data has changed and the changes are desired to be reflected.
19595 * To update just one item, use elm_genlist_item_update().
19597 * @see elm_genlist_realized_items_get()
19598 * @see elm_genlist_item_update()
19602 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19604 * Activate a genlist mode on an item
19606 * @param item The genlist item
19607 * @param mode Mode name
19608 * @param mode_set Boolean to define set or unset mode.
19610 * A genlist mode is a different way of selecting an item. Once a mode is
19611 * activated on an item, any other selected item is immediately unselected.
19612 * This feature provides an easy way of implementing a new kind of animation
19613 * for selecting an item, without having to entirely rewrite the item style
19614 * theme. However, the elm_genlist_selected_* API can't be used to get what
19615 * item is activate for a mode.
19617 * The current item style will still be used, but applying a genlist mode to
19618 * an item will select it using a different kind of animation.
19620 * The current active item for a mode can be found by
19621 * elm_genlist_mode_item_get().
19623 * The characteristics of genlist mode are:
19624 * - Only one mode can be active at any time, and for only one item.
19625 * - Genlist handles deactivating other items when one item is activated.
19626 * - A mode is defined in the genlist theme (edc), and more modes can easily
19628 * - A mode style and the genlist item style are different things. They
19629 * can be combined to provide a default style to the item, with some kind
19630 * of animation for that item when the mode is activated.
19632 * When a mode is activated on an item, a new view for that item is created.
19633 * The theme of this mode defines the animation that will be used to transit
19634 * the item from the old view to the new view. This second (new) view will be
19635 * active for that item while the mode is active on the item, and will be
19636 * destroyed after the mode is totally deactivated from that item.
19638 * @see elm_genlist_mode_get()
19639 * @see elm_genlist_mode_item_get()
19643 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19645 * Get the last (or current) genlist mode used.
19647 * @param obj The genlist object
19649 * This function just returns the name of the last used genlist mode. It will
19650 * be the current mode if it's still active.
19652 * @see elm_genlist_item_mode_set()
19653 * @see elm_genlist_mode_item_get()
19657 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19659 * Get active genlist mode item
19661 * @param obj The genlist object
19662 * @return The active item for that current mode. Or @c NULL if no item is
19663 * activated with any mode.
19665 * This function returns the item that was activated with a mode, by the
19666 * function elm_genlist_item_mode_set().
19668 * @see elm_genlist_item_mode_set()
19669 * @see elm_genlist_mode_get()
19673 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19678 * @param obj The genlist object
19679 * @param reorder_mode The reorder mode
19680 * (EINA_TRUE = on, EINA_FALSE = off)
19684 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19687 * Get the reorder mode
19689 * @param obj The genlist object
19690 * @return The reorder mode
19691 * (EINA_TRUE = on, EINA_FALSE = off)
19695 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19697 EAPI void elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
19698 EAPI Eina_Bool elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19699 EAPI void elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
19700 EAPI Eina_Bool elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19701 EAPI void elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
19702 EAPI void elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
19703 EAPI void elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19704 EAPI void elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19705 EAPI void elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19706 EAPI Eina_Bool elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19713 * @defgroup Check Check
19715 * @image html img/widget/check/preview-00.png
19716 * @image latex img/widget/check/preview-00.eps
19717 * @image html img/widget/check/preview-01.png
19718 * @image latex img/widget/check/preview-01.eps
19719 * @image html img/widget/check/preview-02.png
19720 * @image latex img/widget/check/preview-02.eps
19722 * @brief The check widget allows for toggling a value between true and
19725 * Check objects are a lot like radio objects in layout and functionality
19726 * except they do not work as a group, but independently and only toggle the
19727 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19728 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19729 * returns the current state. For convenience, like the radio objects, you
19730 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19731 * for it to modify.
19733 * Signals that you can add callbacks for are:
19734 * "changed" - This is called whenever the user changes the state of one of
19735 * the check object(event_info is NULL).
19737 * Default contents parts of the check widget that you can use for are:
19738 * @li "icon" - A icon of the check
19740 * Default text parts of the check widget that you can use for are:
19741 * @li "elm.text" - Label of the check
19743 * @ref tutorial_check should give you a firm grasp of how to use this widget
19748 * @brief Add a new Check object
19750 * @param parent The parent object
19751 * @return The new object or NULL if it cannot be created
19753 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19755 * @brief Set the text label of the check object
19757 * @param obj The check object
19758 * @param label The text label string in UTF-8
19760 * @deprecated use elm_object_text_set() instead.
19762 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19764 * @brief Get the text label of the check object
19766 * @param obj The check object
19767 * @return The text label string in UTF-8
19769 * @deprecated use elm_object_text_get() instead.
19771 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19773 * @brief Set the icon object of the check object
19775 * @param obj The check object
19776 * @param icon The icon object
19778 * Once the icon object is set, a previously set one will be deleted.
19779 * If you want to keep that old content object, use the
19780 * elm_object_content_unset() function.
19782 * @deprecated use elm_object_part_content_set() instead.
19785 EINA_DEPRECATED EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19787 * @brief Get the icon object of the check object
19789 * @param obj The check object
19790 * @return The icon object
19792 * @deprecated use elm_object_part_content_get() instead.
19795 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19797 * @brief Unset the icon used for the check object
19799 * @param obj The check object
19800 * @return The icon object that was being used
19802 * Unparent and return the icon object which was set for this widget.
19804 * @deprecated use elm_object_part_content_unset() instead.
19807 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19809 * @brief Set the on/off state of the check object
19811 * @param obj The check object
19812 * @param state The state to use (1 == on, 0 == off)
19814 * This sets the state of the check. If set
19815 * with elm_check_state_pointer_set() the state of that variable is also
19816 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19818 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19820 * @brief Get the state of the check object
19822 * @param obj The check object
19823 * @return The boolean state
19825 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19827 * @brief Set a convenience pointer to a boolean to change
19829 * @param obj The check object
19830 * @param statep Pointer to the boolean to modify
19832 * This sets a pointer to a boolean, that, in addition to the check objects
19833 * state will also be modified directly. To stop setting the object pointed
19834 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19835 * then when this is called, the check objects state will also be modified to
19836 * reflect the value of the boolean @p statep points to, just like calling
19837 * elm_check_state_set().
19839 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19844 /* compatibility code for toggle controls */
19846 EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1)
19850 obj = elm_check_add(parent);
19851 elm_object_style_set(obj, "toggle");
19852 elm_object_part_text_set(obj, "on", "ON");
19853 elm_object_part_text_set(obj, "off", "OFF");
19857 EINA_DEPRECATED EAPI extern inline void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1)
19859 elm_object_text_set(obj, label);
19862 EINA_DEPRECATED EAPI extern inline const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
19864 return elm_object_text_get(obj);
19867 EINA_DEPRECATED EAPI extern inline void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1)
19869 elm_object_content_set(obj, icon);
19872 EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
19874 return elm_object_content_get(obj);
19877 EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1)
19879 return elm_object_content_unset(obj);
19882 EINA_DEPRECATED EAPI extern inline void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1)
19884 elm_object_part_text_set(obj, "on", onlabel);
19885 elm_object_part_text_set(obj, "off", offlabel);
19888 EINA_DEPRECATED EAPI extern inline void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1)
19890 if (onlabel) *onlabel = elm_object_part_text_get(obj, "on");
19891 if (offlabel) *offlabel = elm_object_part_text_get(obj, "off");
19894 EINA_DEPRECATED EAPI extern inline void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1)
19896 elm_check_state_set(obj, state);
19899 EINA_DEPRECATED EAPI extern inline Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
19901 return elm_check_state_get(obj);
19904 EINA_DEPRECATED EAPI extern inline void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1)
19906 elm_check_state_pointer_set(obj, statep);
19910 * @defgroup Radio Radio
19912 * @image html img/widget/radio/preview-00.png
19913 * @image latex img/widget/radio/preview-00.eps
19915 * @brief Radio is a widget that allows for 1 or more options to be displayed
19916 * and have the user choose only 1 of them.
19918 * A radio object contains an indicator, an optional Label and an optional
19919 * icon object. While it's possible to have a group of only one radio they,
19920 * are normally used in groups of 2 or more. To add a radio to a group use
19921 * elm_radio_group_add(). The radio object(s) will select from one of a set
19922 * of integer values, so any value they are configuring needs to be mapped to
19923 * a set of integers. To configure what value that radio object represents,
19924 * use elm_radio_state_value_set() to set the integer it represents. To set
19925 * the value the whole group(which one is currently selected) is to indicate
19926 * use elm_radio_value_set() on any group member, and to get the groups value
19927 * use elm_radio_value_get(). For convenience the radio objects are also able
19928 * to directly set an integer(int) to the value that is selected. To specify
19929 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
19930 * The radio objects will modify this directly. That implies the pointer must
19931 * point to valid memory for as long as the radio objects exist.
19933 * Signals that you can add callbacks for are:
19934 * @li changed - This is called whenever the user changes the state of one of
19935 * the radio objects within the group of radio objects that work together.
19937 * Default contents parts of the radio widget that you can use for are:
19938 * @li "icon" - A icon of the radio
19940 * @ref tutorial_radio show most of this API in action.
19944 * @brief Add a new radio to the parent
19946 * @param parent The parent object
19947 * @return The new object or NULL if it cannot be created
19949 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19951 * @brief Set the text label of the radio object
19953 * @param obj The radio object
19954 * @param label The text label string in UTF-8
19956 * @deprecated use elm_object_text_set() instead.
19958 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19960 * @brief Get the text label of the radio object
19962 * @param obj The radio object
19963 * @return The text label string in UTF-8
19965 * @deprecated use elm_object_text_set() instead.
19967 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19969 * @brief Set the icon object of the radio object
19971 * @param obj The radio object
19972 * @param icon The icon object
19974 * Once the icon object is set, a previously set one will be deleted. If you
19975 * want to keep that old content object, use the elm_radio_icon_unset()
19978 * @deprecated use elm_object_part_content_set() instead.
19981 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19983 * @brief Get the icon object of the radio object
19985 * @param obj The radio object
19986 * @return The icon object
19988 * @see elm_radio_icon_set()
19990 * @deprecated use elm_object_part_content_get() instead.
19993 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19995 * @brief Unset the icon used for the radio object
19997 * @param obj The radio object
19998 * @return The icon object that was being used
20000 * Unparent and return the icon object which was set for this widget.
20002 * @see elm_radio_icon_set()
20003 * @deprecated use elm_object_part_content_unset() instead.
20006 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20008 * @brief Add this radio to a group of other radio objects
20010 * @param obj The radio object
20011 * @param group Any object whose group the @p obj is to join.
20013 * Radio objects work in groups. Each member should have a different integer
20014 * value assigned. In order to have them work as a group, they need to know
20015 * about each other. This adds the given radio object to the group of which
20016 * the group object indicated is a member.
20018 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
20020 * @brief Set the integer value that this radio object represents
20022 * @param obj The radio object
20023 * @param value The value to use if this radio object is selected
20025 * This sets the value of the radio.
20027 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20029 * @brief Get the integer value that this radio object represents
20031 * @param obj The radio object
20032 * @return The value used if this radio object is selected
20034 * This gets the value of the radio.
20036 * @see elm_radio_value_set()
20038 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20040 * @brief Set the value of the radio.
20042 * @param obj The radio object
20043 * @param value The value to use for the group
20045 * This sets the value of the radio group and will also set the value if
20046 * pointed to, to the value supplied, but will not call any callbacks.
20048 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20050 * @brief Get the state of the radio object
20052 * @param obj The radio object
20053 * @return The integer state
20055 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20057 * @brief Set a convenience pointer to a integer to change
20059 * @param obj The radio object
20060 * @param valuep Pointer to the integer to modify
20062 * This sets a pointer to a integer, that, in addition to the radio objects
20063 * state will also be modified directly. To stop setting the object pointed
20064 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
20065 * when this is called, the radio objects state will also be modified to
20066 * reflect the value of the integer valuep points to, just like calling
20067 * elm_radio_value_set().
20069 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
20075 * @defgroup Pager Pager
20077 * @image html img/widget/pager/preview-00.png
20078 * @image latex img/widget/pager/preview-00.eps
20080 * @brief Widget that allows flipping between 1 or more āpagesā of objects.
20082 * The flipping between āpagesā of objects is animated. All content in pager
20083 * is kept in a stack, the last content to be added will be on the top of the
20084 * stack(be visible).
20086 * Objects can be pushed or popped from the stack or deleted as normal.
20087 * Pushes and pops will animate (and a pop will delete the object once the
20088 * animation is finished). Any object already in the pager can be promoted to
20089 * the top(from its current stacking position) through the use of
20090 * elm_pager_content_promote(). Objects are pushed to the top with
20091 * elm_pager_content_push() and when the top item is no longer wanted, simply
20092 * pop it with elm_pager_content_pop() and it will also be deleted. If an
20093 * object is no longer needed and is not the top item, just delete it as
20094 * normal. You can query which objects are the top and bottom with
20095 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20097 * Signals that you can add callbacks for are:
20098 * "hide,finished" - when the previous page is hided
20100 * This widget has the following styles available:
20103 * @li fade_translucide
20104 * @li fade_invisible
20105 * @note This styles affect only the flipping animations, the appearance when
20106 * not animating is unaffected by styles.
20108 * @ref tutorial_pager gives a good overview of the usage of the API.
20112 * Add a new pager to the parent
20114 * @param parent The parent object
20115 * @return The new object or NULL if it cannot be created
20119 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20121 * @brief Push an object to the top of the pager stack (and show it).
20123 * @param obj The pager object
20124 * @param content The object to push
20126 * The object pushed becomes a child of the pager, it will be controlled and
20127 * deleted when the pager is deleted.
20129 * @note If the content is already in the stack use
20130 * elm_pager_content_promote().
20131 * @warning Using this function on @p content already in the stack results in
20132 * undefined behavior.
20134 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20136 * @brief Pop the object that is on top of the stack
20138 * @param obj The pager object
20140 * This pops the object that is on the top(visible) of the pager, makes it
20141 * disappear, then deletes the object. The object that was underneath it on
20142 * the stack will become visible.
20144 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20146 * @brief Moves an object already in the pager stack to the top of the stack.
20148 * @param obj The pager object
20149 * @param content The object to promote
20151 * This will take the @p content and move it to the top of the stack as
20152 * if it had been pushed there.
20154 * @note If the content isn't already in the stack use
20155 * elm_pager_content_push().
20156 * @warning Using this function on @p content not already in the stack
20157 * results in undefined behavior.
20159 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20161 * @brief Return the object at the bottom of the pager stack
20163 * @param obj The pager object
20164 * @return The bottom object or NULL if none
20166 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20168 * @brief Return the object at the top of the pager stack
20170 * @param obj The pager object
20171 * @return The top object or NULL if none
20173 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20175 EAPI void elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
20176 EINA_DEPRECATED EAPI void elm_pager_animation_disabled_set(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
20183 * @defgroup Slideshow Slideshow
20185 * @image html img/widget/slideshow/preview-00.png
20186 * @image latex img/widget/slideshow/preview-00.eps
20188 * This widget, as the name indicates, is a pre-made image
20189 * slideshow panel, with API functions acting on (child) image
20190 * items presentation. Between those actions, are:
20191 * - advance to next/previous image
20192 * - select the style of image transition animation
20193 * - set the exhibition time for each image
20194 * - start/stop the slideshow
20196 * The transition animations are defined in the widget's theme,
20197 * consequently new animations can be added without having to
20198 * update the widget's code.
20200 * @section Slideshow_Items Slideshow items
20202 * For slideshow items, just like for @ref Genlist "genlist" ones,
20203 * the user defines a @b classes, specifying functions that will be
20204 * called on the item's creation and deletion times.
20206 * The #Elm_Slideshow_Item_Class structure contains the following
20209 * - @c func.get - When an item is displayed, this function is
20210 * called, and it's where one should create the item object, de
20211 * facto. For example, the object can be a pure Evas image object
20212 * or an Elementary @ref Photocam "photocam" widget. See
20213 * #SlideshowItemGetFunc.
20214 * - @c func.del - When an item is no more displayed, this function
20215 * is called, where the user must delete any data associated to
20216 * the item. See #SlideshowItemDelFunc.
20218 * @section Slideshow_Caching Slideshow caching
20220 * The slideshow provides facilities to have items adjacent to the
20221 * one being displayed <b>already "realized"</b> (i.e. loaded) for
20222 * you, so that the system does not have to decode image data
20223 * anymore at the time it has to actually switch images on its
20224 * viewport. The user is able to set the numbers of items to be
20225 * cached @b before and @b after the current item, in the widget's
20228 * Smart events one can add callbacks for are:
20230 * - @c "changed" - when the slideshow switches its view to a new
20233 * List of examples for the slideshow widget:
20234 * @li @ref slideshow_example
20238 * @addtogroup Slideshow
20242 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20243 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20244 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
20245 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20246 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20249 * @struct _Elm_Slideshow_Item_Class
20251 * Slideshow item class definition. See @ref Slideshow_Items for
20254 struct _Elm_Slideshow_Item_Class
20256 struct _Elm_Slideshow_Item_Class_Func
20258 SlideshowItemGetFunc get;
20259 SlideshowItemDelFunc del;
20261 }; /**< #Elm_Slideshow_Item_Class member definitions */
20264 * Add a new slideshow widget to the given parent Elementary
20265 * (container) object
20267 * @param parent The parent object
20268 * @return A new slideshow widget handle or @c NULL, on errors
20270 * This function inserts a new slideshow widget on the canvas.
20272 * @ingroup Slideshow
20274 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20277 * Add (append) a new item in a given slideshow widget.
20279 * @param obj The slideshow object
20280 * @param itc The item class for the item
20281 * @param data The item's data
20282 * @return A handle to the item added or @c NULL, on errors
20284 * Add a new item to @p obj's internal list of items, appending it.
20285 * The item's class must contain the function really fetching the
20286 * image object to show for this item, which could be an Evas image
20287 * object or an Elementary photo, for example. The @p data
20288 * parameter is going to be passed to both class functions of the
20291 * @see #Elm_Slideshow_Item_Class
20292 * @see elm_slideshow_item_sorted_insert()
20294 * @ingroup Slideshow
20296 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20299 * Insert a new item into the given slideshow widget, using the @p func
20300 * function to sort items (by item handles).
20302 * @param obj The slideshow object
20303 * @param itc The item class for the item
20304 * @param data The item's data
20305 * @param func The comparing function to be used to sort slideshow
20306 * items <b>by #Elm_Slideshow_Item item handles</b>
20307 * @return Returns The slideshow item handle, on success, or
20308 * @c NULL, on errors
20310 * Add a new item to @p obj's internal list of items, in a position
20311 * determined by the @p func comparing function. The item's class
20312 * must contain the function really fetching the image object to
20313 * show for this item, which could be an Evas image object or an
20314 * Elementary photo, for example. The @p data parameter is going to
20315 * be passed to both class functions of the item.
20317 * @see #Elm_Slideshow_Item_Class
20318 * @see elm_slideshow_item_add()
20320 * @ingroup Slideshow
20322 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);
20325 * Display a given slideshow widget's item, programmatically.
20327 * @param obj The slideshow object
20328 * @param item The item to display on @p obj's viewport
20330 * The change between the current item and @p item will use the
20331 * transition @p obj is set to use (@see
20332 * elm_slideshow_transition_set()).
20334 * @ingroup Slideshow
20336 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20339 * Slide to the @b next item, in a given slideshow widget
20341 * @param obj The slideshow object
20343 * The sliding animation @p obj is set to use will be the
20344 * transition effect used, after this call is issued.
20346 * @note If the end of the slideshow's internal list of items is
20347 * reached, it'll wrap around to the list's beginning, again.
20349 * @ingroup Slideshow
20351 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20354 * Slide to the @b previous item, in a given slideshow widget
20356 * @param obj The slideshow object
20358 * The sliding animation @p obj is set to use will be the
20359 * transition effect used, after this call is issued.
20361 * @note If the beginning of the slideshow's internal list of items
20362 * is reached, it'll wrap around to the list's end, again.
20364 * @ingroup Slideshow
20366 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20369 * Returns the list of sliding transition/effect names available, for a
20370 * given slideshow widget.
20372 * @param obj The slideshow object
20373 * @return The list of transitions (list of @b stringshared strings
20376 * The transitions, which come from @p obj's theme, must be an EDC
20377 * data item named @c "transitions" on the theme file, with (prefix)
20378 * names of EDC programs actually implementing them.
20380 * The available transitions for slideshows on the default theme are:
20381 * - @c "fade" - the current item fades out, while the new one
20382 * fades in to the slideshow's viewport.
20383 * - @c "black_fade" - the current item fades to black, and just
20384 * then, the new item will fade in.
20385 * - @c "horizontal" - the current item slides horizontally, until
20386 * it gets out of the slideshow's viewport, while the new item
20387 * comes from the left to take its place.
20388 * - @c "vertical" - the current item slides vertically, until it
20389 * gets out of the slideshow's viewport, while the new item comes
20390 * from the bottom to take its place.
20391 * - @c "square" - the new item starts to appear from the middle of
20392 * the current one, but with a tiny size, growing until its
20393 * target (full) size and covering the old one.
20395 * @warning The stringshared strings get no new references
20396 * exclusive to the user grabbing the list, here, so if you'd like
20397 * to use them out of this call's context, you'd better @c
20398 * eina_stringshare_ref() them.
20400 * @see elm_slideshow_transition_set()
20402 * @ingroup Slideshow
20404 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20407 * Set the current slide transition/effect in use for a given
20410 * @param obj The slideshow object
20411 * @param transition The new transition's name string
20413 * If @p transition is implemented in @p obj's theme (i.e., is
20414 * contained in the list returned by
20415 * elm_slideshow_transitions_get()), this new sliding effect will
20416 * be used on the widget.
20418 * @see elm_slideshow_transitions_get() for more details
20420 * @ingroup Slideshow
20422 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20425 * Get the current slide transition/effect in use for a given
20428 * @param obj The slideshow object
20429 * @return The current transition's name
20431 * @see elm_slideshow_transition_set() for more details
20433 * @ingroup Slideshow
20435 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20438 * Set the interval between each image transition on a given
20439 * slideshow widget, <b>and start the slideshow, itself</b>
20441 * @param obj The slideshow object
20442 * @param timeout The new displaying timeout for images
20444 * After this call, the slideshow widget will start cycling its
20445 * view, sequentially and automatically, with the images of the
20446 * items it has. The time between each new image displayed is going
20447 * to be @p timeout, in @b seconds. If a different timeout was set
20448 * previously and an slideshow was in progress, it will continue
20449 * with the new time between transitions, after this call.
20451 * @note A value less than or equal to 0 on @p timeout will disable
20452 * the widget's internal timer, thus halting any slideshow which
20453 * could be happening on @p obj.
20455 * @see elm_slideshow_timeout_get()
20457 * @ingroup Slideshow
20459 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20462 * Get the interval set for image transitions on a given slideshow
20465 * @param obj The slideshow object
20466 * @return Returns the timeout set on it
20468 * @see elm_slideshow_timeout_set() for more details
20470 * @ingroup Slideshow
20472 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20475 * Set if, after a slideshow is started, for a given slideshow
20476 * widget, its items should be displayed cyclically or not.
20478 * @param obj The slideshow object
20479 * @param loop Use @c EINA_TRUE to make it cycle through items or
20480 * @c EINA_FALSE for it to stop at the end of @p obj's internal
20483 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20484 * ignore what is set by this functions, i.e., they'll @b always
20485 * cycle through items. This affects only the "automatic"
20486 * slideshow, as set by elm_slideshow_timeout_set().
20488 * @see elm_slideshow_loop_get()
20490 * @ingroup Slideshow
20492 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20495 * Get if, after a slideshow is started, for a given slideshow
20496 * widget, its items are to be displayed cyclically or not.
20498 * @param obj The slideshow object
20499 * @return @c EINA_TRUE, if the items in @p obj will be cycled
20500 * through or @c EINA_FALSE, otherwise
20502 * @see elm_slideshow_loop_set() for more details
20504 * @ingroup Slideshow
20506 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20509 * Remove all items from a given slideshow widget
20511 * @param obj The slideshow object
20513 * This removes (and deletes) all items in @p obj, leaving it
20516 * @see elm_slideshow_item_del(), to remove just one item.
20518 * @ingroup Slideshow
20520 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20523 * Get the internal list of items in a given slideshow widget.
20525 * @param obj The slideshow object
20526 * @return The list of items (#Elm_Slideshow_Item as data) or
20527 * @c NULL on errors.
20529 * This list is @b not to be modified in any way and must not be
20530 * freed. Use the list members with functions like
20531 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20533 * @warning This list is only valid until @p obj object's internal
20534 * items list is changed. It should be fetched again with another
20535 * call to this function when changes happen.
20537 * @ingroup Slideshow
20539 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20542 * Delete a given item from a slideshow widget.
20544 * @param item The slideshow item
20546 * @ingroup Slideshow
20548 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20551 * Return the data associated with a given slideshow item
20553 * @param item The slideshow item
20554 * @return Returns the data associated to this item
20556 * @ingroup Slideshow
20558 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20561 * Returns the currently displayed item, in a given slideshow widget
20563 * @param obj The slideshow object
20564 * @return A handle to the item being displayed in @p obj or
20565 * @c NULL, if none is (and on errors)
20567 * @ingroup Slideshow
20569 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20572 * Get the real Evas object created to implement the view of a
20573 * given slideshow item
20575 * @param item The slideshow item.
20576 * @return the Evas object implementing this item's view.
20578 * This returns the actual Evas object used to implement the
20579 * specified slideshow item's view. This may be @c NULL, as it may
20580 * not have been created or may have been deleted, at any time, by
20581 * the slideshow. <b>Do not modify this object</b> (move, resize,
20582 * show, hide, etc.), as the slideshow is controlling it. This
20583 * function is for querying, emitting custom signals or hooking
20584 * lower level callbacks for events on that object. Do not delete
20585 * this object under any circumstances.
20587 * @see elm_slideshow_item_data_get()
20589 * @ingroup Slideshow
20591 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20594 * Get the the item, in a given slideshow widget, placed at
20595 * position @p nth, in its internal items list
20597 * @param obj The slideshow object
20598 * @param nth The number of the item to grab a handle to (0 being
20600 * @return The item stored in @p obj at position @p nth or @c NULL,
20601 * if there's no item with that index (and on errors)
20603 * @ingroup Slideshow
20605 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20608 * Set the current slide layout in use for a given slideshow widget
20610 * @param obj The slideshow object
20611 * @param layout The new layout's name string
20613 * If @p layout is implemented in @p obj's theme (i.e., is contained
20614 * in the list returned by elm_slideshow_layouts_get()), this new
20615 * images layout will be used on the widget.
20617 * @see elm_slideshow_layouts_get() for more details
20619 * @ingroup Slideshow
20621 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20624 * Get the current slide layout in use for a given slideshow widget
20626 * @param obj The slideshow object
20627 * @return The current layout's name
20629 * @see elm_slideshow_layout_set() for more details
20631 * @ingroup Slideshow
20633 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20636 * Returns the list of @b layout names available, for a given
20637 * slideshow widget.
20639 * @param obj The slideshow object
20640 * @return The list of layouts (list of @b stringshared strings
20643 * Slideshow layouts will change how the widget is to dispose each
20644 * image item in its viewport, with regard to cropping, scaling,
20647 * The layouts, which come from @p obj's theme, must be an EDC
20648 * data item name @c "layouts" on the theme file, with (prefix)
20649 * names of EDC programs actually implementing them.
20651 * The available layouts for slideshows on the default theme are:
20652 * - @c "fullscreen" - item images with original aspect, scaled to
20653 * touch top and down slideshow borders or, if the image's heigh
20654 * is not enough, left and right slideshow borders.
20655 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20656 * one, but always leaving 10% of the slideshow's dimensions of
20657 * distance between the item image's borders and the slideshow
20658 * borders, for each axis.
20660 * @warning The stringshared strings get no new references
20661 * exclusive to the user grabbing the list, here, so if you'd like
20662 * to use them out of this call's context, you'd better @c
20663 * eina_stringshare_ref() them.
20665 * @see elm_slideshow_layout_set()
20667 * @ingroup Slideshow
20669 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20672 * Set the number of items to cache, on a given slideshow widget,
20673 * <b>before the current item</b>
20675 * @param obj The slideshow object
20676 * @param count Number of items to cache before the current one
20678 * The default value for this property is @c 2. See
20679 * @ref Slideshow_Caching "slideshow caching" for more details.
20681 * @see elm_slideshow_cache_before_get()
20683 * @ingroup Slideshow
20685 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20688 * Retrieve the number of items to cache, on a given slideshow widget,
20689 * <b>before the current item</b>
20691 * @param obj The slideshow object
20692 * @return The number of items set to be cached before the current one
20694 * @see elm_slideshow_cache_before_set() for more details
20696 * @ingroup Slideshow
20698 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20701 * Set the number of items to cache, on a given slideshow widget,
20702 * <b>after the current item</b>
20704 * @param obj The slideshow object
20705 * @param count Number of items to cache after the current one
20707 * The default value for this property is @c 2. See
20708 * @ref Slideshow_Caching "slideshow caching" for more details.
20710 * @see elm_slideshow_cache_after_get()
20712 * @ingroup Slideshow
20714 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20717 * Retrieve the number of items to cache, on a given slideshow widget,
20718 * <b>after the current item</b>
20720 * @param obj The slideshow object
20721 * @return The number of items set to be cached after the current one
20723 * @see elm_slideshow_cache_after_set() for more details
20725 * @ingroup Slideshow
20727 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20730 * Get the number of items stored in a given slideshow widget
20732 * @param obj The slideshow object
20733 * @return The number of items on @p obj, at the moment of this call
20735 * @ingroup Slideshow
20737 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20744 * @defgroup Fileselector File Selector
20746 * @image html img/widget/fileselector/preview-00.png
20747 * @image latex img/widget/fileselector/preview-00.eps
20749 * A file selector is a widget that allows a user to navigate
20750 * through a file system, reporting file selections back via its
20753 * It contains shortcut buttons for home directory (@c ~) and to
20754 * jump one directory upwards (..), as well as cancel/ok buttons to
20755 * confirm/cancel a given selection. After either one of those two
20756 * former actions, the file selector will issue its @c "done" smart
20759 * There's a text entry on it, too, showing the name of the current
20760 * selection. There's the possibility of making it editable, so it
20761 * is useful on file saving dialogs on applications, where one
20762 * gives a file name to save contents to, in a given directory in
20763 * the system. This custom file name will be reported on the @c
20764 * "done" smart callback (explained in sequence).
20766 * Finally, it has a view to display file system items into in two
20771 * If Elementary is built with support of the Ethumb thumbnailing
20772 * library, the second form of view will display preview thumbnails
20773 * of files which it supports.
20775 * Smart callbacks one can register to:
20777 * - @c "selected" - the user has clicked on a file (when not in
20778 * folders-only mode) or directory (when in folders-only mode)
20779 * - @c "directory,open" - the list has been populated with new
20780 * content (@c event_info is a pointer to the directory's
20781 * path, a @b stringshared string)
20782 * - @c "done" - the user has clicked on the "ok" or "cancel"
20783 * buttons (@c event_info is a pointer to the selection's
20784 * path, a @b stringshared string)
20786 * Here is an example on its usage:
20787 * @li @ref fileselector_example
20791 * @addtogroup Fileselector
20796 * Defines how a file selector widget is to layout its contents
20797 * (file system entries).
20799 typedef enum _Elm_Fileselector_Mode
20801 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20802 ELM_FILESELECTOR_GRID, /**< layout as a grid */
20803 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20804 } Elm_Fileselector_Mode;
20807 * Add a new file selector widget to the given parent Elementary
20808 * (container) object
20810 * @param parent The parent object
20811 * @return a new file selector widget handle or @c NULL, on errors
20813 * This function inserts a new file selector widget on the canvas.
20815 * @ingroup Fileselector
20817 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20820 * Enable/disable the file name entry box where the user can type
20821 * in a name for a file, in a given file selector widget
20823 * @param obj The file selector object
20824 * @param is_save @c EINA_TRUE to make the file selector a "saving
20825 * dialog", @c EINA_FALSE otherwise
20827 * Having the entry editable is useful on file saving dialogs on
20828 * applications, where one gives a file name to save contents to,
20829 * in a given directory in the system. This custom file name will
20830 * be reported on the @c "done" smart callback.
20832 * @see elm_fileselector_is_save_get()
20834 * @ingroup Fileselector
20836 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20839 * Get whether the given file selector is in "saving dialog" mode
20841 * @param obj The file selector object
20842 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20843 * mode, @c EINA_FALSE otherwise (and on errors)
20845 * @see elm_fileselector_is_save_set() for more details
20847 * @ingroup Fileselector
20849 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20852 * Enable/disable folder-only view for a given file selector widget
20854 * @param obj The file selector object
20855 * @param only @c EINA_TRUE to make @p obj only display
20856 * directories, @c EINA_FALSE to make files to be displayed in it
20859 * If enabled, the widget's view will only display folder items,
20862 * @see elm_fileselector_folder_only_get()
20864 * @ingroup Fileselector
20866 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20869 * Get whether folder-only view is set for a given file selector
20872 * @param obj The file selector object
20873 * @return only @c EINA_TRUE if @p obj is only displaying
20874 * directories, @c EINA_FALSE if files are being displayed in it
20875 * too (and on errors)
20877 * @see elm_fileselector_folder_only_get()
20879 * @ingroup Fileselector
20881 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20884 * Enable/disable the "ok" and "cancel" buttons on a given file
20887 * @param obj The file selector object
20888 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
20890 * @note A file selector without those buttons will never emit the
20891 * @c "done" smart event, and is only usable if one is just hooking
20892 * to the other two events.
20894 * @see elm_fileselector_buttons_ok_cancel_get()
20896 * @ingroup Fileselector
20898 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
20901 * Get whether the "ok" and "cancel" buttons on a given file
20902 * selector widget are being shown.
20904 * @param obj The file selector object
20905 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
20906 * otherwise (and on errors)
20908 * @see elm_fileselector_buttons_ok_cancel_set() for more details
20910 * @ingroup Fileselector
20912 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20915 * Enable/disable a tree view in the given file selector widget,
20916 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
20918 * @param obj The file selector object
20919 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
20922 * In a tree view, arrows are created on the sides of directories,
20923 * allowing them to expand in place.
20925 * @note If it's in other mode, the changes made by this function
20926 * will only be visible when one switches back to "list" mode.
20928 * @see elm_fileselector_expandable_get()
20930 * @ingroup Fileselector
20932 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
20935 * Get whether tree view is enabled for the given file selector
20938 * @param obj The file selector object
20939 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
20940 * otherwise (and or errors)
20942 * @see elm_fileselector_expandable_set() for more details
20944 * @ingroup Fileselector
20946 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20949 * Set, programmatically, the @b directory that a given file
20950 * selector widget will display contents from
20952 * @param obj The file selector object
20953 * @param path The path to display in @p obj
20955 * This will change the @b directory that @p obj is displaying. It
20956 * will also clear the text entry area on the @p obj object, which
20957 * displays select files' names.
20959 * @see elm_fileselector_path_get()
20961 * @ingroup Fileselector
20963 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20966 * Get the parent directory's path that a given file selector
20967 * widget is displaying
20969 * @param obj The file selector object
20970 * @return The (full) path of the directory the file selector is
20971 * displaying, a @b stringshared string
20973 * @see elm_fileselector_path_set()
20975 * @ingroup Fileselector
20977 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20980 * Set, programmatically, the currently selected file/directory in
20981 * the given file selector widget
20983 * @param obj The file selector object
20984 * @param path The (full) path to a file or directory
20985 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
20986 * latter case occurs if the directory or file pointed to do not
20989 * @see elm_fileselector_selected_get()
20991 * @ingroup Fileselector
20993 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20996 * Get the currently selected item's (full) path, in the given file
20999 * @param obj The file selector object
21000 * @return The absolute path of the selected item, a @b
21001 * stringshared string
21003 * @note Custom editions on @p obj object's text entry, if made,
21004 * will appear on the return string of this function, naturally.
21006 * @see elm_fileselector_selected_set() for more details
21008 * @ingroup Fileselector
21010 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21013 * Set the mode in which a given file selector widget will display
21014 * (layout) file system entries in its view
21016 * @param obj The file selector object
21017 * @param mode The mode of the fileselector, being it one of
21018 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
21019 * first one, naturally, will display the files in a list. The
21020 * latter will make the widget to display its entries in a grid
21023 * @note By using elm_fileselector_expandable_set(), the user may
21024 * trigger a tree view for that list.
21026 * @note If Elementary is built with support of the Ethumb
21027 * thumbnailing library, the second form of view will display
21028 * preview thumbnails of files which it supports. You must have
21029 * elm_need_ethumb() called in your Elementary for thumbnailing to
21032 * @see elm_fileselector_expandable_set().
21033 * @see elm_fileselector_mode_get().
21035 * @ingroup Fileselector
21037 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
21040 * Get the mode in which a given file selector widget is displaying
21041 * (layouting) file system entries in its view
21043 * @param obj The fileselector object
21044 * @return The mode in which the fileselector is at
21046 * @see elm_fileselector_mode_set() for more details
21048 * @ingroup Fileselector
21050 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21057 * @defgroup Progressbar Progress bar
21059 * The progress bar is a widget for visually representing the
21060 * progress status of a given job/task.
21062 * A progress bar may be horizontal or vertical. It may display an
21063 * icon besides it, as well as primary and @b units labels. The
21064 * former is meant to label the widget as a whole, while the
21065 * latter, which is formatted with floating point values (and thus
21066 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
21067 * units"</c>), is meant to label the widget's <b>progress
21068 * value</b>. Label, icon and unit strings/objects are @b optional
21069 * for progress bars.
21071 * A progress bar may be @b inverted, in which state it gets its
21072 * values inverted, with high values being on the left or top and
21073 * low values on the right or bottom, as opposed to normally have
21074 * the low values on the former and high values on the latter,
21075 * respectively, for horizontal and vertical modes.
21077 * The @b span of the progress, as set by
21078 * elm_progressbar_span_size_set(), is its length (horizontally or
21079 * vertically), unless one puts size hints on the widget to expand
21080 * on desired directions, by any container. That length will be
21081 * scaled by the object or applications scaling factor. At any
21082 * point code can query the progress bar for its value with
21083 * elm_progressbar_value_get().
21085 * Available widget styles for progress bars:
21087 * - @c "wheel" (simple style, no text, no progression, only
21088 * "pulse" effect is available)
21090 * Default contents parts of the progressbar widget that you can use for are:
21091 * @li "icon" - A icon of the progressbar
21093 * Here is an example on its usage:
21094 * @li @ref progressbar_example
21098 * Add a new progress bar widget to the given parent Elementary
21099 * (container) object
21101 * @param parent The parent object
21102 * @return a new progress bar widget handle or @c NULL, on errors
21104 * This function inserts a new progress bar widget on the canvas.
21106 * @ingroup Progressbar
21108 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21111 * Set whether a given progress bar widget is at "pulsing mode" or
21114 * @param obj The progress bar object
21115 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21116 * @c EINA_FALSE to put it back to its default one
21118 * By default, progress bars will display values from the low to
21119 * high value boundaries. There are, though, contexts in which the
21120 * state of progression of a given task is @b unknown. For those,
21121 * one can set a progress bar widget to a "pulsing state", to give
21122 * the user an idea that some computation is being held, but
21123 * without exact progress values. In the default theme it will
21124 * animate its bar with the contents filling in constantly and back
21125 * to non-filled, in a loop. To start and stop this pulsing
21126 * animation, one has to explicitly call elm_progressbar_pulse().
21128 * @see elm_progressbar_pulse_get()
21129 * @see elm_progressbar_pulse()
21131 * @ingroup Progressbar
21133 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21136 * Get whether a given progress bar widget is at "pulsing mode" or
21139 * @param obj The progress bar object
21140 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21141 * if it's in the default one (and on errors)
21143 * @ingroup Progressbar
21145 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21148 * Start/stop a given progress bar "pulsing" animation, if its
21151 * @param obj The progress bar object
21152 * @param state @c EINA_TRUE, to @b start the pulsing animation,
21153 * @c EINA_FALSE to @b stop it
21155 * @note This call won't do anything if @p obj is not under "pulsing mode".
21157 * @see elm_progressbar_pulse_set() for more details.
21159 * @ingroup Progressbar
21161 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21164 * Set the progress value (in percentage) on a given progress bar
21167 * @param obj The progress bar object
21168 * @param val The progress value (@b must be between @c 0.0 and @c
21171 * Use this call to set progress bar levels.
21173 * @note If you passes a value out of the specified range for @p
21174 * val, it will be interpreted as the @b closest of the @b boundary
21175 * values in the range.
21177 * @ingroup Progressbar
21179 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21182 * Get the progress value (in percentage) on a given progress bar
21185 * @param obj The progress bar object
21186 * @return The value of the progressbar
21188 * @see elm_progressbar_value_set() for more details
21190 * @ingroup Progressbar
21192 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21195 * Set the label of a given progress bar widget
21197 * @param obj The progress bar object
21198 * @param label The text label string, in UTF-8
21200 * @ingroup Progressbar
21201 * @deprecated use elm_object_text_set() instead.
21203 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21206 * Get the label of a given progress bar widget
21208 * @param obj The progressbar object
21209 * @return The text label string, in UTF-8
21211 * @ingroup Progressbar
21212 * @deprecated use elm_object_text_set() instead.
21214 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21217 * Set the icon object of a given progress bar widget
21219 * @param obj The progress bar object
21220 * @param icon The icon object
21222 * Use this call to decorate @p obj with an icon next to it.
21224 * @note Once the icon object is set, a previously set one will be
21225 * deleted. If you want to keep that old content object, use the
21226 * elm_progressbar_icon_unset() function.
21228 * @see elm_progressbar_icon_get()
21229 * @deprecated use elm_object_part_content_set() instead.
21231 * @ingroup Progressbar
21233 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21236 * Retrieve the icon object set for a given progress bar widget
21238 * @param obj The progress bar object
21239 * @return The icon object's handle, if @p obj had one set, or @c NULL,
21240 * otherwise (and on errors)
21242 * @see elm_progressbar_icon_set() for more details
21243 * @deprecated use elm_object_part_content_get() instead.
21245 * @ingroup Progressbar
21247 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21250 * Unset an icon set on a given progress bar widget
21252 * @param obj The progress bar object
21253 * @return The icon object that was being used, if any was set, or
21254 * @c NULL, otherwise (and on errors)
21256 * This call will unparent and return the icon object which was set
21257 * for this widget, previously, on success.
21259 * @see elm_progressbar_icon_set() for more details
21260 * @deprecated use elm_object_part_content_unset() instead.
21262 * @ingroup Progressbar
21264 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21267 * Set the (exact) length of the bar region of a given progress bar
21270 * @param obj The progress bar object
21271 * @param size The length of the progress bar's bar region
21273 * This sets the minimum width (when in horizontal mode) or height
21274 * (when in vertical mode) of the actual bar area of the progress
21275 * bar @p obj. This in turn affects the object's minimum size. Use
21276 * this when you're not setting other size hints expanding on the
21277 * given direction (like weight and alignment hints) and you would
21278 * like it to have a specific size.
21280 * @note Icon, label and unit text around @p obj will require their
21281 * own space, which will make @p obj to require more the @p size,
21284 * @see elm_progressbar_span_size_get()
21286 * @ingroup Progressbar
21288 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21291 * Get the length set for the bar region of a given progress bar
21294 * @param obj The progress bar object
21295 * @return The length of the progress bar's bar region
21297 * If that size was not set previously, with
21298 * elm_progressbar_span_size_set(), this call will return @c 0.
21300 * @ingroup Progressbar
21302 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21305 * Set the format string for a given progress bar widget's units
21308 * @param obj The progress bar object
21309 * @param format The format string for @p obj's units label
21311 * If @c NULL is passed on @p format, it will make @p obj's units
21312 * area to be hidden completely. If not, it'll set the <b>format
21313 * string</b> for the units label's @b text. The units label is
21314 * provided a floating point value, so the units text is up display
21315 * at most one floating point falue. Note that the units label is
21316 * optional. Use a format string such as "%1.2f meters" for
21319 * @note The default format string for a progress bar is an integer
21320 * percentage, as in @c "%.0f %%".
21322 * @see elm_progressbar_unit_format_get()
21324 * @ingroup Progressbar
21326 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21329 * Retrieve the format string set for a given progress bar widget's
21332 * @param obj The progress bar object
21333 * @return The format set string for @p obj's units label or
21334 * @c NULL, if none was set (and on errors)
21336 * @see elm_progressbar_unit_format_set() for more details
21338 * @ingroup Progressbar
21340 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21343 * Set the orientation of a given progress bar widget
21345 * @param obj The progress bar object
21346 * @param horizontal Use @c EINA_TRUE to make @p obj to be
21347 * @b horizontal, @c EINA_FALSE to make it @b vertical
21349 * Use this function to change how your progress bar is to be
21350 * disposed: vertically or horizontally.
21352 * @see elm_progressbar_horizontal_get()
21354 * @ingroup Progressbar
21356 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21359 * Retrieve the orientation of a given progress bar widget
21361 * @param obj The progress bar object
21362 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21363 * @c EINA_FALSE if it's @b vertical (and on errors)
21365 * @see elm_progressbar_horizontal_set() for more details
21367 * @ingroup Progressbar
21369 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21372 * Invert a given progress bar widget's displaying values order
21374 * @param obj The progress bar object
21375 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21376 * @c EINA_FALSE to bring it back to default, non-inverted values.
21378 * A progress bar may be @b inverted, in which state it gets its
21379 * values inverted, with high values being on the left or top and
21380 * low values on the right or bottom, as opposed to normally have
21381 * the low values on the former and high values on the latter,
21382 * respectively, for horizontal and vertical modes.
21384 * @see elm_progressbar_inverted_get()
21386 * @ingroup Progressbar
21388 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21391 * Get whether a given progress bar widget's displaying values are
21394 * @param obj The progress bar object
21395 * @return @c EINA_TRUE, if @p obj has inverted values,
21396 * @c EINA_FALSE otherwise (and on errors)
21398 * @see elm_progressbar_inverted_set() for more details
21400 * @ingroup Progressbar
21402 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21405 * @defgroup Separator Separator
21407 * @brief Separator is a very thin object used to separate other objects.
21409 * A separator can be vertical or horizontal.
21411 * @ref tutorial_separator is a good example of how to use a separator.
21415 * @brief Add a separator object to @p parent
21417 * @param parent The parent object
21419 * @return The separator object, or NULL upon failure
21421 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21423 * @brief Set the horizontal mode of a separator object
21425 * @param obj The separator object
21426 * @param horizontal If true, the separator is horizontal
21428 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21430 * @brief Get the horizontal mode of a separator object
21432 * @param obj The separator object
21433 * @return If true, the separator is horizontal
21435 * @see elm_separator_horizontal_set()
21437 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21443 * @defgroup Spinner Spinner
21444 * @ingroup Elementary
21446 * @image html img/widget/spinner/preview-00.png
21447 * @image latex img/widget/spinner/preview-00.eps
21449 * A spinner is a widget which allows the user to increase or decrease
21450 * numeric values using arrow buttons, or edit values directly, clicking
21451 * over it and typing the new value.
21453 * By default the spinner will not wrap and has a label
21454 * of "%.0f" (just showing the integer value of the double).
21456 * A spinner has a label that is formatted with floating
21457 * point values and thus accepts a printf-style format string, like
21458 * ā%1.2f unitsā.
21460 * It also allows specific values to be replaced by pre-defined labels.
21462 * Smart callbacks one can register to:
21464 * - "changed" - Whenever the spinner value is changed.
21465 * - "delay,changed" - A short time after the value is changed by the user.
21466 * This will be called only when the user stops dragging for a very short
21467 * period or when they release their finger/mouse, so it avoids possibly
21468 * expensive reactions to the value change.
21470 * Available styles for it:
21472 * - @c "vertical": up/down buttons at the right side and text left aligned.
21474 * Here is an example on its usage:
21475 * @ref spinner_example
21479 * @addtogroup Spinner
21484 * Add a new spinner widget to the given parent Elementary
21485 * (container) object.
21487 * @param parent The parent object.
21488 * @return a new spinner widget handle or @c NULL, on errors.
21490 * This function inserts a new spinner widget on the canvas.
21495 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21498 * Set the format string of the displayed label.
21500 * @param obj The spinner object.
21501 * @param fmt The format string for the label display.
21503 * If @c NULL, this sets the format to "%.0f". If not it sets the format
21504 * string for the label text. The label text is provided a floating point
21505 * value, so the label text can display up to 1 floating point value.
21506 * Note that this is optional.
21508 * Use a format string such as "%1.2f meters" for example, and it will
21509 * display values like: "3.14 meters" for a value equal to 3.14159.
21511 * Default is "%0.f".
21513 * @see elm_spinner_label_format_get()
21517 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21520 * Get the label format of the spinner.
21522 * @param obj The spinner object.
21523 * @return The text label format string in UTF-8.
21525 * @see elm_spinner_label_format_set() for details.
21529 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21532 * Set the minimum and maximum values for the spinner.
21534 * @param obj The spinner object.
21535 * @param min The minimum value.
21536 * @param max The maximum value.
21538 * Define the allowed range of values to be selected by the user.
21540 * If actual value is less than @p min, it will be updated to @p min. If it
21541 * is bigger then @p max, will be updated to @p max. Actual value can be
21542 * get with elm_spinner_value_get().
21544 * By default, min is equal to 0, and max is equal to 100.
21546 * @warning Maximum must be greater than minimum.
21548 * @see elm_spinner_min_max_get()
21552 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21555 * Get the minimum and maximum values of the spinner.
21557 * @param obj The spinner object.
21558 * @param min Pointer where to store the minimum value.
21559 * @param max Pointer where to store the maximum value.
21561 * @note If only one value is needed, the other pointer can be passed
21564 * @see elm_spinner_min_max_set() for details.
21568 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21571 * Set the step used to increment or decrement the spinner value.
21573 * @param obj The spinner object.
21574 * @param step The step value.
21576 * This value will be incremented or decremented to the displayed value.
21577 * It will be incremented while the user keep right or top arrow pressed,
21578 * and will be decremented while the user keep left or bottom arrow pressed.
21580 * The interval to increment / decrement can be set with
21581 * elm_spinner_interval_set().
21583 * By default step value is equal to 1.
21585 * @see elm_spinner_step_get()
21589 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21592 * Get the step used to increment or decrement the spinner value.
21594 * @param obj The spinner object.
21595 * @return The step value.
21597 * @see elm_spinner_step_get() for more details.
21601 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21604 * Set the value the spinner displays.
21606 * @param obj The spinner object.
21607 * @param val The value to be displayed.
21609 * Value will be presented on the label following format specified with
21610 * elm_spinner_format_set().
21612 * @warning The value must to be between min and max values. This values
21613 * are set by elm_spinner_min_max_set().
21615 * @see elm_spinner_value_get().
21616 * @see elm_spinner_format_set().
21617 * @see elm_spinner_min_max_set().
21621 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21624 * Get the value displayed by the spinner.
21626 * @param obj The spinner object.
21627 * @return The value displayed.
21629 * @see elm_spinner_value_set() for details.
21633 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21636 * Set whether the spinner should wrap when it reaches its
21637 * minimum or maximum value.
21639 * @param obj The spinner object.
21640 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21643 * Disabled by default. If disabled, when the user tries to increment the
21645 * but displayed value plus step value is bigger than maximum value,
21647 * won't allow it. The same happens when the user tries to decrement it,
21648 * but the value less step is less than minimum value.
21650 * When wrap is enabled, in such situations it will allow these changes,
21651 * but will get the value that would be less than minimum and subtracts
21652 * from maximum. Or add the value that would be more than maximum to
21656 * @li min value = 10
21657 * @li max value = 50
21658 * @li step value = 20
21659 * @li displayed value = 20
21661 * When the user decrement value (using left or bottom arrow), it will
21662 * displays @c 40, because max - (min - (displayed - step)) is
21663 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21665 * @see elm_spinner_wrap_get().
21669 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21672 * Get whether the spinner should wrap when it reaches its
21673 * minimum or maximum value.
21675 * @param obj The spinner object
21676 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21677 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21679 * @see elm_spinner_wrap_set() for details.
21683 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21686 * Set whether the spinner can be directly edited by the user or not.
21688 * @param obj The spinner object.
21689 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21690 * don't allow users to edit it directly.
21692 * Spinner objects can have edition @b disabled, in which state they will
21693 * be changed only by arrows.
21694 * Useful for contexts
21695 * where you don't want your users to interact with it writting the value.
21697 * when using special values, the user can see real value instead
21698 * of special label on edition.
21700 * It's enabled by default.
21702 * @see elm_spinner_editable_get()
21706 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21709 * Get whether the spinner can be directly edited by the user or not.
21711 * @param obj The spinner object.
21712 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21713 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21715 * @see elm_spinner_editable_set() for details.
21719 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21722 * Set a special string to display in the place of the numerical value.
21724 * @param obj The spinner object.
21725 * @param value The value to be replaced.
21726 * @param label The label to be used.
21728 * It's useful for cases when a user should select an item that is
21729 * better indicated by a label than a value. For example, weekdays or months.
21733 * sp = elm_spinner_add(win);
21734 * elm_spinner_min_max_set(sp, 1, 3);
21735 * elm_spinner_special_value_add(sp, 1, "January");
21736 * elm_spinner_special_value_add(sp, 2, "February");
21737 * elm_spinner_special_value_add(sp, 3, "March");
21738 * evas_object_show(sp);
21743 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21746 * Set the interval on time updates for an user mouse button hold
21747 * on spinner widgets' arrows.
21749 * @param obj The spinner object.
21750 * @param interval The (first) interval value in seconds.
21752 * This interval value is @b decreased while the user holds the
21753 * mouse pointer either incrementing or decrementing spinner's value.
21755 * This helps the user to get to a given value distant from the
21756 * current one easier/faster, as it will start to change quicker and
21757 * quicker on mouse button holds.
21759 * The calculation for the next change interval value, starting from
21760 * the one set with this call, is the previous interval divided by
21761 * @c 1.05, so it decreases a little bit.
21763 * The default starting interval value for automatic changes is
21766 * @see elm_spinner_interval_get()
21770 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21773 * Get the interval on time updates for an user mouse button hold
21774 * on spinner widgets' arrows.
21776 * @param obj The spinner object.
21777 * @return The (first) interval value, in seconds, set on it.
21779 * @see elm_spinner_interval_set() for more details.
21783 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21790 * @defgroup Index Index
21792 * @image html img/widget/index/preview-00.png
21793 * @image latex img/widget/index/preview-00.eps
21795 * An index widget gives you an index for fast access to whichever
21796 * group of other UI items one might have. It's a list of text
21797 * items (usually letters, for alphabetically ordered access).
21799 * Index widgets are by default hidden and just appear when the
21800 * user clicks over it's reserved area in the canvas. In its
21801 * default theme, it's an area one @ref Fingers "finger" wide on
21802 * the right side of the index widget's container.
21804 * When items on the index are selected, smart callbacks get
21805 * called, so that its user can make other container objects to
21806 * show a given area or child object depending on the index item
21807 * selected. You'd probably be using an index together with @ref
21808 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21811 * Smart events one can add callbacks for are:
21812 * - @c "changed" - When the selected index item changes. @c
21813 * event_info is the selected item's data pointer.
21814 * - @c "delay,changed" - When the selected index item changes, but
21815 * after a small idling period. @c event_info is the selected
21816 * item's data pointer.
21817 * - @c "selected" - When the user releases a mouse button and
21818 * selects an item. @c event_info is the selected item's data
21820 * - @c "level,up" - when the user moves a finger from the first
21821 * level to the second level
21822 * - @c "level,down" - when the user moves a finger from the second
21823 * level to the first level
21825 * The @c "delay,changed" event is so that it'll wait a small time
21826 * before actually reporting those events and, moreover, just the
21827 * last event happening on those time frames will actually be
21830 * Here are some examples on its usage:
21831 * @li @ref index_example_01
21832 * @li @ref index_example_02
21836 * @addtogroup Index
21840 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21843 * Add a new index widget to the given parent Elementary
21844 * (container) object
21846 * @param parent The parent object
21847 * @return a new index widget handle or @c NULL, on errors
21849 * This function inserts a new index widget on the canvas.
21853 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21856 * Set whether a given index widget is or not visible,
21859 * @param obj The index object
21860 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21862 * Not to be confused with visible as in @c evas_object_show() --
21863 * visible with regard to the widget's auto hiding feature.
21865 * @see elm_index_active_get()
21869 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21872 * Get whether a given index widget is currently visible or not.
21874 * @param obj The index object
21875 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21877 * @see elm_index_active_set() for more details
21881 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21884 * Set the items level for a given index widget.
21886 * @param obj The index object.
21887 * @param level @c 0 or @c 1, the currently implemented levels.
21889 * @see elm_index_item_level_get()
21893 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21896 * Get the items level set for a given index widget.
21898 * @param obj The index object.
21899 * @return @c 0 or @c 1, which are the levels @p obj might be at.
21901 * @see elm_index_item_level_set() for more information
21905 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21908 * Returns the last selected item's data, for a given index widget.
21910 * @param obj The index object.
21911 * @return The item @b data associated to the last selected item on
21912 * @p obj (or @c NULL, on errors).
21914 * @warning The returned value is @b not an #Elm_Index_Item item
21915 * handle, but the data associated to it (see the @c item parameter
21916 * in elm_index_item_append(), as an example).
21920 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21923 * Append a new item on a given index widget.
21925 * @param obj The index object.
21926 * @param letter Letter under which the item should be indexed
21927 * @param item The item data to set for the index's item
21929 * Despite the most common usage of the @p letter argument is for
21930 * single char strings, one could use arbitrary strings as index
21933 * @c item will be the pointer returned back on @c "changed", @c
21934 * "delay,changed" and @c "selected" smart events.
21938 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21941 * Prepend a new item on a given index widget.
21943 * @param obj The index object.
21944 * @param letter Letter under which the item should be indexed
21945 * @param item The item data to set for the index's item
21947 * Despite the most common usage of the @p letter argument is for
21948 * single char strings, one could use arbitrary strings as index
21951 * @c item will be the pointer returned back on @c "changed", @c
21952 * "delay,changed" and @c "selected" smart events.
21956 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21959 * Append a new item, on a given index widget, <b>after the item
21960 * having @p relative as data</b>.
21962 * @param obj The index object.
21963 * @param letter Letter under which the item should be indexed
21964 * @param item The item data to set for the index's item
21965 * @param relative The item data of the index item to be the
21966 * predecessor of this new one
21968 * Despite the most common usage of the @p letter argument is for
21969 * single char strings, one could use arbitrary strings as index
21972 * @c item will be the pointer returned back on @c "changed", @c
21973 * "delay,changed" and @c "selected" smart events.
21975 * @note If @p relative is @c NULL or if it's not found to be data
21976 * set on any previous item on @p obj, this function will behave as
21977 * elm_index_item_append().
21981 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21984 * Prepend a new item, on a given index widget, <b>after the item
21985 * having @p relative as data</b>.
21987 * @param obj The index object.
21988 * @param letter Letter under which the item should be indexed
21989 * @param item The item data to set for the index's item
21990 * @param relative The item data of the index item to be the
21991 * successor of this new one
21993 * Despite the most common usage of the @p letter argument is for
21994 * single char strings, one could use arbitrary strings as index
21997 * @c item will be the pointer returned back on @c "changed", @c
21998 * "delay,changed" and @c "selected" smart events.
22000 * @note If @p relative is @c NULL or if it's not found to be data
22001 * set on any previous item on @p obj, this function will behave as
22002 * elm_index_item_prepend().
22006 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22009 * Insert a new item into the given index widget, using @p cmp_func
22010 * function to sort items (by item handles).
22012 * @param obj The index object.
22013 * @param letter Letter under which the item should be indexed
22014 * @param item The item data to set for the index's item
22015 * @param cmp_func The comparing function to be used to sort index
22016 * items <b>by #Elm_Index_Item item handles</b>
22017 * @param cmp_data_func A @b fallback function to be called for the
22018 * sorting of index items <b>by item data</b>). It will be used
22019 * when @p cmp_func returns @c 0 (equality), which means an index
22020 * item with provided item data already exists. To decide which
22021 * data item should be pointed to by the index item in question, @p
22022 * cmp_data_func will be used. If @p cmp_data_func returns a
22023 * non-negative value, the previous index item data will be
22024 * replaced by the given @p item pointer. If the previous data need
22025 * to be freed, it should be done by the @p cmp_data_func function,
22026 * because all references to it will be lost. If this function is
22027 * not provided (@c NULL is given), index items will be @b
22028 * duplicated, if @p cmp_func returns @c 0.
22030 * Despite the most common usage of the @p letter argument is for
22031 * single char strings, one could use arbitrary strings as index
22034 * @c item will be the pointer returned back on @c "changed", @c
22035 * "delay,changed" and @c "selected" smart events.
22039 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);
22042 * Remove an item from a given index widget, <b>to be referenced by
22043 * it's data value</b>.
22045 * @param obj The index object
22046 * @param item The item's data pointer for the item to be removed
22049 * If a deletion callback is set, via elm_index_item_del_cb_set(),
22050 * that callback function will be called by this one.
22052 * @warning The item to be removed from @p obj will be found via
22053 * its item data pointer, and not by an #Elm_Index_Item handle.
22057 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22060 * Find a given index widget's item, <b>using item data</b>.
22062 * @param obj The index object
22063 * @param item The item data pointed to by the desired index item
22064 * @return The index item handle, if found, or @c NULL otherwise
22068 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22071 * Removes @b all items from a given index widget.
22073 * @param obj The index object.
22075 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
22076 * that callback function will be called for each item in @p obj.
22080 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22083 * Go to a given items level on a index widget
22085 * @param obj The index object
22086 * @param level The index level (one of @c 0 or @c 1)
22090 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22093 * Return the data associated with a given index widget item
22095 * @param it The index widget item handle
22096 * @return The data associated with @p it
22098 * @see elm_index_item_data_set()
22102 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22105 * Set the data associated with a given index widget item
22107 * @param it The index widget item handle
22108 * @param data The new data pointer to set to @p it
22110 * This sets new item data on @p it.
22112 * @warning The old data pointer won't be touched by this function, so
22113 * the user had better to free that old data himself/herself.
22117 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22120 * Set the function to be called when a given index widget item is freed.
22122 * @param it The item to set the callback on
22123 * @param func The function to call on the item's deletion
22125 * When called, @p func will have both @c data and @c event_info
22126 * arguments with the @p it item's data value and, naturally, the
22127 * @c obj argument with a handle to the parent index widget.
22131 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22134 * Get the letter (string) set on a given index widget item.
22136 * @param it The index item handle
22137 * @return The letter string set on @p it
22141 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22145 EAPI void elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
22152 * @defgroup Photocam Photocam
22154 * @image html img/widget/photocam/preview-00.png
22155 * @image latex img/widget/photocam/preview-00.eps
22157 * This is a widget specifically for displaying high-resolution digital
22158 * camera photos giving speedy feedback (fast load), low memory footprint
22159 * and zooming and panning as well as fitting logic. It is entirely focused
22160 * on jpeg images, and takes advantage of properties of the jpeg format (via
22161 * evas loader features in the jpeg loader).
22163 * Signals that you can add callbacks for are:
22164 * @li "clicked" - This is called when a user has clicked the photo without
22166 * @li "press" - This is called when a user has pressed down on the photo.
22167 * @li "longpressed" - This is called when a user has pressed down on the
22168 * photo for a long time without dragging around.
22169 * @li "clicked,double" - This is called when a user has double-clicked the
22171 * @li "load" - Photo load begins.
22172 * @li "loaded" - This is called when the image file load is complete for the
22173 * first view (low resolution blurry version).
22174 * @li "load,detail" - Photo detailed data load begins.
22175 * @li "loaded,detail" - This is called when the image file load is complete
22176 * for the detailed image data (full resolution needed).
22177 * @li "zoom,start" - Zoom animation started.
22178 * @li "zoom,stop" - Zoom animation stopped.
22179 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22180 * @li "scroll" - the content has been scrolled (moved)
22181 * @li "scroll,anim,start" - scrolling animation has started
22182 * @li "scroll,anim,stop" - scrolling animation has stopped
22183 * @li "scroll,drag,start" - dragging the contents around has started
22184 * @li "scroll,drag,stop" - dragging the contents around has stopped
22186 * @ref tutorial_photocam shows the API in action.
22190 * @brief Types of zoom available.
22192 typedef enum _Elm_Photocam_Zoom_Mode
22194 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
22195 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22196 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22197 ELM_PHOTOCAM_ZOOM_MODE_LAST
22198 } Elm_Photocam_Zoom_Mode;
22200 * @brief Add a new Photocam object
22202 * @param parent The parent object
22203 * @return The new object or NULL if it cannot be created
22205 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22207 * @brief Set the photo file to be shown
22209 * @param obj The photocam object
22210 * @param file The photo file
22211 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22213 * This sets (and shows) the specified file (with a relative or absolute
22214 * path) and will return a load error (same error that
22215 * evas_object_image_load_error_get() will return). The image will change and
22216 * adjust its size at this point and begin a background load process for this
22217 * photo that at some time in the future will be displayed at the full
22220 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22222 * @brief Returns the path of the current image file
22224 * @param obj The photocam object
22225 * @return Returns the path
22227 * @see elm_photocam_file_set()
22229 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22231 * @brief Set the zoom level of the photo
22233 * @param obj The photocam object
22234 * @param zoom The zoom level to set
22236 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22237 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22238 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22239 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22242 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22244 * @brief Get the zoom level of the photo
22246 * @param obj The photocam object
22247 * @return The current zoom level
22249 * This returns the current zoom level of the photocam object. Note that if
22250 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22251 * (which is the default), the zoom level may be changed at any time by the
22252 * photocam object itself to account for photo size and photocam viewpoer
22255 * @see elm_photocam_zoom_set()
22256 * @see elm_photocam_zoom_mode_set()
22258 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22260 * @brief Set the zoom mode
22262 * @param obj The photocam object
22263 * @param mode The desired mode
22265 * This sets the zoom mode to manual or one of several automatic levels.
22266 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22267 * elm_photocam_zoom_set() and will stay at that level until changed by code
22268 * or until zoom mode is changed. This is the default mode. The Automatic
22269 * modes will allow the photocam object to automatically adjust zoom mode
22270 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22271 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22272 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22273 * pixels within the frame are left unfilled.
22275 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22277 * @brief Get the zoom mode
22279 * @param obj The photocam object
22280 * @return The current zoom mode
22282 * This gets the current zoom mode of the photocam object.
22284 * @see elm_photocam_zoom_mode_set()
22286 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22288 * @brief Get the current image pixel width and height
22290 * @param obj The photocam object
22291 * @param w A pointer to the width return
22292 * @param h A pointer to the height return
22294 * This gets the current photo pixel width and height (for the original).
22295 * The size will be returned in the integers @p w and @p h that are pointed
22298 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22300 * @brief Get the area of the image that is currently shown
22303 * @param x A pointer to the X-coordinate of region
22304 * @param y A pointer to the Y-coordinate of region
22305 * @param w A pointer to the width
22306 * @param h A pointer to the height
22308 * @see elm_photocam_image_region_show()
22309 * @see elm_photocam_image_region_bring_in()
22311 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22313 * @brief Set the viewed portion of the image
22315 * @param obj The photocam object
22316 * @param x X-coordinate of region in image original pixels
22317 * @param y Y-coordinate of region in image original pixels
22318 * @param w Width of region in image original pixels
22319 * @param h Height of region in image original pixels
22321 * This shows the region of the image without using animation.
22323 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22325 * @brief Bring in the viewed portion of the image
22327 * @param obj The photocam object
22328 * @param x X-coordinate of region in image original pixels
22329 * @param y Y-coordinate of region in image original pixels
22330 * @param w Width of region in image original pixels
22331 * @param h Height of region in image original pixels
22333 * This shows the region of the image using animation.
22335 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22337 * @brief Set the paused state for photocam
22339 * @param obj The photocam object
22340 * @param paused The pause state to set
22342 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22343 * photocam. The default is off. This will stop zooming using animation on
22344 * zoom levels changes and change instantly. This will stop any existing
22345 * animations that are running.
22347 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22349 * @brief Get the paused state for photocam
22351 * @param obj The photocam object
22352 * @return The current paused state
22354 * This gets the current paused state for the photocam object.
22356 * @see elm_photocam_paused_set()
22358 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22360 * @brief Get the internal low-res image used for photocam
22362 * @param obj The photocam object
22363 * @return The internal image object handle, or NULL if none exists
22365 * This gets the internal image object inside photocam. Do not modify it. It
22366 * is for inspection only, and hooking callbacks to. Nothing else. It may be
22367 * deleted at any time as well.
22369 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22371 * @brief Set the photocam scrolling bouncing.
22373 * @param obj The photocam object
22374 * @param h_bounce bouncing for horizontal
22375 * @param v_bounce bouncing for vertical
22377 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22379 * @brief Get the photocam scrolling bouncing.
22381 * @param obj The photocam object
22382 * @param h_bounce bouncing for horizontal
22383 * @param v_bounce bouncing for vertical
22385 * @see elm_photocam_bounce_set()
22387 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22393 * @defgroup Map Map
22394 * @ingroup Elementary
22396 * @image html img/widget/map/preview-00.png
22397 * @image latex img/widget/map/preview-00.eps
22399 * This is a widget specifically for displaying a map. It uses basically
22400 * OpenStreetMap provider http://www.openstreetmap.org/,
22401 * but custom providers can be added.
22403 * It supports some basic but yet nice features:
22404 * @li zoom and scroll
22405 * @li markers with content to be displayed when user clicks over it
22406 * @li group of markers
22409 * Smart callbacks one can listen to:
22411 * - "clicked" - This is called when a user has clicked the map without
22413 * - "press" - This is called when a user has pressed down on the map.
22414 * - "longpressed" - This is called when a user has pressed down on the map
22415 * for a long time without dragging around.
22416 * - "clicked,double" - This is called when a user has double-clicked
22418 * - "load,detail" - Map detailed data load begins.
22419 * - "loaded,detail" - This is called when all currently visible parts of
22420 * the map are loaded.
22421 * - "zoom,start" - Zoom animation started.
22422 * - "zoom,stop" - Zoom animation stopped.
22423 * - "zoom,change" - Zoom changed when using an auto zoom mode.
22424 * - "scroll" - the content has been scrolled (moved).
22425 * - "scroll,anim,start" - scrolling animation has started.
22426 * - "scroll,anim,stop" - scrolling animation has stopped.
22427 * - "scroll,drag,start" - dragging the contents around has started.
22428 * - "scroll,drag,stop" - dragging the contents around has stopped.
22429 * - "downloaded" - This is called when all currently required map images
22431 * - "route,load" - This is called when route request begins.
22432 * - "route,loaded" - This is called when route request ends.
22433 * - "name,load" - This is called when name request begins.
22434 * - "name,loaded- This is called when name request ends.
22436 * Available style for map widget:
22439 * Available style for markers:
22444 * Available style for marker bubble:
22447 * List of examples:
22448 * @li @ref map_example_01
22449 * @li @ref map_example_02
22450 * @li @ref map_example_03
22459 * @enum _Elm_Map_Zoom_Mode
22460 * @typedef Elm_Map_Zoom_Mode
22462 * Set map's zoom behavior. It can be set to manual or automatic.
22464 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22466 * Values <b> don't </b> work as bitmask, only one can be choosen.
22468 * @note Valid sizes are 2^zoom, consequently the map may be smaller
22469 * than the scroller view.
22471 * @see elm_map_zoom_mode_set()
22472 * @see elm_map_zoom_mode_get()
22476 typedef enum _Elm_Map_Zoom_Mode
22478 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22479 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22480 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22481 ELM_MAP_ZOOM_MODE_LAST
22482 } Elm_Map_Zoom_Mode;
22485 * @enum _Elm_Map_Route_Sources
22486 * @typedef Elm_Map_Route_Sources
22488 * Set route service to be used. By default used source is
22489 * #ELM_MAP_ROUTE_SOURCE_YOURS.
22491 * @see elm_map_route_source_set()
22492 * @see elm_map_route_source_get()
22496 typedef enum _Elm_Map_Route_Sources
22498 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22499 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. */
22500 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22501 ELM_MAP_ROUTE_SOURCE_LAST
22502 } Elm_Map_Route_Sources;
22504 typedef enum _Elm_Map_Name_Sources
22506 ELM_MAP_NAME_SOURCE_NOMINATIM,
22507 ELM_MAP_NAME_SOURCE_LAST
22508 } Elm_Map_Name_Sources;
22511 * @enum _Elm_Map_Route_Type
22512 * @typedef Elm_Map_Route_Type
22514 * Set type of transport used on route.
22516 * @see elm_map_route_add()
22520 typedef enum _Elm_Map_Route_Type
22522 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22523 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22524 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22525 ELM_MAP_ROUTE_TYPE_LAST
22526 } Elm_Map_Route_Type;
22529 * @enum _Elm_Map_Route_Method
22530 * @typedef Elm_Map_Route_Method
22532 * Set the routing method, what should be priorized, time or distance.
22534 * @see elm_map_route_add()
22538 typedef enum _Elm_Map_Route_Method
22540 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22541 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22542 ELM_MAP_ROUTE_METHOD_LAST
22543 } Elm_Map_Route_Method;
22545 typedef enum _Elm_Map_Name_Method
22547 ELM_MAP_NAME_METHOD_SEARCH,
22548 ELM_MAP_NAME_METHOD_REVERSE,
22549 ELM_MAP_NAME_METHOD_LAST
22550 } Elm_Map_Name_Method;
22552 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(). */
22553 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(). */
22554 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(). */
22555 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(). */
22556 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
22557 typedef struct _Elm_Map_Track Elm_Map_Track;
22559 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. */
22560 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22561 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22562 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22564 typedef char *(*ElmMapModuleSourceFunc) (void);
22565 typedef int (*ElmMapModuleZoomMinFunc) (void);
22566 typedef int (*ElmMapModuleZoomMaxFunc) (void);
22567 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22568 typedef int (*ElmMapModuleRouteSourceFunc) (void);
22569 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22570 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22571 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22572 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22575 * Add a new map widget to the given parent Elementary (container) object.
22577 * @param parent The parent object.
22578 * @return a new map widget handle or @c NULL, on errors.
22580 * This function inserts a new map widget on the canvas.
22584 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22587 * Set the zoom level of the map.
22589 * @param obj The map object.
22590 * @param zoom The zoom level to set.
22592 * This sets the zoom level.
22594 * It will respect limits defined by elm_map_source_zoom_min_set() and
22595 * elm_map_source_zoom_max_set().
22597 * By default these values are 0 (world map) and 18 (maximum zoom).
22599 * This function should be used when zoom mode is set to
22600 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22601 * with elm_map_zoom_mode_set().
22603 * @see elm_map_zoom_mode_set().
22604 * @see elm_map_zoom_get().
22608 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22611 * Get the zoom level of the map.
22613 * @param obj The map object.
22614 * @return The current zoom level.
22616 * This returns the current zoom level of the map object.
22618 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22619 * (which is the default), the zoom level may be changed at any time by the
22620 * map object itself to account for map size and map viewport size.
22622 * @see elm_map_zoom_set() for details.
22626 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22629 * Set the zoom mode used by the map object.
22631 * @param obj The map object.
22632 * @param mode The zoom mode of the map, being it one of
22633 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22634 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22636 * This sets the zoom mode to manual or one of the automatic levels.
22637 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22638 * elm_map_zoom_set() and will stay at that level until changed by code
22639 * or until zoom mode is changed. This is the default mode.
22641 * The Automatic modes will allow the map object to automatically
22642 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22643 * adjust zoom so the map fits inside the scroll frame with no pixels
22644 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22645 * ensure no pixels within the frame are left unfilled. Do not forget that
22646 * the valid sizes are 2^zoom, consequently the map may be smaller than
22647 * the scroller view.
22649 * @see elm_map_zoom_set()
22653 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22656 * Get the zoom mode used by the map object.
22658 * @param obj The map object.
22659 * @return The zoom mode of the map, being it one of
22660 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22661 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22663 * This function returns the current zoom mode used by the map object.
22665 * @see elm_map_zoom_mode_set() for more details.
22669 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22672 * Get the current coordinates of the map.
22674 * @param obj The map object.
22675 * @param lon Pointer where to store longitude.
22676 * @param lat Pointer where to store latitude.
22678 * This gets the current center coordinates of the map object. It can be
22679 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22681 * @see elm_map_geo_region_bring_in()
22682 * @see elm_map_geo_region_show()
22686 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22689 * Animatedly bring in given coordinates to the center of the map.
22691 * @param obj The map object.
22692 * @param lon Longitude to center at.
22693 * @param lat Latitude to center at.
22695 * This causes map to jump to the given @p lat and @p lon coordinates
22696 * and show it (by scrolling) in the center of the viewport, if it is not
22697 * already centered. This will use animation to do so and take a period
22698 * of time to complete.
22700 * @see elm_map_geo_region_show() for a function to avoid animation.
22701 * @see elm_map_geo_region_get()
22705 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22708 * Show the given coordinates at the center of the map, @b immediately.
22710 * @param obj The map object.
22711 * @param lon Longitude to center at.
22712 * @param lat Latitude to center at.
22714 * This causes map to @b redraw its viewport's contents to the
22715 * region contining the given @p lat and @p lon, that will be moved to the
22716 * center of the map.
22718 * @see elm_map_geo_region_bring_in() for a function to move with animation.
22719 * @see elm_map_geo_region_get()
22723 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22726 * Pause or unpause the map.
22728 * @param obj The map object.
22729 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22732 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22735 * The default is off.
22737 * This will stop zooming using animation, changing zoom levels will
22738 * change instantly. This will stop any existing animations that are running.
22740 * @see elm_map_paused_get()
22744 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22747 * Get a value whether map is paused or not.
22749 * @param obj The map object.
22750 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22751 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22753 * This gets the current paused state for the map object.
22755 * @see elm_map_paused_set() for details.
22759 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22762 * Set to show markers during zoom level changes or not.
22764 * @param obj The map object.
22765 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22768 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22771 * The default is off.
22773 * This will stop zooming using animation, changing zoom levels will
22774 * change instantly. This will stop any existing animations that are running.
22776 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22779 * The default is off.
22781 * Enabling it will force the map to stop displaying the markers during
22782 * zoom level changes. Set to on if you have a large number of markers.
22784 * @see elm_map_paused_markers_get()
22788 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22791 * Get a value whether markers will be displayed on zoom level changes or not
22793 * @param obj The map object.
22794 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22795 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22797 * This gets the current markers paused state for the map object.
22799 * @see elm_map_paused_markers_set() for details.
22803 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22806 * Get the information of downloading status.
22808 * @param obj The map object.
22809 * @param try_num Pointer where to store number of tiles being downloaded.
22810 * @param finish_num Pointer where to store number of tiles successfully
22813 * This gets the current downloading status for the map object, the number
22814 * of tiles being downloaded and the number of tiles already downloaded.
22818 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22821 * Convert a pixel coordinate (x,y) into a geographic coordinate
22822 * (longitude, latitude).
22824 * @param obj The map object.
22825 * @param x the coordinate.
22826 * @param y the coordinate.
22827 * @param size the size in pixels of the map.
22828 * The map is a square and generally his size is : pow(2.0, zoom)*256.
22829 * @param lon Pointer where to store the longitude that correspond to x.
22830 * @param lat Pointer where to store the latitude that correspond to y.
22832 * @note Origin pixel point is the top left corner of the viewport.
22833 * Map zoom and size are taken on account.
22835 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22839 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);
22842 * Convert a geographic coordinate (longitude, latitude) into a pixel
22843 * coordinate (x, y).
22845 * @param obj The map object.
22846 * @param lon the longitude.
22847 * @param lat the latitude.
22848 * @param size the size in pixels of the map. The map is a square
22849 * and generally his size is : pow(2.0, zoom)*256.
22850 * @param x Pointer where to store the horizontal pixel coordinate that
22851 * correspond to the longitude.
22852 * @param y Pointer where to store the vertical pixel coordinate that
22853 * correspond to the latitude.
22855 * @note Origin pixel point is the top left corner of the viewport.
22856 * Map zoom and size are taken on account.
22858 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22862 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);
22865 * Convert a geographic coordinate (longitude, latitude) into a name
22868 * @param obj The map object.
22869 * @param lon the longitude.
22870 * @param lat the latitude.
22871 * @return name A #Elm_Map_Name handle for this coordinate.
22873 * To get the string for this address, elm_map_name_address_get()
22876 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
22880 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22883 * Convert a name (address) into a geographic coordinate
22884 * (longitude, latitude).
22886 * @param obj The map object.
22887 * @param name The address.
22888 * @return name A #Elm_Map_Name handle for this address.
22890 * To get the longitude and latitude, elm_map_name_region_get()
22893 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
22897 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
22900 * Convert a pixel coordinate into a rotated pixel coordinate.
22902 * @param obj The map object.
22903 * @param x horizontal coordinate of the point to rotate.
22904 * @param y vertical coordinate of the point to rotate.
22905 * @param cx rotation's center horizontal position.
22906 * @param cy rotation's center vertical position.
22907 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
22908 * @param xx Pointer where to store rotated x.
22909 * @param yy Pointer where to store rotated y.
22913 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);
22916 * Add a new marker to the map object.
22918 * @param obj The map object.
22919 * @param lon The longitude of the marker.
22920 * @param lat The latitude of the marker.
22921 * @param clas The class, to use when marker @b isn't grouped to others.
22922 * @param clas_group The class group, to use when marker is grouped to others
22923 * @param data The data passed to the callbacks.
22925 * @return The created marker or @c NULL upon failure.
22927 * A marker will be created and shown in a specific point of the map, defined
22928 * by @p lon and @p lat.
22930 * It will be displayed using style defined by @p class when this marker
22931 * is displayed alone (not grouped). A new class can be created with
22932 * elm_map_marker_class_new().
22934 * If the marker is grouped to other markers, it will be displayed with
22935 * style defined by @p class_group. Markers with the same group are grouped
22936 * if they are close. A new group class can be created with
22937 * elm_map_marker_group_class_new().
22939 * Markers created with this method can be deleted with
22940 * elm_map_marker_remove().
22942 * A marker can have associated content to be displayed by a bubble,
22943 * when a user click over it, as well as an icon. These objects will
22944 * be fetch using class' callback functions.
22946 * @see elm_map_marker_class_new()
22947 * @see elm_map_marker_group_class_new()
22948 * @see elm_map_marker_remove()
22952 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);
22955 * Set the maximum numbers of markers' content to be displayed in a group.
22957 * @param obj The map object.
22958 * @param max The maximum numbers of items displayed in a bubble.
22960 * A bubble will be displayed when the user clicks over the group,
22961 * and will place the content of markers that belong to this group
22964 * A group can have a long list of markers, consequently the creation
22965 * of the content of the bubble can be very slow.
22967 * In order to avoid this, a maximum number of items is displayed
22970 * By default this number is 30.
22972 * Marker with the same group class are grouped if they are close.
22974 * @see elm_map_marker_add()
22978 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
22981 * Remove a marker from the map.
22983 * @param marker The marker to remove.
22985 * @see elm_map_marker_add()
22989 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22992 * Get the current coordinates of the marker.
22994 * @param marker marker.
22995 * @param lat Pointer where to store the marker's latitude.
22996 * @param lon Pointer where to store the marker's longitude.
22998 * These values are set when adding markers, with function
22999 * elm_map_marker_add().
23001 * @see elm_map_marker_add()
23005 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
23008 * Animatedly bring in given marker to the center of the map.
23010 * @param marker The marker to center at.
23012 * This causes map to jump to the given @p marker's coordinates
23013 * and show it (by scrolling) in the center of the viewport, if it is not
23014 * already centered. This will use animation to do so and take a period
23015 * of time to complete.
23017 * @see elm_map_marker_show() for a function to avoid animation.
23018 * @see elm_map_marker_region_get()
23022 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23025 * Show the given marker at the center of the map, @b immediately.
23027 * @param marker The marker to center at.
23029 * This causes map to @b redraw its viewport's contents to the
23030 * region contining the given @p marker's coordinates, that will be
23031 * moved to the center of the map.
23033 * @see elm_map_marker_bring_in() for a function to move with animation.
23034 * @see elm_map_markers_list_show() if more than one marker need to be
23036 * @see elm_map_marker_region_get()
23040 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23043 * Move and zoom the map to display a list of markers.
23045 * @param markers A list of #Elm_Map_Marker handles.
23047 * The map will be centered on the center point of the markers in the list.
23048 * Then the map will be zoomed in order to fit the markers using the maximum
23049 * zoom which allows display of all the markers.
23051 * @warning All the markers should belong to the same map object.
23053 * @see elm_map_marker_show() to show a single marker.
23054 * @see elm_map_marker_bring_in()
23058 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
23061 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
23063 * @param marker The marker wich content should be returned.
23064 * @return Return the evas object if it exists, else @c NULL.
23066 * To set callback function #ElmMapMarkerGetFunc for the marker class,
23067 * elm_map_marker_class_get_cb_set() should be used.
23069 * This content is what will be inside the bubble that will be displayed
23070 * when an user clicks over the marker.
23072 * This returns the actual Evas object used to be placed inside
23073 * the bubble. This may be @c NULL, as it may
23074 * not have been created or may have been deleted, at any time, by
23075 * the map. <b>Do not modify this object</b> (move, resize,
23076 * show, hide, etc.), as the map is controlling it. This
23077 * function is for querying, emitting custom signals or hooking
23078 * lower level callbacks for events on that object. Do not delete
23079 * this object under any circumstances.
23083 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23086 * Update the marker
23088 * @param marker The marker to be updated.
23090 * If a content is set to this marker, it will call function to delete it,
23091 * #ElmMapMarkerDelFunc, and then will fetch the content again with
23092 * #ElmMapMarkerGetFunc.
23094 * These functions are set for the marker class with
23095 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23099 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23102 * Close all the bubbles opened by the user.
23104 * @param obj The map object.
23106 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23107 * when the user clicks on a marker.
23109 * This functions is set for the marker class with
23110 * elm_map_marker_class_get_cb_set().
23114 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23117 * Create a new group class.
23119 * @param obj The map object.
23120 * @return Returns the new group class.
23122 * Each marker must be associated to a group class. Markers in the same
23123 * group are grouped if they are close.
23125 * The group class defines the style of the marker when a marker is grouped
23126 * to others markers. When it is alone, another class will be used.
23128 * A group class will need to be provided when creating a marker with
23129 * elm_map_marker_add().
23131 * Some properties and functions can be set by class, as:
23132 * - style, with elm_map_group_class_style_set()
23133 * - data - to be associated to the group class. It can be set using
23134 * elm_map_group_class_data_set().
23135 * - min zoom to display markers, set with
23136 * elm_map_group_class_zoom_displayed_set().
23137 * - max zoom to group markers, set using
23138 * elm_map_group_class_zoom_grouped_set().
23139 * - visibility - set if markers will be visible or not, set with
23140 * elm_map_group_class_hide_set().
23141 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23142 * It can be set using elm_map_group_class_icon_cb_set().
23144 * @see elm_map_marker_add()
23145 * @see elm_map_group_class_style_set()
23146 * @see elm_map_group_class_data_set()
23147 * @see elm_map_group_class_zoom_displayed_set()
23148 * @see elm_map_group_class_zoom_grouped_set()
23149 * @see elm_map_group_class_hide_set()
23150 * @see elm_map_group_class_icon_cb_set()
23154 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23157 * Set the marker's style of a group class.
23159 * @param clas The group class.
23160 * @param style The style to be used by markers.
23162 * Each marker must be associated to a group class, and will use the style
23163 * defined by such class when grouped to other markers.
23165 * The following styles are provided by default theme:
23166 * @li @c radio - blue circle
23167 * @li @c radio2 - green circle
23170 * @see elm_map_group_class_new() for more details.
23171 * @see elm_map_marker_add()
23175 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23178 * Set the icon callback function of a group class.
23180 * @param clas The group class.
23181 * @param icon_get The callback function that will return the icon.
23183 * Each marker must be associated to a group class, and it can display a
23184 * custom icon. The function @p icon_get must return this icon.
23186 * @see elm_map_group_class_new() for more details.
23187 * @see elm_map_marker_add()
23191 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23194 * Set the data associated to the group class.
23196 * @param clas The group class.
23197 * @param data The new user data.
23199 * This data will be passed for callback functions, like icon get callback,
23200 * that can be set with elm_map_group_class_icon_cb_set().
23202 * If a data was previously set, the object will lose the pointer for it,
23203 * so if needs to be freed, you must do it yourself.
23205 * @see elm_map_group_class_new() for more details.
23206 * @see elm_map_group_class_icon_cb_set()
23207 * @see elm_map_marker_add()
23211 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23214 * Set the minimum zoom from where the markers are displayed.
23216 * @param clas The group class.
23217 * @param zoom The minimum zoom.
23219 * Markers only will be displayed when the map is displayed at @p zoom
23222 * @see elm_map_group_class_new() for more details.
23223 * @see elm_map_marker_add()
23227 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23230 * Set the zoom from where the markers are no more grouped.
23232 * @param clas The group class.
23233 * @param zoom The maximum zoom.
23235 * Markers only will be grouped when the map is displayed at
23236 * less than @p zoom.
23238 * @see elm_map_group_class_new() for more details.
23239 * @see elm_map_marker_add()
23243 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23246 * Set if the markers associated to the group class @clas are hidden or not.
23248 * @param clas The group class.
23249 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23252 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23257 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23260 * Create a new marker class.
23262 * @param obj The map object.
23263 * @return Returns the new group class.
23265 * Each marker must be associated to a class.
23267 * The marker class defines the style of the marker when a marker is
23268 * displayed alone, i.e., not grouped to to others markers. When grouped
23269 * it will use group class style.
23271 * A marker class will need to be provided when creating a marker with
23272 * elm_map_marker_add().
23274 * Some properties and functions can be set by class, as:
23275 * - style, with elm_map_marker_class_style_set()
23276 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23277 * It can be set using elm_map_marker_class_icon_cb_set().
23278 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23279 * Set using elm_map_marker_class_get_cb_set().
23280 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23281 * Set using elm_map_marker_class_del_cb_set().
23283 * @see elm_map_marker_add()
23284 * @see elm_map_marker_class_style_set()
23285 * @see elm_map_marker_class_icon_cb_set()
23286 * @see elm_map_marker_class_get_cb_set()
23287 * @see elm_map_marker_class_del_cb_set()
23291 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23294 * Set the marker's style of a marker class.
23296 * @param clas The marker class.
23297 * @param style The style to be used by markers.
23299 * Each marker must be associated to a marker class, and will use the style
23300 * defined by such class when alone, i.e., @b not grouped to other markers.
23302 * The following styles are provided by default theme:
23307 * @see elm_map_marker_class_new() for more details.
23308 * @see elm_map_marker_add()
23312 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23315 * Set the icon callback function of a marker class.
23317 * @param clas The marker class.
23318 * @param icon_get The callback function that will return the icon.
23320 * Each marker must be associated to a marker class, and it can display a
23321 * custom icon. The function @p icon_get must return this icon.
23323 * @see elm_map_marker_class_new() for more details.
23324 * @see elm_map_marker_add()
23328 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23331 * Set the bubble content callback function of a marker class.
23333 * @param clas The marker class.
23334 * @param get The callback function that will return the content.
23336 * Each marker must be associated to a marker class, and it can display a
23337 * a content on a bubble that opens when the user click over the marker.
23338 * The function @p get must return this content object.
23340 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23343 * @see elm_map_marker_class_new() for more details.
23344 * @see elm_map_marker_class_del_cb_set()
23345 * @see elm_map_marker_add()
23349 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23352 * Set the callback function used to delete bubble content of a marker class.
23354 * @param clas The marker class.
23355 * @param del The callback function that will delete the content.
23357 * Each marker must be associated to a marker class, and it can display a
23358 * a content on a bubble that opens when the user click over the marker.
23359 * The function to return such content can be set with
23360 * elm_map_marker_class_get_cb_set().
23362 * If this content must be freed, a callback function need to be
23363 * set for that task with this function.
23365 * If this callback is defined it will have to delete (or not) the
23366 * object inside, but if the callback is not defined the object will be
23367 * destroyed with evas_object_del().
23369 * @see elm_map_marker_class_new() for more details.
23370 * @see elm_map_marker_class_get_cb_set()
23371 * @see elm_map_marker_add()
23375 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23378 * Get the list of available sources.
23380 * @param obj The map object.
23381 * @return The source names list.
23383 * It will provide a list with all available sources, that can be set as
23384 * current source with elm_map_source_name_set(), or get with
23385 * elm_map_source_name_get().
23387 * Available sources:
23393 * @see elm_map_source_name_set() for more details.
23394 * @see elm_map_source_name_get()
23398 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23401 * Set the source of the map.
23403 * @param obj The map object.
23404 * @param source The source to be used.
23406 * Map widget retrieves images that composes the map from a web service.
23407 * This web service can be set with this method.
23409 * A different service can return a different maps with different
23410 * information and it can use different zoom values.
23412 * The @p source_name need to match one of the names provided by
23413 * elm_map_source_names_get().
23415 * The current source can be get using elm_map_source_name_get().
23417 * @see elm_map_source_names_get()
23418 * @see elm_map_source_name_get()
23423 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23426 * Get the name of currently used source.
23428 * @param obj The map object.
23429 * @return Returns the name of the source in use.
23431 * @see elm_map_source_name_set() for more details.
23435 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23438 * Set the source of the route service to be used by the map.
23440 * @param obj The map object.
23441 * @param source The route service to be used, being it one of
23442 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23443 * and #ELM_MAP_ROUTE_SOURCE_ORS.
23445 * Each one has its own algorithm, so the route retrieved may
23446 * differ depending on the source route. Now, only the default is working.
23448 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23449 * http://www.yournavigation.org/.
23451 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23452 * assumptions. Its routing core is based on Contraction Hierarchies.
23454 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23456 * @see elm_map_route_source_get().
23460 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23463 * Get the current route source.
23465 * @param obj The map object.
23466 * @return The source of the route service used by the map.
23468 * @see elm_map_route_source_set() for details.
23472 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23475 * Set the minimum zoom of the source.
23477 * @param obj The map object.
23478 * @param zoom New minimum zoom value to be used.
23480 * By default, it's 0.
23484 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23487 * Get the minimum zoom of the source.
23489 * @param obj The map object.
23490 * @return Returns the minimum zoom of the source.
23492 * @see elm_map_source_zoom_min_set() for details.
23496 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23499 * Set the maximum zoom of the source.
23501 * @param obj The map object.
23502 * @param zoom New maximum zoom value to be used.
23504 * By default, it's 18.
23508 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23511 * Get the maximum zoom of the source.
23513 * @param obj The map object.
23514 * @return Returns the maximum zoom of the source.
23516 * @see elm_map_source_zoom_min_set() for details.
23520 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23523 * Set the user agent used by the map object to access routing services.
23525 * @param obj The map object.
23526 * @param user_agent The user agent to be used by the map.
23528 * User agent is a client application implementing a network protocol used
23529 * in communications within a clientāserver distributed computing system
23531 * The @p user_agent identification string will transmitted in a header
23532 * field @c User-Agent.
23534 * @see elm_map_user_agent_get()
23538 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23541 * Get the user agent used by the map object.
23543 * @param obj The map object.
23544 * @return The user agent identification string used by the map.
23546 * @see elm_map_user_agent_set() for details.
23550 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23553 * Add a new route to the map object.
23555 * @param obj The map object.
23556 * @param type The type of transport to be considered when tracing a route.
23557 * @param method The routing method, what should be priorized.
23558 * @param flon The start longitude.
23559 * @param flat The start latitude.
23560 * @param tlon The destination longitude.
23561 * @param tlat The destination latitude.
23563 * @return The created route or @c NULL upon failure.
23565 * A route will be traced by point on coordinates (@p flat, @p flon)
23566 * to point on coordinates (@p tlat, @p tlon), using the route service
23567 * set with elm_map_route_source_set().
23569 * It will take @p type on consideration to define the route,
23570 * depending if the user will be walking or driving, the route may vary.
23571 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23572 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23574 * Another parameter is what the route should priorize, the minor distance
23575 * or the less time to be spend on the route. So @p method should be one
23576 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23578 * Routes created with this method can be deleted with
23579 * elm_map_route_remove(), colored with elm_map_route_color_set(),
23580 * and distance can be get with elm_map_route_distance_get().
23582 * @see elm_map_route_remove()
23583 * @see elm_map_route_color_set()
23584 * @see elm_map_route_distance_get()
23585 * @see elm_map_route_source_set()
23589 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);
23592 * Remove a route from the map.
23594 * @param route The route to remove.
23596 * @see elm_map_route_add()
23600 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23603 * Set the route color.
23605 * @param route The route object.
23606 * @param r Red channel value, from 0 to 255.
23607 * @param g Green channel value, from 0 to 255.
23608 * @param b Blue channel value, from 0 to 255.
23609 * @param a Alpha channel value, from 0 to 255.
23611 * It uses an additive color model, so each color channel represents
23612 * how much of each primary colors must to be used. 0 represents
23613 * ausence of this color, so if all of the three are set to 0,
23614 * the color will be black.
23616 * These component values should be integers in the range 0 to 255,
23617 * (single 8-bit byte).
23619 * This sets the color used for the route. By default, it is set to
23620 * solid red (r = 255, g = 0, b = 0, a = 255).
23622 * For alpha channel, 0 represents completely transparent, and 255, opaque.
23624 * @see elm_map_route_color_get()
23628 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23631 * Get the route color.
23633 * @param route The route object.
23634 * @param r Pointer where to store the red channel value.
23635 * @param g Pointer where to store the green channel value.
23636 * @param b Pointer where to store the blue channel value.
23637 * @param a Pointer where to store the alpha channel value.
23639 * @see elm_map_route_color_set() for details.
23643 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23646 * Get the route distance in kilometers.
23648 * @param route The route object.
23649 * @return The distance of route (unit : km).
23653 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23656 * Get the information of route nodes.
23658 * @param route The route object.
23659 * @return Returns a string with the nodes of route.
23663 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23666 * Get the information of route waypoint.
23668 * @param route the route object.
23669 * @return Returns a string with information about waypoint of route.
23673 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23676 * Get the address of the name.
23678 * @param name The name handle.
23679 * @return Returns the address string of @p name.
23681 * This gets the coordinates of the @p name, created with one of the
23682 * conversion functions.
23684 * @see elm_map_utils_convert_name_into_coord()
23685 * @see elm_map_utils_convert_coord_into_name()
23689 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23692 * Get the current coordinates of the name.
23694 * @param name The name handle.
23695 * @param lat Pointer where to store the latitude.
23696 * @param lon Pointer where to store The longitude.
23698 * This gets the coordinates of the @p name, created with one of the
23699 * conversion functions.
23701 * @see elm_map_utils_convert_name_into_coord()
23702 * @see elm_map_utils_convert_coord_into_name()
23706 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23709 * Remove a name from the map.
23711 * @param name The name to remove.
23713 * Basically the struct handled by @p name will be freed, so convertions
23714 * between address and coordinates will be lost.
23716 * @see elm_map_utils_convert_name_into_coord()
23717 * @see elm_map_utils_convert_coord_into_name()
23721 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23726 * @param obj The map object.
23727 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23728 * @param cx Rotation's center horizontal position.
23729 * @param cy Rotation's center vertical position.
23731 * @see elm_map_rotate_get()
23735 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23738 * Get the rotate degree of the map
23740 * @param obj The map object
23741 * @param degree Pointer where to store degrees from 0.0 to 360.0
23742 * to rotate arount Z axis.
23743 * @param cx Pointer where to store rotation's center horizontal position.
23744 * @param cy Pointer where to store rotation's center vertical position.
23746 * @see elm_map_rotate_set() to set map rotation.
23750 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);
23753 * Enable or disable mouse wheel to be used to zoom in / out the map.
23755 * @param obj The map object.
23756 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23759 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23761 * It's disabled by default.
23763 * @see elm_map_wheel_disabled_get()
23767 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23770 * Get a value whether mouse wheel is enabled or not.
23772 * @param obj The map object.
23773 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23774 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23776 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23778 * @see elm_map_wheel_disabled_set() for details.
23782 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23786 * Add a track on the map
23788 * @param obj The map object.
23789 * @param emap The emap route object.
23790 * @return The route object. This is an elm object of type Route.
23792 * @see elm_route_add() for details.
23796 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23800 * Remove a track from the map
23802 * @param obj The map object.
23803 * @param route The track to remove.
23807 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23814 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23816 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23818 EAPI double elm_route_lon_min_get(Evas_Object *obj);
23819 EAPI double elm_route_lat_min_get(Evas_Object *obj);
23820 EAPI double elm_route_lon_max_get(Evas_Object *obj);
23821 EAPI double elm_route_lat_max_get(Evas_Object *obj);
23825 * @defgroup Panel Panel
23827 * @image html img/widget/panel/preview-00.png
23828 * @image latex img/widget/panel/preview-00.eps
23830 * @brief A panel is a type of animated container that contains subobjects.
23831 * It can be expanded or contracted by clicking the button on it's edge.
23833 * Orientations are as follows:
23834 * @li ELM_PANEL_ORIENT_TOP
23835 * @li ELM_PANEL_ORIENT_LEFT
23836 * @li ELM_PANEL_ORIENT_RIGHT
23838 * Default contents parts of the panel widget that you can use for are:
23839 * @li "default" - A content of the panel
23841 * @ref tutorial_panel shows one way to use this widget.
23844 typedef enum _Elm_Panel_Orient
23846 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23847 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23848 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23849 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23850 } Elm_Panel_Orient;
23852 * @brief Adds a panel object
23854 * @param parent The parent object
23856 * @return The panel object, or NULL on failure
23858 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23860 * @brief Sets the orientation of the panel
23862 * @param parent The parent object
23863 * @param orient The panel orientation. Can be one of the following:
23864 * @li ELM_PANEL_ORIENT_TOP
23865 * @li ELM_PANEL_ORIENT_LEFT
23866 * @li ELM_PANEL_ORIENT_RIGHT
23868 * Sets from where the panel will (dis)appear.
23870 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
23872 * @brief Get the orientation of the panel.
23874 * @param obj The panel object
23875 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
23877 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23879 * @brief Set the content of the panel.
23881 * @param obj The panel object
23882 * @param content The panel content
23884 * Once the content object is set, a previously set one will be deleted.
23885 * If you want to keep that old content object, use the
23886 * elm_panel_content_unset() function.
23888 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23890 * @brief Get the content of the panel.
23892 * @param obj The panel object
23893 * @return The content that is being used
23895 * Return the content object which is set for this widget.
23897 * @see elm_panel_content_set()
23899 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23901 * @brief Unset the content of the panel.
23903 * @param obj The panel object
23904 * @return The content that was being used
23906 * Unparent and return the content object which was set for this widget.
23908 * @see elm_panel_content_set()
23910 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23912 * @brief Set the state of the panel.
23914 * @param obj The panel object
23915 * @param hidden If true, the panel will run the animation to contract
23917 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
23919 * @brief Get the state of the panel.
23921 * @param obj The panel object
23922 * @param hidden If true, the panel is in the "hide" state
23924 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23926 * @brief Toggle the hidden state of the panel from code
23928 * @param obj The panel object
23930 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
23936 * @defgroup Panes Panes
23937 * @ingroup Elementary
23939 * @image html img/widget/panes/preview-00.png
23940 * @image latex img/widget/panes/preview-00.eps width=\textwidth
23942 * @image html img/panes.png
23943 * @image latex img/panes.eps width=\textwidth
23945 * The panes adds a dragable bar between two contents. When dragged
23946 * this bar will resize contents size.
23948 * Panes can be displayed vertically or horizontally, and contents
23949 * size proportion can be customized (homogeneous by default).
23951 * Smart callbacks one can listen to:
23952 * - "press" - The panes has been pressed (button wasn't released yet).
23953 * - "unpressed" - The panes was released after being pressed.
23954 * - "clicked" - The panes has been clicked>
23955 * - "clicked,double" - The panes has been double clicked
23957 * Available styles for it:
23960 * Default contents parts of the panes widget that you can use for are:
23961 * @li "left" - A leftside content of the panes
23962 * @li "right" - A rightside content of the panes
23964 * If panes is displayed vertically, left content will be displayed at
23967 * Here is an example on its usage:
23968 * @li @ref panes_example
23972 * @addtogroup Panes
23977 * Add a new panes widget to the given parent Elementary
23978 * (container) object.
23980 * @param parent The parent object.
23981 * @return a new panes widget handle or @c NULL, on errors.
23983 * This function inserts a new panes widget on the canvas.
23987 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23990 * Set the left content of the panes widget.
23992 * @param obj The panes object.
23993 * @param content The new left content object.
23995 * Once the content object is set, a previously set one will be deleted.
23996 * If you want to keep that old content object, use the
23997 * elm_panes_content_left_unset() function.
23999 * If panes is displayed vertically, left content will be displayed at
24002 * @see elm_panes_content_left_get()
24003 * @see elm_panes_content_right_set() to set content on the other side.
24005 * @deprecated use elm_object_part_content_set() instead
24009 EINA_DEPRECATED EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24012 * Set the right content of the panes widget.
24014 * @param obj The panes object.
24015 * @param content The new right content object.
24017 * Once the content object is set, a previously set one will be deleted.
24018 * If you want to keep that old content object, use the
24019 * elm_panes_content_right_unset() function.
24021 * If panes is displayed vertically, left content will be displayed at
24024 * @see elm_panes_content_right_get()
24025 * @see elm_panes_content_left_set() to set content on the other side.
24027 * @deprecated use elm_object_part_content_set() instead
24031 EINA_DEPRECATED EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24034 * Get the left content of the panes.
24036 * @param obj The panes object.
24037 * @return The left content object that is being used.
24039 * Return the left content object which is set for this widget.
24041 * @see elm_panes_content_left_set() for details.
24043 * @deprecated use elm_object_part_content_get() instead
24047 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24050 * Get the right content of the panes.
24052 * @param obj The panes object
24053 * @return The right content object that is being used
24055 * Return the right content object which is set for this widget.
24057 * @see elm_panes_content_right_set() for details.
24059 * @deprecated use elm_object_part_content_get() instead
24063 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24066 * Unset the left content used for the panes.
24068 * @param obj The panes object.
24069 * @return The left content object that was being used.
24071 * Unparent and return the left content object which was set for this widget.
24073 * @see elm_panes_content_left_set() for details.
24074 * @see elm_panes_content_left_get().
24076 * @deprecated use elm_object_part_content_unset() instead
24080 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24083 * Unset the right content used for the panes.
24085 * @param obj The panes object.
24086 * @return The right content object that was being used.
24088 * Unparent and return the right content object which was set for this
24091 * @see elm_panes_content_right_set() for details.
24092 * @see elm_panes_content_right_get().
24094 * @deprecated use elm_object_part_content_unset() instead
24098 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24101 * Get the size proportion of panes widget's left side.
24103 * @param obj The panes object.
24104 * @return float value between 0.0 and 1.0 representing size proportion
24107 * @see elm_panes_content_left_size_set() for more details.
24111 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24114 * Set the size proportion of panes widget's left side.
24116 * @param obj The panes object.
24117 * @param size Value between 0.0 and 1.0 representing size proportion
24120 * By default it's homogeneous, i.e., both sides have the same size.
24122 * If something different is required, it can be set with this function.
24123 * For example, if the left content should be displayed over
24124 * 75% of the panes size, @p size should be passed as @c 0.75.
24125 * This way, right content will be resized to 25% of panes size.
24127 * If displayed vertically, left content is displayed at top, and
24128 * right content at bottom.
24130 * @note This proportion will change when user drags the panes bar.
24132 * @see elm_panes_content_left_size_get()
24136 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24139 * Set the orientation of a given panes widget.
24141 * @param obj The panes object.
24142 * @param horizontal Use @c EINA_TRUE to make @p obj to be
24143 * @b horizontal, @c EINA_FALSE to make it @b vertical.
24145 * Use this function to change how your panes is to be
24146 * disposed: vertically or horizontally.
24148 * By default it's displayed horizontally.
24150 * @see elm_panes_horizontal_get()
24154 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24157 * Retrieve the orientation of a given panes widget.
24159 * @param obj The panes object.
24160 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24161 * @c EINA_FALSE if it's @b vertical (and on errors).
24163 * @see elm_panes_horizontal_set() for more details.
24167 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24168 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24169 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24176 * @defgroup Flip Flip
24178 * @image html img/widget/flip/preview-00.png
24179 * @image latex img/widget/flip/preview-00.eps
24181 * This widget holds 2 content objects(Evas_Object): one on the front and one
24182 * on the back. It allows you to flip from front to back and vice-versa using
24183 * various animations.
24185 * If either the front or back contents are not set the flip will treat that
24186 * as transparent. So if you wore to set the front content but not the back,
24187 * and then call elm_flip_go() you would see whatever is below the flip.
24189 * For a list of supported animations see elm_flip_go().
24191 * Signals that you can add callbacks for are:
24192 * "animate,begin" - when a flip animation was started
24193 * "animate,done" - when a flip animation is finished
24195 * @ref tutorial_flip show how to use most of the API.
24199 typedef enum _Elm_Flip_Mode
24201 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24202 ELM_FLIP_ROTATE_X_CENTER_AXIS,
24203 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24204 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24205 ELM_FLIP_CUBE_LEFT,
24206 ELM_FLIP_CUBE_RIGHT,
24208 ELM_FLIP_CUBE_DOWN,
24209 ELM_FLIP_PAGE_LEFT,
24210 ELM_FLIP_PAGE_RIGHT,
24214 typedef enum _Elm_Flip_Interaction
24216 ELM_FLIP_INTERACTION_NONE,
24217 ELM_FLIP_INTERACTION_ROTATE,
24218 ELM_FLIP_INTERACTION_CUBE,
24219 ELM_FLIP_INTERACTION_PAGE
24220 } Elm_Flip_Interaction;
24221 typedef enum _Elm_Flip_Direction
24223 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24224 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24225 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24226 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24227 } Elm_Flip_Direction;
24229 * @brief Add a new flip to the parent
24231 * @param parent The parent object
24232 * @return The new object or NULL if it cannot be created
24234 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24236 * @brief Set the front content of the flip widget.
24238 * @param obj The flip object
24239 * @param content The new front content object
24241 * Once the content object is set, a previously set one will be deleted.
24242 * If you want to keep that old content object, use the
24243 * elm_flip_content_front_unset() function.
24245 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24247 * @brief Set the back content of the flip widget.
24249 * @param obj The flip object
24250 * @param content The new back content object
24252 * Once the content object is set, a previously set one will be deleted.
24253 * If you want to keep that old content object, use the
24254 * elm_flip_content_back_unset() function.
24256 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24258 * @brief Get the front content used for the flip
24260 * @param obj The flip object
24261 * @return The front content object that is being used
24263 * Return the front content object which is set for this widget.
24265 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24267 * @brief Get the back content used for the flip
24269 * @param obj The flip object
24270 * @return The back content object that is being used
24272 * Return the back content object which is set for this widget.
24274 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24276 * @brief Unset the front content used for the flip
24278 * @param obj The flip object
24279 * @return The front content object that was being used
24281 * Unparent and return the front content object which was set for this widget.
24283 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24285 * @brief Unset the back content used for the flip
24287 * @param obj The flip object
24288 * @return The back content object that was being used
24290 * Unparent and return the back content object which was set for this widget.
24292 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24294 * @brief Get flip front visibility state
24296 * @param obj The flip objct
24297 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24300 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24302 * @brief Set flip perspective
24304 * @param obj The flip object
24305 * @param foc The coordinate to set the focus on
24306 * @param x The X coordinate
24307 * @param y The Y coordinate
24309 * @warning This function currently does nothing.
24311 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24313 * @brief Runs the flip animation
24315 * @param obj The flip object
24316 * @param mode The mode type
24318 * Flips the front and back contents using the @p mode animation. This
24319 * efectively hides the currently visible content and shows the hidden one.
24321 * There a number of possible animations to use for the flipping:
24322 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24323 * around a horizontal axis in the middle of its height, the other content
24324 * is shown as the other side of the flip.
24325 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24326 * around a vertical axis in the middle of its width, the other content is
24327 * shown as the other side of the flip.
24328 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24329 * around a diagonal axis in the middle of its width, the other content is
24330 * shown as the other side of the flip.
24331 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24332 * around a diagonal axis in the middle of its height, the other content is
24333 * shown as the other side of the flip.
24334 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24335 * as if the flip was a cube, the other content is show as the right face of
24337 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24338 * right as if the flip was a cube, the other content is show as the left
24339 * face of the cube.
24340 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24341 * flip was a cube, the other content is show as the bottom face of the cube.
24342 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24343 * the flip was a cube, the other content is show as the upper face of the
24345 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24346 * if the flip was a book, the other content is shown as the page below that.
24347 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24348 * as if the flip was a book, the other content is shown as the page below
24350 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24351 * flip was a book, the other content is shown as the page below that.
24352 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24353 * flip was a book, the other content is shown as the page below that.
24355 * @image html elm_flip.png
24356 * @image latex elm_flip.eps width=\textwidth
24358 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24360 * @brief Set the interactive flip mode
24362 * @param obj The flip object
24363 * @param mode The interactive flip mode to use
24365 * This sets if the flip should be interactive (allow user to click and
24366 * drag a side of the flip to reveal the back page and cause it to flip).
24367 * By default a flip is not interactive. You may also need to set which
24368 * sides of the flip are "active" for flipping and how much space they use
24369 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24370 * and elm_flip_interacton_direction_hitsize_set()
24372 * The four avilable mode of interaction are:
24373 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24374 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24375 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24376 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24378 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24379 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24380 * happen, those can only be acheived with elm_flip_go();
24382 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24384 * @brief Get the interactive flip mode
24386 * @param obj The flip object
24387 * @return The interactive flip mode
24389 * Returns the interactive flip mode set by elm_flip_interaction_set()
24391 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24393 * @brief Set which directions of the flip respond to interactive flip
24395 * @param obj The flip object
24396 * @param dir The direction to change
24397 * @param enabled If that direction is enabled or not
24399 * By default all directions are disabled, so you may want to enable the
24400 * desired directions for flipping if you need interactive flipping. You must
24401 * call this function once for each direction that should be enabled.
24403 * @see elm_flip_interaction_set()
24405 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24407 * @brief Get the enabled state of that flip direction
24409 * @param obj The flip object
24410 * @param dir The direction to check
24411 * @return If that direction is enabled or not
24413 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24415 * @see elm_flip_interaction_set()
24417 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24419 * @brief Set the amount of the flip that is sensitive to interactive flip
24421 * @param obj The flip object
24422 * @param dir The direction to modify
24423 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24425 * Set the amount of the flip that is sensitive to interactive flip, with 0
24426 * representing no area in the flip and 1 representing the entire flip. There
24427 * is however a consideration to be made in that the area will never be
24428 * smaller than the finger size set(as set in your Elementary configuration).
24430 * @see elm_flip_interaction_set()
24432 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24434 * @brief Get the amount of the flip that is sensitive to interactive flip
24436 * @param obj The flip object
24437 * @param dir The direction to check
24438 * @return The size set for that direction
24440 * Returns the amount os sensitive area set by
24441 * elm_flip_interacton_direction_hitsize_set().
24443 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24448 /* scrolledentry */
24449 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24450 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24451 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24452 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24453 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24454 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24455 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24456 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24457 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24458 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24459 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24460 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24461 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24462 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24463 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24464 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24465 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24466 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24467 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24468 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24469 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24470 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24471 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24472 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24473 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24474 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24475 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24476 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24477 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24478 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24479 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24480 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24481 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24482 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24483 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24484 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);
24485 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24486 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24487 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);
24488 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24489 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);
24490 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24491 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24492 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24493 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24494 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24495 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24496 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24497 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24498 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);
24499 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);
24500 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);
24501 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);
24502 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);
24503 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);
24504 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24505 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24506 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24507 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24508 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24509 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24510 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24511 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
24512 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
24513 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
24514 EINA_DEPRECATED EAPI Ecore_IMF_Context *elm_scrolled_entry_imf_context_get(Evas_Object *obj);
24515 EINA_DEPRECATED EAPI void elm_scrolled_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
24516 EINA_DEPRECATED EAPI void elm_scrolled_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
24519 * @defgroup Conformant Conformant
24520 * @ingroup Elementary
24522 * @image html img/widget/conformant/preview-00.png
24523 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24525 * @image html img/conformant.png
24526 * @image latex img/conformant.eps width=\textwidth
24528 * The aim is to provide a widget that can be used in elementary apps to
24529 * account for space taken up by the indicator, virtual keypad & softkey
24530 * windows when running the illume2 module of E17.
24532 * So conformant content will be sized and positioned considering the
24533 * space required for such stuff, and when they popup, as a keyboard
24534 * shows when an entry is selected, conformant content won't change.
24536 * Available styles for it:
24539 * Default contents parts of the conformant widget that you can use for are:
24540 * @li "default" - A content of the conformant
24542 * See how to use this widget in this example:
24543 * @ref conformant_example
24547 * @addtogroup Conformant
24552 * Add a new conformant widget to the given parent Elementary
24553 * (container) object.
24555 * @param parent The parent object.
24556 * @return A new conformant widget handle or @c NULL, on errors.
24558 * This function inserts a new conformant widget on the canvas.
24560 * @ingroup Conformant
24562 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24565 * Set the content of the conformant widget.
24567 * @param obj The conformant object.
24568 * @param content The content to be displayed by the conformant.
24570 * Content will be sized and positioned considering the space required
24571 * to display a virtual keyboard. So it won't fill all the conformant
24572 * size. This way is possible to be sure that content won't resize
24573 * or be re-positioned after the keyboard is displayed.
24575 * Once the content object is set, a previously set one will be deleted.
24576 * If you want to keep that old content object, use the
24577 * elm_object_content_unset() function.
24579 * @see elm_object_content_unset()
24580 * @see elm_object_content_get()
24582 * @ingroup Conformant
24584 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24587 * Get the content of the conformant widget.
24589 * @param obj The conformant object.
24590 * @return The content that is being used.
24592 * Return the content object which is set for this widget.
24593 * It won't be unparent from conformant. For that, use
24594 * elm_object_content_unset().
24596 * @see elm_object_content_set().
24597 * @see elm_object_content_unset()
24599 * @ingroup Conformant
24601 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24604 * Unset the content of the conformant widget.
24606 * @param obj The conformant object.
24607 * @return The content that was being used.
24609 * Unparent and return the content object which was set for this widget.
24611 * @see elm_object_content_set().
24613 * @ingroup Conformant
24615 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24618 * Returns the Evas_Object that represents the content area.
24620 * @param obj The conformant object.
24621 * @return The content area of the widget.
24623 * @ingroup Conformant
24625 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24632 * @defgroup Mapbuf Mapbuf
24633 * @ingroup Elementary
24635 * @image html img/widget/mapbuf/preview-00.png
24636 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24638 * This holds one content object and uses an Evas Map of transformation
24639 * points to be later used with this content. So the content will be
24640 * moved, resized, etc as a single image. So it will improve performance
24641 * when you have a complex interafce, with a lot of elements, and will
24642 * need to resize or move it frequently (the content object and its
24645 * Default contents parts of the mapbuf widget that you can use for are:
24646 * @li "default" - A content of the mapbuf
24648 * To enable map, elm_mapbuf_enabled_set() should be used.
24650 * See how to use this widget in this example:
24651 * @ref mapbuf_example
24655 * @addtogroup Mapbuf
24660 * Add a new mapbuf widget to the given parent Elementary
24661 * (container) object.
24663 * @param parent The parent object.
24664 * @return A new mapbuf widget handle or @c NULL, on errors.
24666 * This function inserts a new mapbuf widget on the canvas.
24670 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24673 * Set the content of the mapbuf.
24675 * @param obj The mapbuf object.
24676 * @param content The content that will be filled in this mapbuf object.
24678 * Once the content object is set, a previously set one will be deleted.
24679 * If you want to keep that old content object, use the
24680 * elm_mapbuf_content_unset() function.
24682 * To enable map, elm_mapbuf_enabled_set() should be used.
24686 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24689 * Get the content of the mapbuf.
24691 * @param obj The mapbuf object.
24692 * @return The content that is being used.
24694 * Return the content object which is set for this widget.
24696 * @see elm_mapbuf_content_set() for details.
24700 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24703 * Unset the content of the mapbuf.
24705 * @param obj The mapbuf object.
24706 * @return The content that was being used.
24708 * Unparent and return the content object which was set for this widget.
24710 * @see elm_mapbuf_content_set() for details.
24714 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24717 * Enable or disable the map.
24719 * @param obj The mapbuf object.
24720 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24722 * This enables the map that is set or disables it. On enable, the object
24723 * geometry will be saved, and the new geometry will change (position and
24724 * size) to reflect the map geometry set.
24726 * Also, when enabled, alpha and smooth states will be used, so if the
24727 * content isn't solid, alpha should be enabled, for example, otherwise
24728 * a black retangle will fill the content.
24730 * When disabled, the stored map will be freed and geometry prior to
24731 * enabling the map will be restored.
24733 * It's disabled by default.
24735 * @see elm_mapbuf_alpha_set()
24736 * @see elm_mapbuf_smooth_set()
24740 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24743 * Get a value whether map is enabled or not.
24745 * @param obj The mapbuf object.
24746 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24747 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24749 * @see elm_mapbuf_enabled_set() for details.
24753 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24756 * Enable or disable smooth map rendering.
24758 * @param obj The mapbuf object.
24759 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24762 * This sets smoothing for map rendering. If the object is a type that has
24763 * its own smoothing settings, then both the smooth settings for this object
24764 * and the map must be turned off.
24766 * By default smooth maps are enabled.
24770 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24773 * Get a value whether smooth map rendering is enabled or not.
24775 * @param obj The mapbuf object.
24776 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24777 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24779 * @see elm_mapbuf_smooth_set() for details.
24783 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24786 * Set or unset alpha flag for map rendering.
24788 * @param obj The mapbuf object.
24789 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24792 * This sets alpha flag for map rendering. If the object is a type that has
24793 * its own alpha settings, then this will take precedence. Only image objects
24794 * have this currently. It stops alpha blending of the map area, and is
24795 * useful if you know the object and/or all sub-objects is 100% solid.
24797 * Alpha is enabled by default.
24801 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24804 * Get a value whether alpha blending is enabled or not.
24806 * @param obj The mapbuf object.
24807 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24808 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24810 * @see elm_mapbuf_alpha_set() for details.
24814 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24821 * @defgroup Flipselector Flip Selector
24823 * @image html img/widget/flipselector/preview-00.png
24824 * @image latex img/widget/flipselector/preview-00.eps
24826 * A flip selector is a widget to show a set of @b text items, one
24827 * at a time, with the same sheet switching style as the @ref Clock
24828 * "clock" widget, when one changes the current displaying sheet
24829 * (thus, the "flip" in the name).
24831 * User clicks to flip sheets which are @b held for some time will
24832 * make the flip selector to flip continuosly and automatically for
24833 * the user. The interval between flips will keep growing in time,
24834 * so that it helps the user to reach an item which is distant from
24835 * the current selection.
24837 * Smart callbacks one can register to:
24838 * - @c "selected" - when the widget's selected text item is changed
24839 * - @c "overflowed" - when the widget's current selection is changed
24840 * from the first item in its list to the last
24841 * - @c "underflowed" - when the widget's current selection is changed
24842 * from the last item in its list to the first
24844 * Available styles for it:
24847 * To set/get the label of the flipselector item, you can use
24848 * elm_object_item_text_set/get APIs.
24849 * Once the text is set, a previously set one will be deleted.
24851 * Here is an example on its usage:
24852 * @li @ref flipselector_example
24856 * @addtogroup Flipselector
24860 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
24863 * Add a new flip selector widget to the given parent Elementary
24864 * (container) widget
24866 * @param parent The parent object
24867 * @return a new flip selector widget handle or @c NULL, on errors
24869 * This function inserts a new flip selector widget on the canvas.
24871 * @ingroup Flipselector
24873 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24876 * Programmatically select the next item of a flip selector widget
24878 * @param obj The flipselector object
24880 * @note The selection will be animated. Also, if it reaches the
24881 * end of its list of member items, it will continue with the first
24884 * @ingroup Flipselector
24886 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24889 * Programmatically select the previous item of a flip selector
24892 * @param obj The flipselector object
24894 * @note The selection will be animated. Also, if it reaches the
24895 * beginning of its list of member items, it will continue with the
24896 * last one backwards.
24898 * @ingroup Flipselector
24900 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24903 * Append a (text) item to a flip selector widget
24905 * @param obj The flipselector object
24906 * @param label The (text) label of the new item
24907 * @param func Convenience callback function to take place when
24909 * @param data Data passed to @p func, above
24910 * @return A handle to the item added or @c NULL, on errors
24912 * The widget's list of labels to show will be appended with the
24913 * given value. If the user wishes so, a callback function pointer
24914 * can be passed, which will get called when this same item is
24917 * @note The current selection @b won't be modified by appending an
24918 * element to the list.
24920 * @note The maximum length of the text label is going to be
24921 * determined <b>by the widget's theme</b>. Strings larger than
24922 * that value are going to be @b truncated.
24924 * @ingroup Flipselector
24926 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24929 * Prepend a (text) item to a flip selector widget
24931 * @param obj The flipselector object
24932 * @param label The (text) label of the new item
24933 * @param func Convenience callback function to take place when
24935 * @param data Data passed to @p func, above
24936 * @return A handle to the item added or @c NULL, on errors
24938 * The widget's list of labels to show will be prepended with the
24939 * given value. If the user wishes so, a callback function pointer
24940 * can be passed, which will get called when this same item is
24943 * @note The current selection @b won't be modified by prepending
24944 * an element to the list.
24946 * @note The maximum length of the text label is going to be
24947 * determined <b>by the widget's theme</b>. Strings larger than
24948 * that value are going to be @b truncated.
24950 * @ingroup Flipselector
24952 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24955 * Get the internal list of items in a given flip selector widget.
24957 * @param obj The flipselector object
24958 * @return The list of items (#Elm_Flipselector_Item as data) or
24959 * @c NULL on errors.
24961 * This list is @b not to be modified in any way and must not be
24962 * freed. Use the list members with functions like
24963 * elm_flipselector_item_label_set(),
24964 * elm_flipselector_item_label_get(),
24965 * elm_flipselector_item_del(),
24966 * elm_flipselector_item_selected_get(),
24967 * elm_flipselector_item_selected_set().
24969 * @warning This list is only valid until @p obj object's internal
24970 * items list is changed. It should be fetched again with another
24971 * call to this function when changes happen.
24973 * @ingroup Flipselector
24975 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24978 * Get the first item in the given flip selector widget's list of
24981 * @param obj The flipselector object
24982 * @return The first item or @c NULL, if it has no items (and on
24985 * @see elm_flipselector_item_append()
24986 * @see elm_flipselector_last_item_get()
24988 * @ingroup Flipselector
24990 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24993 * Get the last item in the given flip selector widget's list of
24996 * @param obj The flipselector object
24997 * @return The last item or @c NULL, if it has no items (and on
25000 * @see elm_flipselector_item_prepend()
25001 * @see elm_flipselector_first_item_get()
25003 * @ingroup Flipselector
25005 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25008 * Get the currently selected item in a flip selector widget.
25010 * @param obj The flipselector object
25011 * @return The selected item or @c NULL, if the widget has no items
25014 * @ingroup Flipselector
25016 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25019 * Set whether a given flip selector widget's item should be the
25020 * currently selected one.
25022 * @param item The flip selector item
25023 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
25025 * This sets whether @p item is or not the selected (thus, under
25026 * display) one. If @p item is different than one under display,
25027 * the latter will be unselected. If the @p item is set to be
25028 * unselected, on the other hand, the @b first item in the widget's
25029 * internal members list will be the new selected one.
25031 * @see elm_flipselector_item_selected_get()
25033 * @ingroup Flipselector
25035 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
25038 * Get whether a given flip selector widget's item is the currently
25041 * @param item The flip selector item
25042 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
25045 * @see elm_flipselector_item_selected_set()
25047 * @ingroup Flipselector
25049 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25052 * Delete a given item from a flip selector widget.
25054 * @param item The item to delete
25056 * @ingroup Flipselector
25058 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25061 * Get the label of a given flip selector widget's item.
25063 * @param item The item to get label from
25064 * @return The text label of @p item or @c NULL, on errors
25066 * @see elm_flipselector_item_label_set()
25068 * @ingroup Flipselector
25070 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25073 * Set the label of a given flip selector widget's item.
25075 * @param item The item to set label on
25076 * @param label The text label string, in UTF-8 encoding
25078 * @see elm_flipselector_item_label_get()
25080 * @ingroup Flipselector
25082 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
25085 * Gets the item before @p item in a flip selector widget's
25086 * internal list of items.
25088 * @param item The item to fetch previous from
25089 * @return The item before the @p item, in its parent's list. If
25090 * there is no previous item for @p item or there's an
25091 * error, @c NULL is returned.
25093 * @see elm_flipselector_item_next_get()
25095 * @ingroup Flipselector
25097 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25100 * Gets the item after @p item in a flip selector widget's
25101 * internal list of items.
25103 * @param item The item to fetch next from
25104 * @return The item after the @p item, in its parent's list. If
25105 * there is no next item for @p item or there's an
25106 * error, @c NULL is returned.
25108 * @see elm_flipselector_item_next_get()
25110 * @ingroup Flipselector
25112 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25115 * Set the interval on time updates for an user mouse button hold
25116 * on a flip selector widget.
25118 * @param obj The flip selector object
25119 * @param interval The (first) interval value in seconds
25121 * This interval value is @b decreased while the user holds the
25122 * mouse pointer either flipping up or flipping doww a given flip
25125 * This helps the user to get to a given item distant from the
25126 * current one easier/faster, as it will start to flip quicker and
25127 * quicker on mouse button holds.
25129 * The calculation for the next flip interval value, starting from
25130 * the one set with this call, is the previous interval divided by
25131 * 1.05, so it decreases a little bit.
25133 * The default starting interval value for automatic flips is
25136 * @see elm_flipselector_interval_get()
25138 * @ingroup Flipselector
25140 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25143 * Get the interval on time updates for an user mouse button hold
25144 * on a flip selector widget.
25146 * @param obj The flip selector object
25147 * @return The (first) interval value, in seconds, set on it
25149 * @see elm_flipselector_interval_set() for more details
25151 * @ingroup Flipselector
25153 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25159 * @addtogroup Calendar
25164 * @enum _Elm_Calendar_Mark_Repeat
25165 * @typedef Elm_Calendar_Mark_Repeat
25167 * Event periodicity, used to define if a mark should be repeated
25168 * @b beyond event's day. It's set when a mark is added.
25170 * So, for a mark added to 13th May with periodicity set to WEEKLY,
25171 * there will be marks every week after this date. Marks will be displayed
25172 * at 13th, 20th, 27th, 3rd June ...
25174 * Values don't work as bitmask, only one can be choosen.
25176 * @see elm_calendar_mark_add()
25178 * @ingroup Calendar
25180 typedef enum _Elm_Calendar_Mark_Repeat
25182 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25183 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25184 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25185 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*/
25186 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. */
25187 } Elm_Calendar_Mark_Repeat;
25189 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(). */
25192 * Add a new calendar widget to the given parent Elementary
25193 * (container) object.
25195 * @param parent The parent object.
25196 * @return a new calendar widget handle or @c NULL, on errors.
25198 * This function inserts a new calendar widget on the canvas.
25200 * @ref calendar_example_01
25202 * @ingroup Calendar
25204 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25207 * Get weekdays names displayed by the calendar.
25209 * @param obj The calendar object.
25210 * @return Array of seven strings to be used as weekday names.
25212 * By default, weekdays abbreviations get from system are displayed:
25213 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25214 * The first string is related to Sunday, the second to Monday...
25216 * @see elm_calendar_weekdays_name_set()
25218 * @ref calendar_example_05
25220 * @ingroup Calendar
25222 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25225 * Set weekdays names to be displayed by the calendar.
25227 * @param obj The calendar object.
25228 * @param weekdays Array of seven strings to be used as weekday names.
25229 * @warning It must have 7 elements, or it will access invalid memory.
25230 * @warning The strings must be NULL terminated ('@\0').
25232 * By default, weekdays abbreviations get from system are displayed:
25233 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25235 * The first string should be related to Sunday, the second to Monday...
25237 * The usage should be like this:
25239 * const char *weekdays[] =
25241 * "Sunday", "Monday", "Tuesday", "Wednesday",
25242 * "Thursday", "Friday", "Saturday"
25244 * elm_calendar_weekdays_names_set(calendar, weekdays);
25247 * @see elm_calendar_weekdays_name_get()
25249 * @ref calendar_example_02
25251 * @ingroup Calendar
25253 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25256 * Set the minimum and maximum values for the year
25258 * @param obj The calendar object
25259 * @param min The minimum year, greater than 1901;
25260 * @param max The maximum year;
25262 * Maximum must be greater than minimum, except if you don't wan't to set
25264 * Default values are 1902 and -1.
25266 * If the maximum year is a negative value, it will be limited depending
25267 * on the platform architecture (year 2037 for 32 bits);
25269 * @see elm_calendar_min_max_year_get()
25271 * @ref calendar_example_03
25273 * @ingroup Calendar
25275 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25278 * Get the minimum and maximum values for the year
25280 * @param obj The calendar object.
25281 * @param min The minimum year.
25282 * @param max The maximum year.
25284 * Default values are 1902 and -1.
25286 * @see elm_calendar_min_max_year_get() for more details.
25288 * @ref calendar_example_05
25290 * @ingroup Calendar
25292 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25295 * Enable or disable day selection
25297 * @param obj The calendar object.
25298 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25301 * Enabled by default. If disabled, the user still can select months,
25302 * but not days. Selected days are highlighted on calendar.
25303 * It should be used if you won't need such selection for the widget usage.
25305 * When a day is selected, or month is changed, smart callbacks for
25306 * signal "changed" will be called.
25308 * @see elm_calendar_day_selection_enable_get()
25310 * @ref calendar_example_04
25312 * @ingroup Calendar
25314 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25317 * Get a value whether day selection is enabled or not.
25319 * @see elm_calendar_day_selection_enable_set() for details.
25321 * @param obj The calendar object.
25322 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25323 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25325 * @ref calendar_example_05
25327 * @ingroup Calendar
25329 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25333 * Set selected date to be highlighted on calendar.
25335 * @param obj The calendar object.
25336 * @param selected_time A @b tm struct to represent the selected date.
25338 * Set the selected date, changing the displayed month if needed.
25339 * Selected date changes when the user goes to next/previous month or
25340 * select a day pressing over it on calendar.
25342 * @see elm_calendar_selected_time_get()
25344 * @ref calendar_example_04
25346 * @ingroup Calendar
25348 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25351 * Get selected date.
25353 * @param obj The calendar object
25354 * @param selected_time A @b tm struct to point to selected date
25355 * @return EINA_FALSE means an error ocurred and returned time shouldn't
25358 * Get date selected by the user or set by function
25359 * elm_calendar_selected_time_set().
25360 * Selected date changes when the user goes to next/previous month or
25361 * select a day pressing over it on calendar.
25363 * @see elm_calendar_selected_time_get()
25365 * @ref calendar_example_05
25367 * @ingroup Calendar
25369 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25372 * Set a function to format the string that will be used to display
25375 * @param obj The calendar object
25376 * @param format_function Function to set the month-year string given
25377 * the selected date
25379 * By default it uses strftime with "%B %Y" format string.
25380 * It should allocate the memory that will be used by the string,
25381 * that will be freed by the widget after usage.
25382 * A pointer to the string and a pointer to the time struct will be provided.
25387 * _format_month_year(struct tm *selected_time)
25390 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25391 * return strdup(buf);
25394 * elm_calendar_format_function_set(calendar, _format_month_year);
25397 * @ref calendar_example_02
25399 * @ingroup Calendar
25401 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25404 * Add a new mark to the calendar
25406 * @param obj The calendar object
25407 * @param mark_type A string used to define the type of mark. It will be
25408 * emitted to the theme, that should display a related modification on these
25409 * days representation.
25410 * @param mark_time A time struct to represent the date of inclusion of the
25411 * mark. For marks that repeats it will just be displayed after the inclusion
25412 * date in the calendar.
25413 * @param repeat Repeat the event following this periodicity. Can be a unique
25414 * mark (that don't repeat), daily, weekly, monthly or annually.
25415 * @return The created mark or @p NULL upon failure.
25417 * Add a mark that will be drawn in the calendar respecting the insertion
25418 * time and periodicity. It will emit the type as signal to the widget theme.
25419 * Default theme supports "holiday" and "checked", but it can be extended.
25421 * It won't immediately update the calendar, drawing the marks.
25422 * For this, call elm_calendar_marks_draw(). However, when user selects
25423 * next or previous month calendar forces marks drawn.
25425 * Marks created with this method can be deleted with
25426 * elm_calendar_mark_del().
25430 * struct tm selected_time;
25431 * time_t current_time;
25433 * current_time = time(NULL) + 5 * 84600;
25434 * localtime_r(¤t_time, &selected_time);
25435 * elm_calendar_mark_add(cal, "holiday", selected_time,
25436 * ELM_CALENDAR_ANNUALLY);
25438 * current_time = time(NULL) + 1 * 84600;
25439 * localtime_r(¤t_time, &selected_time);
25440 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25442 * elm_calendar_marks_draw(cal);
25445 * @see elm_calendar_marks_draw()
25446 * @see elm_calendar_mark_del()
25448 * @ref calendar_example_06
25450 * @ingroup Calendar
25452 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);
25455 * Delete mark from the calendar.
25457 * @param mark The mark to be deleted.
25459 * If deleting all calendar marks is required, elm_calendar_marks_clear()
25460 * should be used instead of getting marks list and deleting each one.
25462 * @see elm_calendar_mark_add()
25464 * @ref calendar_example_06
25466 * @ingroup Calendar
25468 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25471 * Remove all calendar's marks
25473 * @param obj The calendar object.
25475 * @see elm_calendar_mark_add()
25476 * @see elm_calendar_mark_del()
25478 * @ingroup Calendar
25480 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25484 * Get a list of all the calendar marks.
25486 * @param obj The calendar object.
25487 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25489 * @see elm_calendar_mark_add()
25490 * @see elm_calendar_mark_del()
25491 * @see elm_calendar_marks_clear()
25493 * @ingroup Calendar
25495 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25498 * Draw calendar marks.
25500 * @param obj The calendar object.
25502 * Should be used after adding, removing or clearing marks.
25503 * It will go through the entire marks list updating the calendar.
25504 * If lots of marks will be added, add all the marks and then call
25507 * When the month is changed, i.e. user selects next or previous month,
25508 * marks will be drawed.
25510 * @see elm_calendar_mark_add()
25511 * @see elm_calendar_mark_del()
25512 * @see elm_calendar_marks_clear()
25514 * @ref calendar_example_06
25516 * @ingroup Calendar
25518 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25521 * Set a day text color to the same that represents Saturdays.
25523 * @param obj The calendar object.
25524 * @param pos The text position. Position is the cell counter, from left
25525 * to right, up to down. It starts on 0 and ends on 41.
25527 * @deprecated use elm_calendar_mark_add() instead like:
25530 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25531 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25534 * @see elm_calendar_mark_add()
25536 * @ingroup Calendar
25538 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25541 * Set a day text color to the same that represents Sundays.
25543 * @param obj The calendar object.
25544 * @param pos The text position. Position is the cell counter, from left
25545 * to right, up to down. It starts on 0 and ends on 41.
25547 * @deprecated use elm_calendar_mark_add() instead like:
25550 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25551 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25554 * @see elm_calendar_mark_add()
25556 * @ingroup Calendar
25558 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25561 * Set a day text color to the same that represents Weekdays.
25563 * @param obj The calendar object
25564 * @param pos The text position. Position is the cell counter, from left
25565 * to right, up to down. It starts on 0 and ends on 41.
25567 * @deprecated use elm_calendar_mark_add() instead like:
25570 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25572 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25573 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25574 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25575 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25576 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25577 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25578 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25579 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25580 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25583 * @see elm_calendar_mark_add()
25585 * @ingroup Calendar
25587 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25590 * Set the interval on time updates for an user mouse button hold
25591 * on calendar widgets' month selection.
25593 * @param obj The calendar object
25594 * @param interval The (first) interval value in seconds
25596 * This interval value is @b decreased while the user holds the
25597 * mouse pointer either selecting next or previous month.
25599 * This helps the user to get to a given month distant from the
25600 * current one easier/faster, as it will start to change quicker and
25601 * quicker on mouse button holds.
25603 * The calculation for the next change interval value, starting from
25604 * the one set with this call, is the previous interval divided by
25605 * 1.05, so it decreases a little bit.
25607 * The default starting interval value for automatic changes is
25610 * @see elm_calendar_interval_get()
25612 * @ingroup Calendar
25614 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25617 * Get the interval on time updates for an user mouse button hold
25618 * on calendar widgets' month selection.
25620 * @param obj The calendar object
25621 * @return The (first) interval value, in seconds, set on it
25623 * @see elm_calendar_interval_set() for more details
25625 * @ingroup Calendar
25627 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25634 * @defgroup Diskselector Diskselector
25635 * @ingroup Elementary
25637 * @image html img/widget/diskselector/preview-00.png
25638 * @image latex img/widget/diskselector/preview-00.eps
25640 * A diskselector is a kind of list widget. It scrolls horizontally,
25641 * and can contain label and icon objects. Three items are displayed
25642 * with the selected one in the middle.
25644 * It can act like a circular list with round mode and labels can be
25645 * reduced for a defined length for side items.
25647 * Smart callbacks one can listen to:
25648 * - "selected" - when item is selected, i.e. scroller stops.
25650 * Available styles for it:
25653 * List of examples:
25654 * @li @ref diskselector_example_01
25655 * @li @ref diskselector_example_02
25659 * @addtogroup Diskselector
25663 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(). */
25666 * Add a new diskselector widget to the given parent Elementary
25667 * (container) object.
25669 * @param parent The parent object.
25670 * @return a new diskselector widget handle or @c NULL, on errors.
25672 * This function inserts a new diskselector widget on the canvas.
25674 * @ingroup Diskselector
25676 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25679 * Enable or disable round mode.
25681 * @param obj The diskselector object.
25682 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25685 * Disabled by default. If round mode is enabled the items list will
25686 * work like a circle list, so when the user reaches the last item,
25687 * the first one will popup.
25689 * @see elm_diskselector_round_get()
25691 * @ingroup Diskselector
25693 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25696 * Get a value whether round mode is enabled or not.
25698 * @see elm_diskselector_round_set() for details.
25700 * @param obj The diskselector object.
25701 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25702 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25704 * @ingroup Diskselector
25706 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25709 * Get the side labels max length.
25711 * @deprecated use elm_diskselector_side_label_length_get() instead:
25713 * @param obj The diskselector object.
25714 * @return The max length defined for side labels, or 0 if not a valid
25717 * @ingroup Diskselector
25719 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25722 * Set the side labels max length.
25724 * @deprecated use elm_diskselector_side_label_length_set() instead:
25726 * @param obj The diskselector object.
25727 * @param len The max length defined for side labels.
25729 * @ingroup Diskselector
25731 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25734 * Get the side labels max length.
25736 * @see elm_diskselector_side_label_length_set() for details.
25738 * @param obj The diskselector object.
25739 * @return The max length defined for side labels, or 0 if not a valid
25742 * @ingroup Diskselector
25744 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25747 * Set the side labels max length.
25749 * @param obj The diskselector object.
25750 * @param len The max length defined for side labels.
25752 * Length is the number of characters of items' label that will be
25753 * visible when it's set on side positions. It will just crop
25754 * the string after defined size. E.g.:
25756 * An item with label "January" would be displayed on side position as
25757 * "Jan" if max length is set to 3, or "Janu", if this property
25760 * When it's selected, the entire label will be displayed, except for
25761 * width restrictions. In this case label will be cropped and "..."
25762 * will be concatenated.
25764 * Default side label max length is 3.
25766 * This property will be applyed over all items, included before or
25767 * later this function call.
25769 * @ingroup Diskselector
25771 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25774 * Set the number of items to be displayed.
25776 * @param obj The diskselector object.
25777 * @param num The number of items the diskselector will display.
25779 * Default value is 3, and also it's the minimun. If @p num is less
25780 * than 3, it will be set to 3.
25782 * Also, it can be set on theme, using data item @c display_item_num
25783 * on group "elm/diskselector/item/X", where X is style set.
25786 * group { name: "elm/diskselector/item/X";
25788 * item: "display_item_num" "5";
25791 * @ingroup Diskselector
25793 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25796 * Get the number of items in the diskselector object.
25798 * @param obj The diskselector object.
25800 * @ingroup Diskselector
25802 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25805 * Set bouncing behaviour when the scrolled content reaches an edge.
25807 * Tell the internal scroller object whether it should bounce or not
25808 * when it reaches the respective edges for each axis.
25810 * @param obj The diskselector object.
25811 * @param h_bounce Whether to bounce or not in the horizontal axis.
25812 * @param v_bounce Whether to bounce or not in the vertical axis.
25814 * @see elm_scroller_bounce_set()
25816 * @ingroup Diskselector
25818 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25821 * Get the bouncing behaviour of the internal scroller.
25823 * Get whether the internal scroller should bounce when the edge of each
25824 * axis is reached scrolling.
25826 * @param obj The diskselector object.
25827 * @param h_bounce Pointer where to store the bounce state of the horizontal
25829 * @param v_bounce Pointer where to store the bounce state of the vertical
25832 * @see elm_scroller_bounce_get()
25833 * @see elm_diskselector_bounce_set()
25835 * @ingroup Diskselector
25837 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25840 * Get the scrollbar policy.
25842 * @see elm_diskselector_scroller_policy_get() for details.
25844 * @param obj The diskselector object.
25845 * @param policy_h Pointer where to store horizontal scrollbar policy.
25846 * @param policy_v Pointer where to store vertical scrollbar policy.
25848 * @ingroup Diskselector
25850 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);
25853 * Set the scrollbar policy.
25855 * @param obj The diskselector object.
25856 * @param policy_h Horizontal scrollbar policy.
25857 * @param policy_v Vertical scrollbar policy.
25859 * This sets the scrollbar visibility policy for the given scroller.
25860 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
25861 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
25862 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
25863 * This applies respectively for the horizontal and vertical scrollbars.
25865 * The both are disabled by default, i.e., are set to
25866 * #ELM_SCROLLER_POLICY_OFF.
25868 * @ingroup Diskselector
25870 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
25873 * Remove all diskselector's items.
25875 * @param obj The diskselector object.
25877 * @see elm_diskselector_item_del()
25878 * @see elm_diskselector_item_append()
25880 * @ingroup Diskselector
25882 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25885 * Get a list of all the diskselector items.
25887 * @param obj The diskselector object.
25888 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
25889 * or @c NULL on failure.
25891 * @see elm_diskselector_item_append()
25892 * @see elm_diskselector_item_del()
25893 * @see elm_diskselector_clear()
25895 * @ingroup Diskselector
25897 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25900 * Appends a new item to the diskselector object.
25902 * @param obj The diskselector object.
25903 * @param label The label of the diskselector item.
25904 * @param icon The icon object to use at left side of the item. An
25905 * icon can be any Evas object, but usually it is an icon created
25906 * with elm_icon_add().
25907 * @param func The function to call when the item is selected.
25908 * @param data The data to associate with the item for related callbacks.
25910 * @return The created item or @c NULL upon failure.
25912 * A new item will be created and appended to the diskselector, i.e., will
25913 * be set as last item. Also, if there is no selected item, it will
25914 * be selected. This will always happens for the first appended item.
25916 * If no icon is set, label will be centered on item position, otherwise
25917 * the icon will be placed at left of the label, that will be shifted
25920 * Items created with this method can be deleted with
25921 * elm_diskselector_item_del().
25923 * Associated @p data can be properly freed when item is deleted if a
25924 * callback function is set with elm_diskselector_item_del_cb_set().
25926 * If a function is passed as argument, it will be called everytime this item
25927 * is selected, i.e., the user stops the diskselector with this
25928 * item on center position. If such function isn't needed, just passing
25929 * @c NULL as @p func is enough. The same should be done for @p data.
25931 * Simple example (with no function callback or data associated):
25933 * disk = elm_diskselector_add(win);
25934 * ic = elm_icon_add(win);
25935 * elm_icon_file_set(ic, "path/to/image", NULL);
25936 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25937 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
25940 * @see elm_diskselector_item_del()
25941 * @see elm_diskselector_item_del_cb_set()
25942 * @see elm_diskselector_clear()
25943 * @see elm_icon_add()
25945 * @ingroup Diskselector
25947 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);
25951 * Delete them item from the diskselector.
25953 * @param it The item of diskselector to be deleted.
25955 * If deleting all diskselector items is required, elm_diskselector_clear()
25956 * should be used instead of getting items list and deleting each one.
25958 * @see elm_diskselector_clear()
25959 * @see elm_diskselector_item_append()
25960 * @see elm_diskselector_item_del_cb_set()
25962 * @ingroup Diskselector
25964 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25967 * Set the function called when a diskselector item is freed.
25969 * @param it The item to set the callback on
25970 * @param func The function called
25972 * If there is a @p func, then it will be called prior item's memory release.
25973 * That will be called with the following arguments:
25975 * @li item's Evas object;
25978 * This way, a data associated to a diskselector item could be properly
25981 * @ingroup Diskselector
25983 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
25986 * Get the data associated to the item.
25988 * @param it The diskselector item
25989 * @return The data associated to @p it
25991 * The return value is a pointer to data associated to @p item when it was
25992 * created, with function elm_diskselector_item_append(). If no data
25993 * was passed as argument, it will return @c NULL.
25995 * @see elm_diskselector_item_append()
25997 * @ingroup Diskselector
25999 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26002 * Set the icon associated to the item.
26004 * @param it The diskselector item
26005 * @param icon The icon object to associate with @p it
26007 * The icon object to use at left side of the item. An
26008 * icon can be any Evas object, but usually it is an icon created
26009 * with elm_icon_add().
26011 * Once the icon object is set, a previously set one will be deleted.
26012 * @warning Setting the same icon for two items will cause the icon to
26013 * dissapear from the first item.
26015 * If an icon was passed as argument on item creation, with function
26016 * elm_diskselector_item_append(), it will be already
26017 * associated to the item.
26019 * @see elm_diskselector_item_append()
26020 * @see elm_diskselector_item_icon_get()
26022 * @ingroup Diskselector
26024 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
26027 * Get the icon associated to the item.
26029 * @param it The diskselector item
26030 * @return The icon associated to @p it
26032 * The return value is a pointer to the icon associated to @p item when it was
26033 * created, with function elm_diskselector_item_append(), or later
26034 * with function elm_diskselector_item_icon_set. If no icon
26035 * was passed as argument, it will return @c NULL.
26037 * @see elm_diskselector_item_append()
26038 * @see elm_diskselector_item_icon_set()
26040 * @ingroup Diskselector
26042 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26045 * Set the label of item.
26047 * @param it The item of diskselector.
26048 * @param label The label of item.
26050 * The label to be displayed by the item.
26052 * If no icon is set, label will be centered on item position, otherwise
26053 * the icon will be placed at left of the label, that will be shifted
26056 * An item with label "January" would be displayed on side position as
26057 * "Jan" if max length is set to 3 with function
26058 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
26061 * When this @p item is selected, the entire label will be displayed,
26062 * except for width restrictions.
26063 * In this case label will be cropped and "..." will be concatenated,
26064 * but only for display purposes. It will keep the entire string, so
26065 * if diskselector is resized the remaining characters will be displayed.
26067 * If a label was passed as argument on item creation, with function
26068 * elm_diskselector_item_append(), it will be already
26069 * displayed by the item.
26071 * @see elm_diskselector_side_label_lenght_set()
26072 * @see elm_diskselector_item_label_get()
26073 * @see elm_diskselector_item_append()
26075 * @ingroup Diskselector
26077 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
26080 * Get the label of item.
26082 * @param it The item of diskselector.
26083 * @return The label of item.
26085 * The return value is a pointer to the label associated to @p item when it was
26086 * created, with function elm_diskselector_item_append(), or later
26087 * with function elm_diskselector_item_label_set. If no label
26088 * was passed as argument, it will return @c NULL.
26090 * @see elm_diskselector_item_label_set() for more details.
26091 * @see elm_diskselector_item_append()
26093 * @ingroup Diskselector
26095 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26098 * Get the selected item.
26100 * @param obj The diskselector object.
26101 * @return The selected diskselector item.
26103 * The selected item can be unselected with function
26104 * elm_diskselector_item_selected_set(), and the first item of
26105 * diskselector will be selected.
26107 * The selected item always will be centered on diskselector, with
26108 * full label displayed, i.e., max lenght set to side labels won't
26109 * apply on the selected item. More details on
26110 * elm_diskselector_side_label_length_set().
26112 * @ingroup Diskselector
26114 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26117 * Set the selected state of an item.
26119 * @param it The diskselector item
26120 * @param selected The selected state
26122 * This sets the selected state of the given item @p it.
26123 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26125 * If a new item is selected the previosly selected will be unselected.
26126 * Previoulsy selected item can be get with function
26127 * elm_diskselector_selected_item_get().
26129 * If the item @p it is unselected, the first item of diskselector will
26132 * Selected items will be visible on center position of diskselector.
26133 * So if it was on another position before selected, or was invisible,
26134 * diskselector will animate items until the selected item reaches center
26137 * @see elm_diskselector_item_selected_get()
26138 * @see elm_diskselector_selected_item_get()
26140 * @ingroup Diskselector
26142 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26145 * Get whether the @p item is selected or not.
26147 * @param it The diskselector item.
26148 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26149 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26151 * @see elm_diskselector_selected_item_set() for details.
26152 * @see elm_diskselector_item_selected_get()
26154 * @ingroup Diskselector
26156 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26159 * Get the first item of the diskselector.
26161 * @param obj The diskselector object.
26162 * @return The first item, or @c NULL if none.
26164 * The list of items follows append order. So it will return the first
26165 * item appended to the widget that wasn't deleted.
26167 * @see elm_diskselector_item_append()
26168 * @see elm_diskselector_items_get()
26170 * @ingroup Diskselector
26172 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26175 * Get the last item of the diskselector.
26177 * @param obj The diskselector object.
26178 * @return The last item, or @c NULL if none.
26180 * The list of items follows append order. So it will return last first
26181 * item appended to the widget that wasn't deleted.
26183 * @see elm_diskselector_item_append()
26184 * @see elm_diskselector_items_get()
26186 * @ingroup Diskselector
26188 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26191 * Get the item before @p item in diskselector.
26193 * @param it The diskselector item.
26194 * @return The item before @p item, or @c NULL if none or on failure.
26196 * The list of items follows append order. So it will return item appended
26197 * just before @p item and that wasn't deleted.
26199 * If it is the first item, @c NULL will be returned.
26200 * First item can be get by elm_diskselector_first_item_get().
26202 * @see elm_diskselector_item_append()
26203 * @see elm_diskselector_items_get()
26205 * @ingroup Diskselector
26207 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26210 * Get the item after @p item in diskselector.
26212 * @param it The diskselector item.
26213 * @return The item after @p item, or @c NULL if none or on failure.
26215 * The list of items follows append order. So it will return item appended
26216 * just after @p item and that wasn't deleted.
26218 * If it is the last item, @c NULL will be returned.
26219 * Last item can be get by elm_diskselector_last_item_get().
26221 * @see elm_diskselector_item_append()
26222 * @see elm_diskselector_items_get()
26224 * @ingroup Diskselector
26226 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26229 * Set the text to be shown in the diskselector item.
26231 * @param item Target item
26232 * @param text The text to set in the content
26234 * Setup the text as tooltip to object. The item can have only one tooltip,
26235 * so any previous tooltip data is removed.
26237 * @see elm_object_tooltip_text_set() for more details.
26239 * @ingroup Diskselector
26241 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26244 * Set the content to be shown in the tooltip item.
26246 * Setup the tooltip to item. The item can have only one tooltip,
26247 * so any previous tooltip data is removed. @p func(with @p data) will
26248 * be called every time that need show the tooltip and it should
26249 * return a valid Evas_Object. This object is then managed fully by
26250 * tooltip system and is deleted when the tooltip is gone.
26252 * @param item the diskselector item being attached a tooltip.
26253 * @param func the function used to create the tooltip contents.
26254 * @param data what to provide to @a func as callback data/context.
26255 * @param del_cb called when data is not needed anymore, either when
26256 * another callback replaces @p func, the tooltip is unset with
26257 * elm_diskselector_item_tooltip_unset() or the owner @a item
26258 * dies. This callback receives as the first parameter the
26259 * given @a data, and @c event_info is the item.
26261 * @see elm_object_tooltip_content_cb_set() for more details.
26263 * @ingroup Diskselector
26265 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);
26268 * Unset tooltip from item.
26270 * @param item diskselector item to remove previously set tooltip.
26272 * Remove tooltip from item. The callback provided as del_cb to
26273 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26274 * it is not used anymore.
26276 * @see elm_object_tooltip_unset() for more details.
26277 * @see elm_diskselector_item_tooltip_content_cb_set()
26279 * @ingroup Diskselector
26281 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26285 * Sets a different style for this item tooltip.
26287 * @note before you set a style you should define a tooltip with
26288 * elm_diskselector_item_tooltip_content_cb_set() or
26289 * elm_diskselector_item_tooltip_text_set()
26291 * @param item diskselector item with tooltip already set.
26292 * @param style the theme style to use (default, transparent, ...)
26294 * @see elm_object_tooltip_style_set() for more details.
26296 * @ingroup Diskselector
26298 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26301 * Get the style for this item tooltip.
26303 * @param item diskselector item with tooltip already set.
26304 * @return style the theme style in use, defaults to "default". If the
26305 * object does not have a tooltip set, then NULL is returned.
26307 * @see elm_object_tooltip_style_get() for more details.
26308 * @see elm_diskselector_item_tooltip_style_set()
26310 * @ingroup Diskselector
26312 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26315 * Set the cursor to be shown when mouse is over the diskselector item
26317 * @param item Target item
26318 * @param cursor the cursor name to be used.
26320 * @see elm_object_cursor_set() for more details.
26322 * @ingroup Diskselector
26324 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26327 * Get the cursor to be shown when mouse is over the diskselector item
26329 * @param item diskselector item with cursor already set.
26330 * @return the cursor name.
26332 * @see elm_object_cursor_get() for more details.
26333 * @see elm_diskselector_cursor_set()
26335 * @ingroup Diskselector
26337 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26341 * Unset the cursor to be shown when mouse is over the diskselector item
26343 * @param item Target item
26345 * @see elm_object_cursor_unset() for more details.
26346 * @see elm_diskselector_cursor_set()
26348 * @ingroup Diskselector
26350 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26353 * Sets a different style for this item cursor.
26355 * @note before you set a style you should define a cursor with
26356 * elm_diskselector_item_cursor_set()
26358 * @param item diskselector item with cursor already set.
26359 * @param style the theme style to use (default, transparent, ...)
26361 * @see elm_object_cursor_style_set() for more details.
26363 * @ingroup Diskselector
26365 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26369 * Get the style for this item cursor.
26371 * @param item diskselector item with cursor already set.
26372 * @return style the theme style in use, defaults to "default". If the
26373 * object does not have a cursor set, then @c NULL is returned.
26375 * @see elm_object_cursor_style_get() for more details.
26376 * @see elm_diskselector_item_cursor_style_set()
26378 * @ingroup Diskselector
26380 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26384 * Set if the cursor set should be searched on the theme or should use
26385 * the provided by the engine, only.
26387 * @note before you set if should look on theme you should define a cursor
26388 * with elm_diskselector_item_cursor_set().
26389 * By default it will only look for cursors provided by the engine.
26391 * @param item widget item with cursor already set.
26392 * @param engine_only boolean to define if cursors set with
26393 * elm_diskselector_item_cursor_set() should be searched only
26394 * between cursors provided by the engine or searched on widget's
26397 * @see elm_object_cursor_engine_only_set() for more details.
26399 * @ingroup Diskselector
26401 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26404 * Get the cursor engine only usage for this item cursor.
26406 * @param item widget item with cursor already set.
26407 * @return engine_only boolean to define it cursors should be looked only
26408 * between the provided by the engine or searched on widget's theme as well.
26409 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26411 * @see elm_object_cursor_engine_only_get() for more details.
26412 * @see elm_diskselector_item_cursor_engine_only_set()
26414 * @ingroup Diskselector
26416 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26423 * @defgroup Colorselector Colorselector
26427 * @image html img/widget/colorselector/preview-00.png
26428 * @image latex img/widget/colorselector/preview-00.eps
26430 * @brief Widget for user to select a color.
26432 * Signals that you can add callbacks for are:
26433 * "changed" - When the color value changes(event_info is NULL).
26435 * See @ref tutorial_colorselector.
26438 * @brief Add a new colorselector to the parent
26440 * @param parent The parent object
26441 * @return The new object or NULL if it cannot be created
26443 * @ingroup Colorselector
26445 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26447 * Set a color for the colorselector
26449 * @param obj Colorselector object
26450 * @param r r-value of color
26451 * @param g g-value of color
26452 * @param b b-value of color
26453 * @param a a-value of color
26455 * @ingroup Colorselector
26457 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26459 * Get a color from the colorselector
26461 * @param obj Colorselector object
26462 * @param r integer pointer for r-value of color
26463 * @param g integer pointer for g-value of color
26464 * @param b integer pointer for b-value of color
26465 * @param a integer pointer for a-value of color
26467 * @ingroup Colorselector
26469 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26475 * @defgroup Ctxpopup Ctxpopup
26477 * @image html img/widget/ctxpopup/preview-00.png
26478 * @image latex img/widget/ctxpopup/preview-00.eps
26480 * @brief Context popup widet.
26482 * A ctxpopup is a widget that, when shown, pops up a list of items.
26483 * It automatically chooses an area inside its parent object's view
26484 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26485 * optimally fit into it. In the default theme, it will also point an
26486 * arrow to it's top left position at the time one shows it. Ctxpopup
26487 * items have a label and/or an icon. It is intended for a small
26488 * number of items (hence the use of list, not genlist).
26490 * @note Ctxpopup is a especialization of @ref Hover.
26492 * Signals that you can add callbacks for are:
26493 * "dismissed" - the ctxpopup was dismissed
26495 * Default contents parts of the ctxpopup widget that you can use for are:
26496 * @li "default" - A content of the ctxpopup
26498 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26501 typedef enum _Elm_Ctxpopup_Direction
26503 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26505 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26506 the clicked area */
26507 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26508 the clicked area */
26509 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26511 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26512 } Elm_Ctxpopup_Direction;
26513 #define Elm_Ctxpopup_Item Elm_Object_Item
26516 * @brief Add a new Ctxpopup object to the parent.
26518 * @param parent Parent object
26519 * @return New object or @c NULL, if it cannot be created
26521 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26523 * @brief Set the Ctxpopup's parent
26525 * @param obj The ctxpopup object
26526 * @param area The parent to use
26528 * Set the parent object.
26530 * @note elm_ctxpopup_add() will automatically call this function
26531 * with its @c parent argument.
26533 * @see elm_ctxpopup_add()
26534 * @see elm_hover_parent_set()
26536 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26538 * @brief Get the Ctxpopup's parent
26540 * @param obj The ctxpopup object
26542 * @see elm_ctxpopup_hover_parent_set() for more information
26544 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26546 * @brief Clear all items in the given ctxpopup object.
26548 * @param obj Ctxpopup object
26550 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26552 * @brief Change the ctxpopup's orientation to horizontal or vertical.
26554 * @param obj Ctxpopup object
26555 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26557 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26559 * @brief Get the value of current ctxpopup object's orientation.
26561 * @param obj Ctxpopup object
26562 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26564 * @see elm_ctxpopup_horizontal_set()
26566 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26568 * @brief Add a new item to a ctxpopup object.
26570 * @param obj Ctxpopup object
26571 * @param icon Icon to be set on new item
26572 * @param label The Label of the new item
26573 * @param func Convenience function called when item selected
26574 * @param data Data passed to @p func
26575 * @return A handle to the item added or @c NULL, on errors
26577 * @warning Ctxpopup can't hold both an item list and a content at the same
26578 * time. When an item is added, any previous content will be removed.
26580 * @see elm_ctxpopup_content_set()
26582 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);
26584 * @brief Delete the given item in a ctxpopup object.
26586 * @param it Ctxpopup item to be deleted
26588 * @see elm_ctxpopup_item_append()
26590 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26592 * @brief Set the ctxpopup item's state as disabled or enabled.
26594 * @param it Ctxpopup item to be enabled/disabled
26595 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26597 * When disabled the item is greyed out to indicate it's state.
26599 EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26601 * @brief Get the ctxpopup item's disabled/enabled state.
26603 * @param it Ctxpopup item to be enabled/disabled
26604 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26606 * @see elm_ctxpopup_item_disabled_set()
26607 * @deprecated use elm_object_item_disabled_get() instead
26609 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26611 * @brief Get the icon object for the given ctxpopup item.
26613 * @param it Ctxpopup item
26614 * @return icon object or @c NULL, if the item does not have icon or an error
26617 * @see elm_ctxpopup_item_append()
26618 * @see elm_ctxpopup_item_icon_set()
26620 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26622 * @brief Sets the side icon associated with the ctxpopup item
26624 * @param it Ctxpopup item
26625 * @param icon Icon object to be set
26627 * Once the icon object is set, a previously set one will be deleted.
26628 * @warning Setting the same icon for two items will cause the icon to
26629 * dissapear from the first item.
26631 * @see elm_ctxpopup_item_append()
26633 EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26635 * @brief Get the label for the given ctxpopup item.
26637 * @param it Ctxpopup item
26638 * @return label string or @c NULL, if the item does not have label or an
26641 * @see elm_ctxpopup_item_append()
26642 * @see elm_ctxpopup_item_label_set()
26644 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26646 * @brief (Re)set the label on the given ctxpopup item.
26648 * @param it Ctxpopup item
26649 * @param label String to set as label
26651 EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26653 * @brief Set an elm widget as the content of the ctxpopup.
26655 * @param obj Ctxpopup object
26656 * @param content Content to be swallowed
26658 * If the content object is already set, a previous one will bedeleted. If
26659 * you want to keep that old content object, use the
26660 * elm_ctxpopup_content_unset() function.
26662 * @deprecated use elm_object_content_set()
26664 * @warning Ctxpopup can't hold both a item list and a content at the same
26665 * time. When a content is set, any previous items will be removed.
26667 EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26669 * @brief Unset the ctxpopup content
26671 * @param obj Ctxpopup object
26672 * @return The content that was being used
26674 * Unparent and return the content object which was set for this widget.
26676 * @deprecated use elm_object_content_unset()
26678 * @see elm_ctxpopup_content_set()
26680 EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26682 * @brief Set the direction priority of a ctxpopup.
26684 * @param obj Ctxpopup object
26685 * @param first 1st priority of direction
26686 * @param second 2nd priority of direction
26687 * @param third 3th priority of direction
26688 * @param fourth 4th priority of direction
26690 * This functions gives a chance to user to set the priority of ctxpopup
26691 * showing direction. This doesn't guarantee the ctxpopup will appear in the
26692 * requested direction.
26694 * @see Elm_Ctxpopup_Direction
26696 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);
26698 * @brief Get the direction priority of a ctxpopup.
26700 * @param obj Ctxpopup object
26701 * @param first 1st priority of direction to be returned
26702 * @param second 2nd priority of direction to be returned
26703 * @param third 3th priority of direction to be returned
26704 * @param fourth 4th priority of direction to be returned
26706 * @see elm_ctxpopup_direction_priority_set() for more information.
26708 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);
26711 * @brief Get the current direction of a ctxpopup.
26713 * @param obj Ctxpopup object
26714 * @return current direction of a ctxpopup
26716 * @warning Once the ctxpopup showed up, the direction would be determined
26718 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26727 * @defgroup Transit Transit
26728 * @ingroup Elementary
26730 * Transit is designed to apply various animated transition effects to @c
26731 * Evas_Object, such like translation, rotation, etc. For using these
26732 * effects, create an @ref Elm_Transit and add the desired transition effects.
26734 * Once the effects are added into transit, they will be automatically
26735 * managed (their callback will be called until the duration is ended, and
26736 * they will be deleted on completion).
26740 * Elm_Transit *trans = elm_transit_add();
26741 * elm_transit_object_add(trans, obj);
26742 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26743 * elm_transit_duration_set(transit, 1);
26744 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26745 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26746 * elm_transit_repeat_times_set(transit, 3);
26749 * Some transition effects are used to change the properties of objects. They
26751 * @li @ref elm_transit_effect_translation_add
26752 * @li @ref elm_transit_effect_color_add
26753 * @li @ref elm_transit_effect_rotation_add
26754 * @li @ref elm_transit_effect_wipe_add
26755 * @li @ref elm_transit_effect_zoom_add
26756 * @li @ref elm_transit_effect_resizing_add
26758 * Other transition effects are used to make one object disappear and another
26759 * object appear on its old place. These effects are:
26761 * @li @ref elm_transit_effect_flip_add
26762 * @li @ref elm_transit_effect_resizable_flip_add
26763 * @li @ref elm_transit_effect_fade_add
26764 * @li @ref elm_transit_effect_blend_add
26766 * It's also possible to make a transition chain with @ref
26767 * elm_transit_chain_transit_add.
26769 * @warning We strongly recommend to use elm_transit just when edje can not do
26770 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26771 * animations can be manipulated inside the theme.
26773 * List of examples:
26774 * @li @ref transit_example_01_explained
26775 * @li @ref transit_example_02_explained
26776 * @li @ref transit_example_03_c
26777 * @li @ref transit_example_04_c
26783 * @enum Elm_Transit_Tween_Mode
26785 * The type of acceleration used in the transition.
26789 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26790 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26791 over time, then decrease again
26793 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26795 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26797 } Elm_Transit_Tween_Mode;
26800 * @enum Elm_Transit_Effect_Flip_Axis
26802 * The axis where flip effect should be applied.
26806 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26807 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26808 } Elm_Transit_Effect_Flip_Axis;
26810 * @enum Elm_Transit_Effect_Wipe_Dir
26812 * The direction where the wipe effect should occur.
26816 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26817 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26818 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26819 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26820 } Elm_Transit_Effect_Wipe_Dir;
26821 /** @enum Elm_Transit_Effect_Wipe_Type
26823 * Whether the wipe effect should show or hide the object.
26827 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26829 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26831 } Elm_Transit_Effect_Wipe_Type;
26834 * @typedef Elm_Transit
26836 * The Transit created with elm_transit_add(). This type has the information
26837 * about the objects which the transition will be applied, and the
26838 * transition effects that will be used. It also contains info about
26839 * duration, number of repetitions, auto-reverse, etc.
26841 typedef struct _Elm_Transit Elm_Transit;
26842 typedef void Elm_Transit_Effect;
26844 * @typedef Elm_Transit_Effect_Transition_Cb
26846 * Transition callback called for this effect on each transition iteration.
26848 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
26850 * Elm_Transit_Effect_End_Cb
26852 * Transition callback called for this effect when the transition is over.
26854 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
26857 * Elm_Transit_Del_Cb
26859 * A callback called when the transit is deleted.
26861 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
26866 * @note Is not necessary to delete the transit object, it will be deleted at
26867 * the end of its operation.
26868 * @note The transit will start playing when the program enter in the main loop, is not
26869 * necessary to give a start to the transit.
26871 * @return The transit object.
26875 EAPI Elm_Transit *elm_transit_add(void);
26878 * Stops the animation and delete the @p transit object.
26880 * Call this function if you wants to stop the animation before the duration
26881 * time. Make sure the @p transit object is still alive with
26882 * elm_transit_del_cb_set() function.
26883 * All added effects will be deleted, calling its repective data_free_cb
26884 * functions. The function setted by elm_transit_del_cb_set() will be called.
26886 * @see elm_transit_del_cb_set()
26888 * @param transit The transit object to be deleted.
26891 * @warning Just call this function if you are sure the transit is alive.
26893 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26896 * Add a new effect to the transit.
26898 * @note The cb function and the data are the key to the effect. If you try to
26899 * add an already added effect, nothing is done.
26900 * @note After the first addition of an effect in @p transit, if its
26901 * effect list become empty again, the @p transit will be killed by
26902 * elm_transit_del(transit) function.
26906 * Elm_Transit *transit = elm_transit_add();
26907 * elm_transit_effect_add(transit,
26908 * elm_transit_effect_blend_op,
26909 * elm_transit_effect_blend_context_new(),
26910 * elm_transit_effect_blend_context_free);
26913 * @param transit The transit object.
26914 * @param transition_cb The operation function. It is called when the
26915 * animation begins, it is the function that actually performs the animation.
26916 * It is called with the @p data, @p transit and the time progression of the
26917 * animation (a double value between 0.0 and 1.0).
26918 * @param effect The context data of the effect.
26919 * @param end_cb The function to free the context data, it will be called
26920 * at the end of the effect, it must finalize the animation and free the
26924 * @warning The transit free the context data at the and of the transition with
26925 * the data_free_cb function, do not use the context data in another transit.
26927 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);
26930 * Delete an added effect.
26932 * This function will remove the effect from the @p transit, calling the
26933 * data_free_cb to free the @p data.
26935 * @see elm_transit_effect_add()
26937 * @note If the effect is not found, nothing is done.
26938 * @note If the effect list become empty, this function will call
26939 * elm_transit_del(transit), that is, it will kill the @p transit.
26941 * @param transit The transit object.
26942 * @param transition_cb The operation function.
26943 * @param effect The context data of the effect.
26947 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);
26950 * Add new object to apply the effects.
26952 * @note After the first addition of an object in @p transit, if its
26953 * object list become empty again, the @p transit will be killed by
26954 * elm_transit_del(transit) function.
26955 * @note If the @p obj belongs to another transit, the @p obj will be
26956 * removed from it and it will only belong to the @p transit. If the old
26957 * transit stays without objects, it will die.
26958 * @note When you add an object into the @p transit, its state from
26959 * evas_object_pass_events_get(obj) is saved, and it is applied when the
26960 * transit ends, if you change this state whith evas_object_pass_events_set()
26961 * after add the object, this state will change again when @p transit stops to
26964 * @param transit The transit object.
26965 * @param obj Object to be animated.
26968 * @warning It is not allowed to add a new object after transit begins to go.
26970 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26973 * Removes an added object from the transit.
26975 * @note If the @p obj is not in the @p transit, nothing is done.
26976 * @note If the list become empty, this function will call
26977 * elm_transit_del(transit), that is, it will kill the @p transit.
26979 * @param transit The transit object.
26980 * @param obj Object to be removed from @p transit.
26983 * @warning It is not allowed to remove objects after transit begins to go.
26985 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26988 * Get the objects of the transit.
26990 * @param transit The transit object.
26991 * @return a Eina_List with the objects from the transit.
26995 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26998 * Enable/disable keeping up the objects states.
26999 * If it is not kept, the objects states will be reset when transition ends.
27001 * @note @p transit can not be NULL.
27002 * @note One state includes geometry, color, map data.
27004 * @param transit The transit object.
27005 * @param state_keep Keeping or Non Keeping.
27009 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
27012 * Get a value whether the objects states will be reset or not.
27014 * @note @p transit can not be NULL
27016 * @see elm_transit_objects_final_state_keep_set()
27018 * @param transit The transit object.
27019 * @return EINA_TRUE means the states of the objects will be reset.
27020 * If @p transit is NULL, EINA_FALSE is returned
27024 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27027 * Set the event enabled when transit is operating.
27029 * If @p enabled is EINA_TRUE, the objects of the transit will receives
27030 * events from mouse and keyboard during the animation.
27031 * @note When you add an object with elm_transit_object_add(), its state from
27032 * evas_object_pass_events_get(obj) is saved, and it is applied when the
27033 * transit ends, if you change this state with evas_object_pass_events_set()
27034 * after adding the object, this state will change again when @p transit stops
27037 * @param transit The transit object.
27038 * @param enabled Events are received when enabled is @c EINA_TRUE, and
27039 * ignored otherwise.
27043 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
27046 * Get the value of event enabled status.
27048 * @see elm_transit_event_enabled_set()
27050 * @param transit The Transit object
27051 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
27052 * EINA_FALSE is returned
27056 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27059 * Set the user-callback function when the transit is deleted.
27061 * @note Using this function twice will overwrite the first function setted.
27062 * @note the @p transit object will be deleted after call @p cb function.
27064 * @param transit The transit object.
27065 * @param cb Callback function pointer. This function will be called before
27066 * the deletion of the transit.
27067 * @param data Callback funtion user data. It is the @p op parameter.
27071 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
27074 * Set reverse effect automatically.
27076 * If auto reverse is setted, after running the effects with the progress
27077 * parameter from 0 to 1, it will call the effecs again with the progress
27078 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
27079 * where the duration was setted with the function elm_transit_add and
27080 * the repeat with the function elm_transit_repeat_times_set().
27082 * @param transit The transit object.
27083 * @param reverse EINA_TRUE means the auto_reverse is on.
27087 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
27090 * Get if the auto reverse is on.
27092 * @see elm_transit_auto_reverse_set()
27094 * @param transit The transit object.
27095 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27096 * EINA_FALSE is returned
27100 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27103 * Set the transit repeat count. Effect will be repeated by repeat count.
27105 * This function sets the number of repetition the transit will run after
27106 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27107 * If the @p repeat is a negative number, it will repeat infinite times.
27109 * @note If this function is called during the transit execution, the transit
27110 * will run @p repeat times, ignoring the times it already performed.
27112 * @param transit The transit object
27113 * @param repeat Repeat count
27117 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27120 * Get the transit repeat count.
27122 * @see elm_transit_repeat_times_set()
27124 * @param transit The Transit object.
27125 * @return The repeat count. If @p transit is NULL
27130 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27133 * Set the transit animation acceleration type.
27135 * This function sets the tween mode of the transit that can be:
27136 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27137 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27138 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27139 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27141 * @param transit The transit object.
27142 * @param tween_mode The tween type.
27146 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27149 * Get the transit animation acceleration type.
27151 * @note @p transit can not be NULL
27153 * @param transit The transit object.
27154 * @return The tween type. If @p transit is NULL
27155 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27159 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27162 * Set the transit animation time
27164 * @note @p transit can not be NULL
27166 * @param transit The transit object.
27167 * @param duration The animation time.
27171 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27174 * Get the transit animation time
27176 * @note @p transit can not be NULL
27178 * @param transit The transit object.
27180 * @return The transit animation time.
27184 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27187 * Starts the transition.
27188 * Once this API is called, the transit begins to measure the time.
27190 * @note @p transit can not be NULL
27192 * @param transit The transit object.
27196 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27199 * Pause/Resume the transition.
27201 * If you call elm_transit_go again, the transit will be started from the
27202 * beginning, and will be unpaused.
27204 * @note @p transit can not be NULL
27206 * @param transit The transit object.
27207 * @param paused Whether the transition should be paused or not.
27211 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27214 * Get the value of paused status.
27216 * @see elm_transit_paused_set()
27218 * @note @p transit can not be NULL
27220 * @param transit The transit object.
27221 * @return EINA_TRUE means transition is paused. If @p transit is NULL
27222 * EINA_FALSE is returned
27226 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27229 * Get the time progression of the animation (a double value between 0.0 and 1.0).
27231 * The value returned is a fraction (current time / total time). It
27232 * represents the progression position relative to the total.
27234 * @note @p transit can not be NULL
27236 * @param transit The transit object.
27238 * @return The time progression value. If @p transit is NULL
27243 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27246 * Makes the chain relationship between two transits.
27248 * @note @p transit can not be NULL. Transit would have multiple chain transits.
27249 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27251 * @param transit The transit object.
27252 * @param chain_transit The chain transit object. This transit will be operated
27253 * after transit is done.
27255 * This function adds @p chain_transit transition to a chain after the @p
27256 * transit, and will be started as soon as @p transit ends. See @ref
27257 * transit_example_02_explained for a full example.
27261 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27264 * Cut off the chain relationship between two transits.
27266 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27267 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27269 * @param transit The transit object.
27270 * @param chain_transit The chain transit object.
27272 * This function remove the @p chain_transit transition from the @p transit.
27276 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27279 * Get the current chain transit list.
27281 * @note @p transit can not be NULL.
27283 * @param transit The transit object.
27284 * @return chain transit list.
27288 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
27291 * Add the Resizing Effect to Elm_Transit.
27293 * @note This API is one of the facades. It creates resizing effect context
27294 * and add it's required APIs to elm_transit_effect_add.
27296 * @see elm_transit_effect_add()
27298 * @param transit Transit object.
27299 * @param from_w Object width size when effect begins.
27300 * @param from_h Object height size when effect begins.
27301 * @param to_w Object width size when effect ends.
27302 * @param to_h Object height size when effect ends.
27303 * @return Resizing effect context data.
27307 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);
27310 * Add the Translation Effect to Elm_Transit.
27312 * @note This API is one of the facades. It creates translation effect context
27313 * and add it's required APIs to elm_transit_effect_add.
27315 * @see elm_transit_effect_add()
27317 * @param transit Transit object.
27318 * @param from_dx X Position variation when effect begins.
27319 * @param from_dy Y Position variation when effect begins.
27320 * @param to_dx X Position variation when effect ends.
27321 * @param to_dy Y Position variation when effect ends.
27322 * @return Translation effect context data.
27325 * @warning It is highly recommended just create a transit with this effect when
27326 * the window that the objects of the transit belongs has already been created.
27327 * This is because this effect needs the geometry information about the objects,
27328 * and if the window was not created yet, it can get a wrong information.
27330 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);
27333 * Add the Zoom Effect to Elm_Transit.
27335 * @note This API is one of the facades. It creates zoom effect context
27336 * and add it's required APIs to elm_transit_effect_add.
27338 * @see elm_transit_effect_add()
27340 * @param transit Transit object.
27341 * @param from_rate Scale rate when effect begins (1 is current rate).
27342 * @param to_rate Scale rate when effect ends.
27343 * @return Zoom effect context data.
27346 * @warning It is highly recommended just create a transit with this effect when
27347 * the window that the objects of the transit belongs has already been created.
27348 * This is because this effect needs the geometry information about the objects,
27349 * and if the window was not created yet, it can get a wrong information.
27351 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27354 * Add the Flip Effect to Elm_Transit.
27356 * @note This API is one of the facades. It creates flip effect context
27357 * and add it's required APIs to elm_transit_effect_add.
27358 * @note This effect is applied to each pair of objects in the order they are listed
27359 * in the transit list of objects. The first object in the pair will be the
27360 * "front" object and the second will be the "back" object.
27362 * @see elm_transit_effect_add()
27364 * @param transit Transit object.
27365 * @param axis Flipping Axis(X or Y).
27366 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27367 * @return Flip effect context data.
27370 * @warning It is highly recommended just create a transit with this effect when
27371 * the window that the objects of the transit belongs has already been created.
27372 * This is because this effect needs the geometry information about the objects,
27373 * and if the window was not created yet, it can get a wrong information.
27375 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27378 * Add the Resizable Flip Effect to Elm_Transit.
27380 * @note This API is one of the facades. It creates resizable flip effect context
27381 * and add it's required APIs to elm_transit_effect_add.
27382 * @note This effect is applied to each pair of objects in the order they are listed
27383 * in the transit list of objects. The first object in the pair will be the
27384 * "front" object and the second will be the "back" object.
27386 * @see elm_transit_effect_add()
27388 * @param transit Transit object.
27389 * @param axis Flipping Axis(X or Y).
27390 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27391 * @return Resizable flip effect context data.
27394 * @warning It is highly recommended just create a transit with this effect when
27395 * the window that the objects of the transit belongs has already been created.
27396 * This is because this effect needs the geometry information about the objects,
27397 * and if the window was not created yet, it can get a wrong information.
27399 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27402 * Add the Wipe Effect to Elm_Transit.
27404 * @note This API is one of the facades. It creates wipe effect context
27405 * and add it's required APIs to elm_transit_effect_add.
27407 * @see elm_transit_effect_add()
27409 * @param transit Transit object.
27410 * @param type Wipe type. Hide or show.
27411 * @param dir Wipe Direction.
27412 * @return Wipe effect context data.
27415 * @warning It is highly recommended just create a transit with this effect when
27416 * the window that the objects of the transit belongs has already been created.
27417 * This is because this effect needs the geometry information about the objects,
27418 * and if the window was not created yet, it can get a wrong information.
27420 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27423 * Add the Color Effect to Elm_Transit.
27425 * @note This API is one of the facades. It creates color effect context
27426 * and add it's required APIs to elm_transit_effect_add.
27428 * @see elm_transit_effect_add()
27430 * @param transit Transit object.
27431 * @param from_r RGB R when effect begins.
27432 * @param from_g RGB G when effect begins.
27433 * @param from_b RGB B when effect begins.
27434 * @param from_a RGB A when effect begins.
27435 * @param to_r RGB R when effect ends.
27436 * @param to_g RGB G when effect ends.
27437 * @param to_b RGB B when effect ends.
27438 * @param to_a RGB A when effect ends.
27439 * @return Color effect context data.
27443 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);
27446 * Add the Fade Effect to Elm_Transit.
27448 * @note This API is one of the facades. It creates fade effect context
27449 * and add it's required APIs to elm_transit_effect_add.
27450 * @note This effect is applied to each pair of objects in the order they are listed
27451 * in the transit list of objects. The first object in the pair will be the
27452 * "before" object and the second will be the "after" object.
27454 * @see elm_transit_effect_add()
27456 * @param transit Transit object.
27457 * @return Fade effect context data.
27460 * @warning It is highly recommended just create a transit with this effect when
27461 * the window that the objects of the transit belongs has already been created.
27462 * This is because this effect needs the color information about the objects,
27463 * and if the window was not created yet, it can get a wrong information.
27465 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27468 * Add the Blend Effect to Elm_Transit.
27470 * @note This API is one of the facades. It creates blend effect context
27471 * and add it's required APIs to elm_transit_effect_add.
27472 * @note This effect is applied to each pair of objects in the order they are listed
27473 * in the transit list of objects. The first object in the pair will be the
27474 * "before" object and the second will be the "after" object.
27476 * @see elm_transit_effect_add()
27478 * @param transit Transit object.
27479 * @return Blend effect context data.
27482 * @warning It is highly recommended just create a transit with this effect when
27483 * the window that the objects of the transit belongs has already been created.
27484 * This is because this effect needs the color information about the objects,
27485 * and if the window was not created yet, it can get a wrong information.
27487 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27490 * Add the Rotation Effect to Elm_Transit.
27492 * @note This API is one of the facades. It creates rotation effect context
27493 * and add it's required APIs to elm_transit_effect_add.
27495 * @see elm_transit_effect_add()
27497 * @param transit Transit object.
27498 * @param from_degree Degree when effect begins.
27499 * @param to_degree Degree when effect is ends.
27500 * @return Rotation effect context data.
27503 * @warning It is highly recommended just create a transit with this effect when
27504 * the window that the objects of the transit belongs has already been created.
27505 * This is because this effect needs the geometry information about the objects,
27506 * and if the window was not created yet, it can get a wrong information.
27508 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27511 * Add the ImageAnimation Effect to Elm_Transit.
27513 * @note This API is one of the facades. It creates image animation effect context
27514 * and add it's required APIs to elm_transit_effect_add.
27515 * The @p images parameter is a list images paths. This list and
27516 * its contents will be deleted at the end of the effect by
27517 * elm_transit_effect_image_animation_context_free() function.
27521 * char buf[PATH_MAX];
27522 * Eina_List *images = NULL;
27523 * Elm_Transit *transi = elm_transit_add();
27525 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27526 * images = eina_list_append(images, eina_stringshare_add(buf));
27528 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27529 * images = eina_list_append(images, eina_stringshare_add(buf));
27530 * elm_transit_effect_image_animation_add(transi, images);
27534 * @see elm_transit_effect_add()
27536 * @param transit Transit object.
27537 * @param images Eina_List of images file paths. This list and
27538 * its contents will be deleted at the end of the effect by
27539 * elm_transit_effect_image_animation_context_free() function.
27540 * @return Image Animation effect context data.
27544 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27550 typedef struct _Elm_Store Elm_Store;
27551 typedef struct _Elm_Store_DBsystem Elm_Store_DBsystem;
27552 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
27553 typedef struct _Elm_Store_Item Elm_Store_Item;
27554 typedef struct _Elm_Store_Item_DBsystem Elm_Store_Item_DBsystem;
27555 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
27556 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
27557 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27558 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
27559 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
27560 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
27561 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
27562 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
27564 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27565 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27566 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27567 typedef void (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
27568 typedef int (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
27569 typedef void (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
27570 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27574 ELM_STORE_ITEM_MAPPING_NONE = 0,
27575 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27576 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27577 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27578 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27579 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27580 // can add more here as needed by common apps
27581 ELM_STORE_ITEM_MAPPING_LAST
27582 } Elm_Store_Item_Mapping_Type;
27584 struct _Elm_Store_Item_Mapping_Icon
27586 // FIXME: allow edje file icons
27588 Elm_Icon_Lookup_Order lookup_order;
27589 Eina_Bool standard_name : 1;
27590 Eina_Bool no_scale : 1;
27591 Eina_Bool smooth : 1;
27592 Eina_Bool scale_up : 1;
27593 Eina_Bool scale_down : 1;
27596 struct _Elm_Store_Item_Mapping_Empty
27601 struct _Elm_Store_Item_Mapping_Photo
27606 struct _Elm_Store_Item_Mapping_Custom
27608 Elm_Store_Item_Mapping_Cb func;
27611 struct _Elm_Store_Item_Mapping
27613 Elm_Store_Item_Mapping_Type type;
27618 Elm_Store_Item_Mapping_Empty empty;
27619 Elm_Store_Item_Mapping_Icon icon;
27620 Elm_Store_Item_Mapping_Photo photo;
27621 Elm_Store_Item_Mapping_Custom custom;
27622 // add more types here
27626 struct _Elm_Store_Item_Info
27631 Eina_Bool rec_item;
27632 int pre_group_index;
27634 Elm_Genlist_Item_Class *item_class;
27635 const Elm_Store_Item_Mapping *mapping;
27640 struct _Elm_Store_Item_Info_Filesystem
27642 Elm_Store_Item_Info base;
27646 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27647 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27649 EAPI Elm_Store *elm_store_dbsystem_new(void);
27650 EAPI void elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
27651 EAPI void elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
27652 EAPI void elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
27653 EAPI void elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
27654 EAPI int elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27655 EAPI void *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27656 EAPI void elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
27657 EAPI int elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27658 EAPI Elm_Store_Item *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
27659 EAPI void elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27660 EAPI void elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
27661 EAPI void elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27662 EAPI void elm_store_free(Elm_Store *st);
27663 EAPI Elm_Store *elm_store_filesystem_new(void);
27664 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27665 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27666 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27668 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27670 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27671 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27672 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27673 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27674 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27675 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27677 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27678 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27679 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27680 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27681 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27682 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27683 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27686 * @defgroup SegmentControl SegmentControl
27687 * @ingroup Elementary
27689 * @image html img/widget/segment_control/preview-00.png
27690 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27692 * @image html img/segment_control.png
27693 * @image latex img/segment_control.eps width=\textwidth
27695 * Segment control widget is a horizontal control made of multiple segment
27696 * items, each segment item functioning similar to discrete two state button.
27697 * A segment control groups the items together and provides compact
27698 * single button with multiple equal size segments.
27700 * Segment item size is determined by base widget
27701 * size and the number of items added.
27702 * Only one segment item can be at selected state. A segment item can display
27703 * combination of Text and any Evas_Object like Images or other widget.
27705 * Smart callbacks one can listen to:
27706 * - "changed" - When the user clicks on a segment item which is not
27707 * previously selected and get selected. The event_info parameter is the
27708 * segment item pointer.
27710 * Available styles for it:
27713 * Here is an example on its usage:
27714 * @li @ref segment_control_example
27718 * @addtogroup SegmentControl
27722 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27725 * Add a new segment control widget to the given parent Elementary
27726 * (container) object.
27728 * @param parent The parent object.
27729 * @return a new segment control widget handle or @c NULL, on errors.
27731 * This function inserts a new segment control widget on the canvas.
27733 * @ingroup SegmentControl
27735 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27738 * Append a new item to the segment control object.
27740 * @param obj The segment control object.
27741 * @param icon The icon object to use for the left side of the item. An
27742 * icon can be any Evas object, but usually it is an icon created
27743 * with elm_icon_add().
27744 * @param label The label of the item.
27745 * Note that, NULL is different from empty string "".
27746 * @return The created item or @c NULL upon failure.
27748 * A new item will be created and appended to the segment control, i.e., will
27749 * be set as @b last item.
27751 * If it should be inserted at another position,
27752 * elm_segment_control_item_insert_at() should be used instead.
27754 * Items created with this function can be deleted with function
27755 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27757 * @note @p label set to @c NULL is different from empty string "".
27759 * only has icon, it will be displayed bigger and centered. If it has
27760 * icon and label, even that an empty string, icon will be smaller and
27761 * positioned at left.
27765 * sc = elm_segment_control_add(win);
27766 * ic = elm_icon_add(win);
27767 * elm_icon_file_set(ic, "path/to/image", NULL);
27768 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27769 * elm_segment_control_item_add(sc, ic, "label");
27770 * evas_object_show(sc);
27773 * @see elm_segment_control_item_insert_at()
27774 * @see elm_segment_control_item_del()
27776 * @ingroup SegmentControl
27778 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27781 * Insert a new item to the segment control object at specified position.
27783 * @param obj The segment control object.
27784 * @param icon The icon object to use for the left side of the item. An
27785 * icon can be any Evas object, but usually it is an icon created
27786 * with elm_icon_add().
27787 * @param label The label of the item.
27788 * @param index Item position. Value should be between 0 and items count.
27789 * @return The created item or @c NULL upon failure.
27791 * Index values must be between @c 0, when item will be prepended to
27792 * segment control, and items count, that can be get with
27793 * elm_segment_control_item_count_get(), case when item will be appended
27794 * to segment control, just like elm_segment_control_item_add().
27796 * Items created with this function can be deleted with function
27797 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27799 * @note @p label set to @c NULL is different from empty string "".
27801 * only has icon, it will be displayed bigger and centered. If it has
27802 * icon and label, even that an empty string, icon will be smaller and
27803 * positioned at left.
27805 * @see elm_segment_control_item_add()
27806 * @see elm_segment_control_item_count_get()
27807 * @see elm_segment_control_item_del()
27809 * @ingroup SegmentControl
27811 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);
27814 * Remove a segment control item from its parent, deleting it.
27816 * @param it The item to be removed.
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(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27826 * Remove a segment control item at given index from its parent,
27829 * @param obj The segment control object.
27830 * @param index The position of the segment control item to be deleted.
27832 * Items can be added with elm_segment_control_item_add() or
27833 * elm_segment_control_item_insert_at().
27835 * @ingroup SegmentControl
27837 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27840 * Get the Segment items count from segment control.
27842 * @param obj The segment control object.
27843 * @return Segment items count.
27845 * It will just return the number of items added to segment control @p obj.
27847 * @ingroup SegmentControl
27849 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27852 * Get the item placed at specified index.
27854 * @param obj The segment control object.
27855 * @param index The index of the segment item.
27856 * @return The segment control item or @c NULL on failure.
27858 * Index is the position of an item in segment control widget. Its
27859 * range is from @c 0 to <tt> count - 1 </tt>.
27860 * Count is the number of items, that can be get with
27861 * elm_segment_control_item_count_get().
27863 * @ingroup SegmentControl
27865 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27868 * Get the label of item.
27870 * @param obj The segment control object.
27871 * @param index The index of the segment item.
27872 * @return The label of the item at @p index.
27874 * The return value is a pointer to the label associated to the item when
27875 * it was created, with function elm_segment_control_item_add(), or later
27876 * with function elm_segment_control_item_label_set. If no label
27877 * was passed as argument, it will return @c NULL.
27879 * @see elm_segment_control_item_label_set() for more details.
27880 * @see elm_segment_control_item_add()
27882 * @ingroup SegmentControl
27884 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27887 * Set the label of item.
27889 * @param it The item of segment control.
27890 * @param text The label of item.
27892 * The label to be displayed by the item.
27893 * Label will be at right of the icon (if set).
27895 * If a label was passed as argument on item creation, with function
27896 * elm_control_segment_item_add(), it will be already
27897 * displayed by the item.
27899 * @see elm_segment_control_item_label_get()
27900 * @see elm_segment_control_item_add()
27902 * @ingroup SegmentControl
27904 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
27907 * Get the icon associated to the item.
27909 * @param obj The segment control object.
27910 * @param index The index of the segment item.
27911 * @return The left side icon associated to the item at @p index.
27913 * The return value is a pointer to the icon associated to the item when
27914 * it was created, with function elm_segment_control_item_add(), or later
27915 * with function elm_segment_control_item_icon_set(). If no icon
27916 * was passed as argument, it will return @c NULL.
27918 * @see elm_segment_control_item_add()
27919 * @see elm_segment_control_item_icon_set()
27921 * @ingroup SegmentControl
27923 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27926 * Set the icon associated to the item.
27928 * @param it The segment control item.
27929 * @param icon The icon object to associate with @p it.
27931 * The icon object to use at left side of the item. An
27932 * icon can be any Evas object, but usually it is an icon created
27933 * with elm_icon_add().
27935 * Once the icon object is set, a previously set one will be deleted.
27936 * @warning Setting the same icon for two items will cause the icon to
27937 * dissapear from the first item.
27939 * If an icon was passed as argument on item creation, with function
27940 * elm_segment_control_item_add(), it will be already
27941 * associated to the item.
27943 * @see elm_segment_control_item_add()
27944 * @see elm_segment_control_item_icon_get()
27946 * @ingroup SegmentControl
27948 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27951 * Get the index of an item.
27953 * @param it The segment control item.
27954 * @return The position of item in segment control widget.
27956 * Index is the position of an item in segment control widget. Its
27957 * range is from @c 0 to <tt> count - 1 </tt>.
27958 * Count is the number of items, that can be get with
27959 * elm_segment_control_item_count_get().
27961 * @ingroup SegmentControl
27963 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27966 * Get the base object of the item.
27968 * @param it The segment control item.
27969 * @return The base object associated with @p it.
27971 * Base object is the @c Evas_Object that represents that item.
27973 * @ingroup SegmentControl
27975 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27978 * Get the selected item.
27980 * @param obj The segment control object.
27981 * @return The selected item or @c NULL if none of segment items is
27984 * The selected item can be unselected with function
27985 * elm_segment_control_item_selected_set().
27987 * The selected item always will be highlighted on segment control.
27989 * @ingroup SegmentControl
27991 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27994 * Set the selected state of an item.
27996 * @param it The segment control item
27997 * @param select The selected state
27999 * This sets the selected state of the given item @p it.
28000 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
28002 * If a new item is selected the previosly selected will be unselected.
28003 * Previoulsy selected item can be get with function
28004 * elm_segment_control_item_selected_get().
28006 * The selected item always will be highlighted on segment control.
28008 * @see elm_segment_control_item_selected_get()
28010 * @ingroup SegmentControl
28012 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
28019 * @defgroup Grid Grid
28021 * The grid is a grid layout widget that lays out a series of children as a
28022 * fixed "grid" of widgets using a given percentage of the grid width and
28023 * height each using the child object.
28025 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
28026 * widgets size itself. The default is 100 x 100, so that means the
28027 * position and sizes of children will effectively be percentages (0 to 100)
28028 * of the width or height of the grid widget
28034 * Add a new grid to the parent
28036 * @param parent The parent object
28037 * @return The new object or NULL if it cannot be created
28041 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
28044 * Set the virtual size of the grid
28046 * @param obj The grid object
28047 * @param w The virtual width of the grid
28048 * @param h The virtual height of the grid
28052 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
28055 * Get the virtual size of the grid
28057 * @param obj The grid object
28058 * @param w Pointer to integer to store the virtual width of the grid
28059 * @param h Pointer to integer to store the virtual height of the grid
28063 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
28066 * Pack child at given position and size
28068 * @param obj The grid object
28069 * @param subobj The child to pack
28070 * @param x The virtual x coord at which to pack it
28071 * @param y The virtual y coord at which to pack it
28072 * @param w The virtual width at which to pack it
28073 * @param h The virtual height at which to pack it
28077 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
28080 * Unpack a child from a grid object
28082 * @param obj The grid object
28083 * @param subobj The child to unpack
28087 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
28090 * Faster way to remove all child objects from a grid object.
28092 * @param obj The grid object
28093 * @param clear If true, it will delete just removed children
28097 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28100 * Set packing of an existing child at to position and size
28102 * @param subobj The child to set packing of
28103 * @param x The virtual x coord at which to pack it
28104 * @param y The virtual y coord at which to pack it
28105 * @param w The virtual width at which to pack it
28106 * @param h The virtual height at which to pack it
28110 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28113 * get packing of a child
28115 * @param subobj The child to query
28116 * @param x Pointer to integer to store the virtual x coord
28117 * @param y Pointer to integer to store the virtual y coord
28118 * @param w Pointer to integer to store the virtual width
28119 * @param h Pointer to integer to store the virtual height
28123 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28129 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28130 EINA_DEPRECATED EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28131 EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28132 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28133 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
28134 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
28137 * @defgroup Video Video
28139 * @addtogroup Video
28142 * Elementary comes with two object that help design application that need
28143 * to display video. The main one, Elm_Video, display a video by using Emotion.
28144 * It does embedded the video inside an Edje object, so you can do some
28145 * animation depending on the video state change. It does also implement a
28146 * ressource management policy to remove this burden from the application writer.
28148 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28149 * It take care of updating its content according to Emotion event and provide a
28150 * way to theme itself. It also does automatically raise the priority of the
28151 * linked Elm_Video so it will use the video decoder if available. It also does
28152 * activate the remember function on the linked Elm_Video object.
28154 * Signals that you can add callback for are :
28156 * "forward,clicked" - the user clicked the forward button.
28157 * "info,clicked" - the user clicked the info button.
28158 * "next,clicked" - the user clicked the next button.
28159 * "pause,clicked" - the user clicked the pause button.
28160 * "play,clicked" - the user clicked the play button.
28161 * "prev,clicked" - the user clicked the prev button.
28162 * "rewind,clicked" - the user clicked the rewind button.
28163 * "stop,clicked" - the user clicked the stop button.
28165 * Default contents parts of the player widget that you can use for are:
28166 * @li "video" - A video of the player
28171 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28173 * @param parent The parent object
28174 * @return a new player widget handle or @c NULL, on errors.
28176 * This function inserts a new player widget on the canvas.
28178 * @see elm_object_part_content_set()
28182 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28185 * @brief Link a Elm_Payer with an Elm_Video object.
28187 * @param player the Elm_Player object.
28188 * @param video The Elm_Video object.
28190 * This mean that action on the player widget will affect the
28191 * video object and the state of the video will be reflected in
28192 * the player itself.
28194 * @see elm_player_add()
28195 * @see elm_video_add()
28196 * @deprecated use elm_object_part_content_set() instead
28200 EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28203 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28205 * @param parent The parent object
28206 * @return a new video widget handle or @c NULL, on errors.
28208 * This function inserts a new video widget on the canvas.
28210 * @seeelm_video_file_set()
28211 * @see elm_video_uri_set()
28215 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28218 * @brief Define the file that will be the video source.
28220 * @param video The video object to define the file for.
28221 * @param filename The file to target.
28223 * This function will explicitly define a filename as a source
28224 * for the video of the Elm_Video object.
28226 * @see elm_video_uri_set()
28227 * @see elm_video_add()
28228 * @see elm_player_add()
28232 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28235 * @brief Define the uri that will be the video source.
28237 * @param video The video object to define the file for.
28238 * @param uri The uri to target.
28240 * This function will define an uri as a source for the video of the
28241 * Elm_Video object. URI could be remote source of video, like http:// or local source
28242 * like for example WebCam who are most of the time v4l2:// (but that depend and
28243 * you should use Emotion API to request and list the available Webcam on your system).
28245 * @see elm_video_file_set()
28246 * @see elm_video_add()
28247 * @see elm_player_add()
28251 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28254 * @brief Get the underlying Emotion object.
28256 * @param video The video object to proceed the request on.
28257 * @return the underlying Emotion object.
28261 EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28264 * @brief Start to play the video
28266 * @param video The video object to proceed the request on.
28268 * Start to play the video and cancel all suspend state.
28272 EAPI void elm_video_play(Evas_Object *video);
28275 * @brief Pause the video
28277 * @param video The video object to proceed the request on.
28279 * Pause the video and start a timer to trigger suspend mode.
28283 EAPI void elm_video_pause(Evas_Object *video);
28286 * @brief Stop the video
28288 * @param video The video object to proceed the request on.
28290 * Stop the video and put the emotion in deep sleep mode.
28294 EAPI void elm_video_stop(Evas_Object *video);
28297 * @brief Is the video actually playing.
28299 * @param video The video object to proceed the request on.
28300 * @return EINA_TRUE if the video is actually playing.
28302 * You should consider watching event on the object instead of polling
28303 * the object state.
28307 EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28310 * @brief Is it possible to seek inside the video.
28312 * @param video The video object to proceed the request on.
28313 * @return EINA_TRUE if is possible to seek inside the video.
28317 EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28320 * @brief Is the audio muted.
28322 * @param video The video object to proceed the request on.
28323 * @return EINA_TRUE if the audio is muted.
28327 EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28330 * @brief Change the mute state of the Elm_Video object.
28332 * @param video The video object to proceed the request on.
28333 * @param mute The new mute state.
28337 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28340 * @brief Get the audio level of the current video.
28342 * @param video The video object to proceed the request on.
28343 * @return the current audio level.
28347 EAPI double elm_video_audio_level_get(const Evas_Object *video);
28350 * @brief Set the audio level of anElm_Video object.
28352 * @param video The video object to proceed the request on.
28353 * @param volume The new audio volume.
28357 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28359 EAPI double elm_video_play_position_get(const Evas_Object *video);
28360 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28361 EAPI double elm_video_play_length_get(const Evas_Object *video);
28362 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28363 EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28364 EAPI const char *elm_video_title_get(const Evas_Object *video);
28369 // FIXME: incomplete - carousel. don't use this until this comment is removed
28370 typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
28371 EAPI Evas_Object *elm_carousel_add(Evas_Object *parent);
28372 EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
28373 EAPI void elm_carousel_item_del(Elm_Carousel_Item *item);
28374 EAPI void elm_carousel_item_select(Elm_Carousel_Item *item);
28375 /* smart callbacks called:
28376 * "clicked" - when the user clicks on a carousel item and becomes selected
28381 typedef enum _Elm_Datefield_ItemType
28383 ELM_DATEFIELD_YEAR = 0,
28384 ELM_DATEFIELD_MONTH,
28385 ELM_DATEFIELD_DATE,
28386 ELM_DATEFIELD_HOUR,
28387 ELM_DATEFIELD_MINUTE,
28389 } Elm_Datefield_ItemType;
28391 EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
28392 EAPI void elm_datefield_format_set(Evas_Object *obj, const char *fmt);
28393 EAPI char *elm_datefield_format_get(const Evas_Object *obj);
28394 EAPI void elm_datefield_item_enabled_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, Eina_Bool enable);
28395 EAPI Eina_Bool elm_datefield_item_enabled_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28396 EAPI void elm_datefield_item_value_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value);
28397 EAPI int elm_datefield_item_value_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28398 EAPI void elm_datefield_item_min_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28399 EAPI int elm_datefield_item_min_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28400 EAPI Eina_Bool elm_datefield_item_min_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28401 EAPI void elm_datefield_item_max_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28402 EAPI int elm_datefield_item_max_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28403 EAPI Eina_Bool elm_datefield_item_max_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28405 /* smart callbacks called:
28406 * "changed" - when datefield value is changed, this signal is sent.
28409 ////////////////////// DEPRECATED ///////////////////////////////////
28411 typedef enum _Elm_Datefield_Layout
28413 ELM_DATEFIELD_LAYOUT_TIME,
28414 ELM_DATEFIELD_LAYOUT_DATE,
28415 ELM_DATEFIELD_LAYOUT_DATEANDTIME
28416 } Elm_Datefield_Layout;
28418 EINA_DEPRECATED EAPI void elm_datefield_layout_set(Evas_Object *obj, Elm_Datefield_Layout layout);
28419 EINA_DEPRECATED EAPI Elm_Datefield_Layout elm_datefield_layout_get(const Evas_Object *obj);
28420 EINA_DEPRECATED EAPI void elm_datefield_date_format_set(Evas_Object *obj, const char *fmt);
28421 EINA_DEPRECATED EAPI const char *elm_datefield_date_format_get(const Evas_Object *obj);
28422 EINA_DEPRECATED EAPI void elm_datefield_time_mode_set(Evas_Object *obj, Eina_Bool mode);
28423 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_time_mode_get(const Evas_Object *obj);
28424 EINA_DEPRECATED EAPI void elm_datefield_date_set(Evas_Object *obj, int year, int month, int day, int hour, int min);
28425 EINA_DEPRECATED EAPI void elm_datefield_date_get(const Evas_Object *obj, int *year, int *month, int *day, int *hour, int *min);
28426 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_max_set(Evas_Object *obj, int year, int month, int day);
28427 EINA_DEPRECATED EAPI void elm_datefield_date_max_get(const Evas_Object *obj, int *year, int *month, int *day);
28428 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_min_set(Evas_Object *obj, int year, int month, int day);
28429 EINA_DEPRECATED EAPI void elm_datefield_date_min_get(const Evas_Object *obj, int *year, int *month, int *day);
28430 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);
28431 EINA_DEPRECATED EAPI void elm_datefield_input_panel_state_callback_del(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value));
28432 /////////////////////////////////////////////////////////////////////
28435 typedef enum _Elm_Popup_Response
28437 ELM_POPUP_RESPONSE_NONE = -1,
28438 ELM_POPUP_RESPONSE_TIMEOUT = -2,
28439 ELM_POPUP_RESPONSE_OK = -3,
28440 ELM_POPUP_RESPONSE_CANCEL = -4,
28441 ELM_POPUP_RESPONSE_CLOSE = -5
28442 } Elm_Popup_Response;
28444 typedef enum _Elm_Popup_Mode
28446 ELM_POPUP_TYPE_NONE = 0,
28447 ELM_POPUP_TYPE_ALERT = (1 << 0)
28450 typedef enum _Elm_Popup_Orient
28452 ELM_POPUP_ORIENT_TOP,
28453 ELM_POPUP_ORIENT_CENTER,
28454 ELM_POPUP_ORIENT_BOTTOM,
28455 ELM_POPUP_ORIENT_LEFT,
28456 ELM_POPUP_ORIENT_RIGHT,
28457 ELM_POPUP_ORIENT_TOP_LEFT,
28458 ELM_POPUP_ORIENT_TOP_RIGHT,
28459 ELM_POPUP_ORIENT_BOTTOM_LEFT,
28460 ELM_POPUP_ORIENT_BOTTOM_RIGHT
28461 } Elm_Popup_Orient;
28463 /* smart callbacks called:
28464 * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
28467 EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
28468 EAPI void elm_popup_desc_set(Evas_Object *obj, const char *text);
28469 EAPI const char *elm_popup_desc_get(Evas_Object *obj);
28470 EAPI void elm_popup_title_label_set(Evas_Object *obj, const char *text);
28471 EAPI const char *elm_popup_title_label_get(Evas_Object *obj);
28472 EAPI void elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
28473 EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
28474 EAPI void elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
28475 EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
28476 EAPI void elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text, ...);
28477 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, ... );
28478 EAPI void elm_popup_timeout_set(Evas_Object *obj, double timeout);
28479 EAPI void elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
28480 EAPI void elm_popup_response(Evas_Object *obj, int response_id);
28481 EAPI void elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
28482 EAPI int elm_popup_run(Evas_Object *obj);
28484 /* NavigationBar */
28485 #define NAVIBAR_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28486 #define NAVIBAR_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28490 ELM_NAVIGATIONBAR_FUNCTION_BUTTON1,
28491 ELM_NAVIGATIONBAR_FUNCTION_BUTTON2,
28492 ELM_NAVIGATIONBAR_FUNCTION_BUTTON3,
28493 ELM_NAVIGATIONBAR_BACK_BUTTON
28494 } Elm_Navi_Button_Type;
28496 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_add(Evas_Object *parent);
28497 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);
28498 EINA_DEPRECATED EAPI void elm_navigationbar_pop(Evas_Object *obj);
28499 EINA_DEPRECATED EAPI void elm_navigationbar_to_content_pop(Evas_Object *obj, Evas_Object *content);
28500 EINA_DEPRECATED EAPI void elm_navigationbar_title_label_set(Evas_Object *obj, Evas_Object *content, const char *title);
28501 EINA_DEPRECATED EAPI const char *elm_navigationbar_title_label_get(Evas_Object *obj, Evas_Object *content);
28502 EINA_DEPRECATED EAPI void elm_navigationbar_title_object_add(Evas_Object *obj, Evas_Object *content, Evas_Object *title_obj);
28503 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_title_object_get(Evas_Object *obj, Evas_Object *content);
28504 EINA_DEPRECATED EAPI Eina_List *elm_navigationbar_title_object_list_get(Evas_Object *obj, Evas_Object *content);
28505 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_content_top_get(Evas_Object *obj);
28506 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_content_bottom_get(Evas_Object *obj);
28507 EINA_DEPRECATED EAPI void elm_navigationbar_hidden_set(Evas_Object *obj, Eina_Bool hidden);
28508 EINA_DEPRECATED EAPI void elm_navigationbar_title_button_set(Evas_Object *obj, Evas_Object *content, Evas_Object *button, Elm_Navi_Button_Type button_type);
28509 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_title_button_get(Evas_Object *obj, Evas_Object *content, Elm_Navi_Button_Type button_type);
28510 EINA_DEPRECATED EAPI const char *elm_navigationbar_subtitle_label_get(Evas_Object *obj, Evas_Object *content);
28511 EINA_DEPRECATED EAPI void elm_navigationbar_subtitle_label_set(Evas_Object *obj, Evas_Object *content, const char *subtitle);
28512 EINA_DEPRECATED EAPI void elm_navigationbar_title_object_list_unset(Evas_Object *obj, Evas_Object *content, Eina_List **list);
28513 EINA_DEPRECATED EAPI void elm_navigationbar_animation_disabled_set(Evas_Object *obj, Eina_Bool disable);
28514 EINA_DEPRECATED EAPI void elm_navigationbar_title_object_visible_set(Evas_Object *obj, Evas_Object *content, Eina_Bool visible);
28515 EINA_DEPRECATED Eina_Bool elm_navigationbar_title_object_visible_get(Evas_Object *obj, Evas_Object *content);
28516 EINA_DEPRECATED EAPI void elm_navigationbar_title_icon_set(Evas_Object *obj, Evas_Object *content, Evas_Object *icon);
28517 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_title_icon_get(Evas_Object *obj, Evas_Object *content);
28519 /* NavigationBar */
28520 #define NAVIBAR_EX_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28521 #define NAVIBAR_EX_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28525 ELM_NAVIGATIONBAR_EX_BACK_BUTTON,
28526 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON1,
28527 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON2,
28528 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON3,
28529 ELM_NAVIGATIONBAR_EX_MAX
28530 } Elm_Navi_ex_Button_Type;
28531 typedef struct _Elm_Navigationbar_ex_Item Elm_Navigationbar_ex_Item;
28533 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_add(Evas_Object *parent);
28534 EINA_DEPRECATED EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_push(Evas_Object *obj, Evas_Object *content, const char *item_style);
28535 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_pop(Evas_Object *obj);
28536 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_promote(Elm_Navigationbar_ex_Item* item);
28537 EINA_DEPRECATED EAPI void elm_navigationbar_ex_to_item_pop(Elm_Navigationbar_ex_Item* item);
28538 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_title_label_set(Elm_Navigationbar_ex_Item *item, const char *title);
28539 EINA_DEPRECATED EAPI const char *elm_navigationbar_ex_item_title_label_get(Elm_Navigationbar_ex_Item* item);
28540 EINA_DEPRECATED EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_top_get(const Evas_Object *obj);
28541 EINA_DEPRECATED EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_bottom_get(const Evas_Object *obj);
28542 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);
28543 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_title_button_get(Elm_Navigationbar_ex_Item* item, int button_type);
28544 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_title_object_set(Elm_Navigationbar_ex_Item* item, Evas_Object *title_obj);
28545 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_title_object_unset(Elm_Navigationbar_ex_Item* item);
28546 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_title_hidden_set(Elm_Navigationbar_ex_Item* item, Eina_Bool hidden);
28547 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_title_object_get(Elm_Navigationbar_ex_Item* item);
28548 EINA_DEPRECATED EAPI const char *elm_navigationbar_ex_item_subtitle_label_get(Elm_Navigationbar_ex_Item* item);
28549 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_subtitle_label_set( Elm_Navigationbar_ex_Item* item, const char *subtitle);
28550 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_style_set(Elm_Navigationbar_ex_Item* item, const char* item_style);
28551 EINA_DEPRECATED EAPI const char *elm_navigationbar_ex_item_style_get(Elm_Navigationbar_ex_Item* item);
28552 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_content_unset(Elm_Navigationbar_ex_Item* item);
28553 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_content_get(Elm_Navigationbar_ex_Item* item);
28554 EINA_DEPRECATED EAPI void elm_navigationbar_ex_delete_on_pop_set(Evas_Object *obj, Eina_Bool del_on_pop);
28555 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_icon_get(Elm_Navigationbar_ex_Item* item);
28556 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_icon_set(Elm_Navigationbar_ex_Item* item, Evas_Object *icon);
28557 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_title_button_unset(Elm_Navigationbar_ex_Item* item, int button_type);
28558 EINA_DEPRECATED EAPI void elm_navigationbar_ex_animation_disable_set(Evas_Object *obj, Eina_Bool disable);
28559 EINA_DEPRECATED EAPI void elm_navigationbar_ex_title_object_visible_set(Elm_Navigationbar_ex_Item* item, Eina_Bool visible);
28560 EINA_DEPRECATED Eina_Bool elm_navigationbar_ex_title_object_visible_get(Elm_Navigationbar_ex_Item* item);
28563 * @defgroup Naviframe Naviframe
28564 * @ingroup Elementary
28566 * @brief Naviframe is a kind of view manager for the applications.
28568 * Naviframe provides functions to switch different pages with stack
28569 * mechanism. It means if one page(item) needs to be changed to the new one,
28570 * then naviframe would push the new page to it's internal stack. Of course,
28571 * it can be back to the previous page by popping the top page. Naviframe
28572 * provides some transition effect while the pages are switching (same as
28575 * Since each item could keep the different styles, users could keep the
28576 * same look & feel for the pages or different styles for the items in it's
28579 * Signals that you can add callback for are:
28580 * @li "transition,finished" - When the transition is finished in changing
28582 * @li "title,clicked" - User clicked title area
28584 * Default contents parts of the naviframe items that you can use for are:
28585 * @li "default" - A main content of the page
28586 * @li "icon" - A icon in the title area
28587 * @li "prev_btn" - A button to go to the previous page
28588 * @li "next_btn" - A button to go to the next page
28590 * Default text parts of the naviframe items that you can use for are:
28591 * @li "default" - Title label in the title area
28592 * @li "subtitle" - Sub-title label in the title area
28594 * @ref tutorial_naviframe gives a good overview of the usage of the API.
28597 //Available commonly
28598 #define ELM_NAVIFRAME_ITEM_CONTENT "elm.swallow.content"
28599 #define ELM_NAVIFRAME_ITEM_ICON "elm.swallow.icon"
28600 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER "elm.swallow.optionheader"
28601 #define ELM_NAVIFRAME_ITEM_TITLE_LABEL "elm.text.title"
28602 #define ELM_NAVIFRAME_ITEM_PREV_BTN "elm.swallow.prev_btn"
28603 #define ELM_NAVIFRAME_ITEM_TITLE_LEFT_BTN "elm.swallow.left_btn"
28604 #define ELM_NAVIFRAME_ITEM_TITLE_RIGHT_BTN "elm.swallow.right_btn"
28605 #define ELM_NAVIFRAME_ITEM_TITLE_MORE_BTN "elm.swallow.more_btn"
28606 #define ELM_NAVIFRAME_ITEM_CONTROLBAR "elm.swallow.controlbar"
28607 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_CLOSE "elm,state,optionheader,close", ""
28608 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_OPEN "elm,state,optionheader,open", ""
28609 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_CLOSE "elm,state,optionheader,instant_close", ""
28610 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_OPEN "elm,state,optionheader,instant_open", ""
28611 #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_CLOSE "elm,state,controlbar,close", ""
28612 #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_OPEN "elm,state,controlbar,open", ""
28613 #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_INSTANT_CLOSE "elm,state,controlbar,instant_close", ""
28614 #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_INSTANT_OPEN "elm,state,controlbar,instant_open", ""
28616 //Available only in a style - "2line"
28617 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER2 "elm.swallow.optionheader2"
28619 //Available only in a style - "segment"
28620 #define ELM_NAVIFRAME_ITEM_SEGMENT2 "elm.swallow.segment2"
28621 #define ELM_NAVIFRAME_ITEM_SEGMENT3 "elm.swallow.segment3"
28624 * @addtogroup Naviframe
28629 * @brief Add a new Naviframe object to the parent.
28631 * @param parent Parent object
28632 * @return New object or @c NULL, if it cannot be created
28634 * @ingroup Naviframe
28636 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28638 * @brief Push a new item to the top of the naviframe stack (and show it).
28640 * @param obj The naviframe object
28641 * @param title_label The label in the title area. The name of the title
28642 * label part is "elm.text.title"
28643 * @param prev_btn The button to go to the previous item. If it is NULL,
28644 * then naviframe will create a back button automatically. The name of
28645 * the prev_btn part is "elm.swallow.prev_btn"
28646 * @param next_btn The button to go to the next item. Or It could be just an
28647 * extra function button. The name of the next_btn part is
28648 * "elm.swallow.next_btn"
28649 * @param content The main content object. The name of content part is
28650 * "elm.swallow.content"
28651 * @param item_style The current item style name. @c NULL would be default.
28652 * @return The created item or @c NULL upon failure.
28654 * The item pushed becomes one page of the naviframe, this item will be
28655 * deleted when it is popped.
28657 * @see also elm_naviframe_item_style_set()
28658 * @see also elm_naviframe_item_insert_before()
28659 * @see also elm_naviframe_item_insert_after()
28661 * The following styles are available for this item:
28664 * @ingroup Naviframe
28666 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);
28668 * @brief Insert a new item into the naviframe before item @p before.
28670 * @param before The naviframe item to insert before.
28671 * @param title_label The label in the title area. The name of the title
28672 * label part is "elm.text.title"
28673 * @param prev_btn The button to go to the previous item. If it is NULL,
28674 * then naviframe will create a back button automatically. The name of
28675 * the prev_btn part is "elm.swallow.prev_btn"
28676 * @param next_btn The button to go to the next item. Or It could be just an
28677 * extra function button. The name of the next_btn part is
28678 * "elm.swallow.next_btn"
28679 * @param content The main content object. The name of content part is
28680 * "elm.swallow.content"
28681 * @param item_style The current item style name. @c NULL would be default.
28682 * @return The created item or @c NULL upon failure.
28684 * The item is inserted into the naviframe straight away without any
28685 * transition operations. This item will be deleted when it is popped.
28687 * @see also elm_naviframe_item_style_set()
28688 * @see also elm_naviframe_item_push()
28689 * @see also elm_naviframe_item_insert_after()
28691 * The following styles are available for this item:
28694 * @ingroup Naviframe
28696 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);
28698 * @brief Insert a new item into the naviframe after item @p after.
28700 * @param after The naviframe item to insert after.
28701 * @param title_label The label in the title area. The name of the title
28702 * label part is "elm.text.title"
28703 * @param prev_btn The button to go to the previous item. If it is NULL,
28704 * then naviframe will create a back button automatically. The name of
28705 * the prev_btn part is "elm.swallow.prev_btn"
28706 * @param next_btn The button to go to the next item. Or It could be just an
28707 * extra function button. The name of the next_btn part is
28708 * "elm.swallow.next_btn"
28709 * @param content The main content object. The name of content part is
28710 * "elm.swallow.content"
28711 * @param item_style The current item style name. @c NULL would be default.
28712 * @return The created item or @c NULL upon failure.
28714 * The item is inserted into the naviframe straight away without any
28715 * transition operations. This item will be deleted when it is popped.
28717 * @see also elm_naviframe_item_style_set()
28718 * @see also elm_naviframe_item_push()
28719 * @see also elm_naviframe_item_insert_before()
28721 * The following styles are available for this item:
28724 * @ingroup Naviframe
28726 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);
28728 * @brief Pop an item that is on top of the stack
28730 * @param obj The naviframe object
28731 * @return @c NULL or the content object(if the
28732 * elm_naviframe_content_preserve_on_pop_get is true).
28734 * This pops an item that is on the top(visible) of the naviframe, makes it
28735 * disappear, then deletes the item. The item that was underneath it on the
28736 * stack will become visible.
28738 * @see also elm_naviframe_content_preserve_on_pop_get()
28740 * @ingroup Naviframe
28742 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28744 * @brief Pop the items between the top and the above one on the given item.
28746 * @param it The naviframe item
28748 * @ingroup Naviframe
28750 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28752 * Promote an item already in the naviframe stack to the top of the stack
28754 * @param it The naviframe item
28756 * This will take the indicated item and promote it to the top of the stack
28757 * as if it had been pushed there. The item must already be inside the
28758 * naviframe stack to work.
28761 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28763 * @brief Delete the given item instantly.
28765 * @param it The naviframe item
28767 * This just deletes the given item from the naviframe item list instantly.
28768 * So this would not emit any signals for view transitions but just change
28769 * the current view if the given item is a top one.
28771 * @ingroup Naviframe
28773 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28775 * @brief preserve the content objects when items are popped.
28777 * @param obj The naviframe object
28778 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28780 * @see also elm_naviframe_content_preserve_on_pop_get()
28782 * @ingroup Naviframe
28784 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28786 * @brief Get a value whether preserve mode is enabled or not.
28788 * @param obj The naviframe object
28789 * @return If @c EINA_TRUE, preserve mode is enabled
28791 * @see also elm_naviframe_content_preserve_on_pop_set()
28793 * @ingroup Naviframe
28795 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28797 * @brief Get a top item on the naviframe stack
28799 * @param obj The naviframe object
28800 * @return The top item on the naviframe stack or @c NULL, if the stack is
28803 * @ingroup Naviframe
28805 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28807 * @brief Get a bottom item on the naviframe stack
28809 * @param obj The naviframe object
28810 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28813 * @ingroup Naviframe
28815 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28817 * @brief Set an item style
28819 * @param obj The naviframe item
28820 * @param item_style The current item style name. @c NULL would be default
28822 * The following styles are available for this item:
28825 * @see also elm_naviframe_item_style_get()
28827 * @ingroup Naviframe
28829 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28831 * @brief Get an item style
28833 * @param obj The naviframe item
28834 * @return The current item style name
28836 * @see also elm_naviframe_item_style_set()
28838 * @ingroup Naviframe
28840 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28842 * @brief Show/Hide the title area
28844 * @param it The naviframe item
28845 * @param visible If @c EINA_TRUE, title area will be visible, hidden
28848 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
28850 * @see also elm_naviframe_item_title_visible_get()
28852 * @ingroup Naviframe
28854 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28856 * @brief Get a value whether title area is visible or not.
28858 * @param it The naviframe item
28859 * @return If @c EINA_TRUE, title area is visible
28861 * @see also elm_naviframe_item_title_visible_set()
28863 * @ingroup Naviframe
28865 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28868 * @brief Set creating prev button automatically or not
28870 * @param obj The naviframe object
28871 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28872 * be created internally when you pass the @c NULL to the prev_btn
28873 * parameter in elm_naviframe_item_push
28875 * @see also elm_naviframe_item_push()
28877 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28879 * @brief Get a value whether prev button(back button) will be auto pushed or
28882 * @param obj The naviframe object
28883 * @return If @c EINA_TRUE, prev button will be auto pushed.
28885 * @see also elm_naviframe_item_push()
28886 * elm_naviframe_prev_btn_auto_pushed_set()
28888 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28890 * @brief Get a list of all the naviframe items.
28892 * @param obj The naviframe object
28893 * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
28894 * or @c NULL on failure.
28896 EAPI Eina_Inlist *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28903 #define CONTROLBAR_SYSTEM_ICON_ALBUMS "controlbar_albums"
28904 #define CONTROLBAR_SYSTEM_ICON_ARTISTS "controlbar_artists"
28905 #define CONTROLBAR_SYSTEM_ICON_SONGS "controlbar_songs"
28906 #define CONTROLBAR_SYSTEM_ICON_PLAYLIST "controlbar_playlist"
28907 #define CONTROLBAR_SYSTEM_ICON_MORE "controlbar_more"
28908 #define CONTROLBAR_SYSTEM_ICON_CONTACTS "controlbar_contacts"
28909 #define CONTROLBAR_SYSTEM_ICON_DIALER "controlbar_dialer"
28910 #define CONTROLBAR_SYSTEM_ICON_FAVORITES "controlbar_favorites"
28911 #define CONTROLBAR_SYSTEM_ICON_LOGS "controlbar_logs"
28913 typedef enum _Elm_Controlbar_Mode_Type
28915 ELM_CONTROLBAR_MODE_DEFAULT = 0,
28916 ELM_CONTROLBAR_MODE_TRANSLUCENCE,
28917 ELM_CONTROLBAR_MODE_TRANSPARENCY,
28918 ELM_CONTROLBAR_MODE_LARGE,
28919 ELM_CONTROLBAR_MODE_SMALL,
28920 ELM_CONTROLBAR_MODE_LEFT,
28921 ELM_CONTROLBAR_MODE_RIGHT
28922 } Elm_Controlbar_Mode_Type;
28924 typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
28925 EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
28926 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
28927 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
28928 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);
28929 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);
28930 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);
28931 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);
28932 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);
28933 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);
28934 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
28935 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
28936 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
28937 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
28938 EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
28939 EAPI void elm_controlbar_item_del(Elm_Controlbar_Item *it);
28940 EAPI void elm_controlbar_item_select(Elm_Controlbar_Item *it);
28941 EAPI void elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
28942 EAPI Eina_Bool elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
28943 EAPI void elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
28944 EAPI Eina_Bool elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
28945 EAPI void elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
28946 EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
28947 EAPI void elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
28948 EAPI const char *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
28949 EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
28950 EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
28951 EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
28952 EAPI const Eina_List *elm_controlbar_items_get(const Evas_Object *obj);
28953 EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
28954 EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
28955 EAPI void elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
28956 EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
28957 EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
28958 EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
28959 EAPI void elm_controlbar_mode_set(Evas_Object *obj, int mode);
28960 EAPI void elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
28961 EAPI void elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
28962 EAPI void elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
28965 EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
28966 EAPI void elm_searchbar_text_set(Evas_Object *obj, const char *entry);
28967 EAPI const char *elm_searchbar_text_get(Evas_Object *obj);
28968 EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
28969 EAPI Evas_Object *elm_searchbar_editfield_get(Evas_Object *obj);
28970 EAPI void elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
28971 EAPI void elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
28972 EAPI void elm_searchbar_clear(Evas_Object *obj);
28973 EAPI void elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);
28975 EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
28976 EAPI void elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
28977 EAPI void elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
28978 EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
28981 EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
28982 EAPI void elm_nocontents_label_set(Evas_Object *obj, const char *label);
28983 EAPI const char *elm_nocontents_label_get(const Evas_Object *obj);
28984 EAPI void elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
28985 EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
28990 ELM_TICKERNOTI_ORIENT_TOP = 0,
28991 ELM_TICKERNOTI_ORIENT_BOTTOM,
28992 ELM_TICKERNOTI_ORIENT_LAST
28993 } Elm_Tickernoti_Orient;
28995 EAPI Evas_Object *elm_tickernoti_add (Evas_Object *parent);
28996 EAPI void elm_tickernoti_orient_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
28997 EAPI Elm_Tickernoti_Orient elm_tickernoti_orient_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28998 EAPI int elm_tickernoti_rotation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28999 EAPI void elm_tickernoti_rotation_set (Evas_Object *obj, int angle) EINA_ARG_NONNULL(1);
29000 EAPI Evas_Object *elm_tickernoti_win_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29001 /* #### Below APIs and data structures are going to be deprecated, announcment will be made soon ####*/
29004 ELM_TICKERNOTI_DEFAULT,
29005 ELM_TICKERNOTI_DETAILVIEW
29006 } Elm_Tickernoti_Mode;
29007 EAPI void elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
29008 EAPI const char *elm_tickernoti_detailview_label_get (const Evas_Object *obj)EINA_ARG_NONNULL(1);
29009 EAPI void elm_tickernoti_detailview_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(2);
29010 EAPI Evas_Object *elm_tickernoti_detailview_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29011 EAPI void elm_tickernoti_detailview_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
29012 EAPI Evas_Object *elm_tickernoti_detailview_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29013 EAPI Evas_Object *elm_tickernoti_detailview_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29014 EAPI void elm_tickernoti_mode_set (Evas_Object *obj, Elm_Tickernoti_Mode mode) EINA_ARG_NONNULL(1);
29015 EAPI Elm_Tickernoti_Mode elm_tickernoti_mode_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29016 EAPI void elm_tickernoti_orientation_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
29017 EAPI Elm_Tickernoti_Orient elm_tickernoti_orientation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29018 EAPI void elm_tickernoti_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
29019 EAPI const char *elm_tickernoti_label_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29020 EAPI void elm_tickernoti_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
29021 EAPI Evas_Object *elm_tickernoti_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29022 EAPI void elm_tickernoti_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(1);
29023 EAPI Evas_Object *elm_tickernoti_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29024 /* ############################################################################### */
29026 * Parts which can be used with elm_object_text_part_set() and
29027 * elm_object_text_part_get():
29029 * @li NULL/"default" - Operates on tickernoti content-text
29031 * Parts which can be used with elm_object_content_part_set(),
29032 * elm_object_content_part_get() and elm_object_content_part_unset():
29034 * @li "icon" - Operates on tickernoti's icon
29035 * @li "button" - Operates on tickernoti's button
29037 * smart callbacks called:
29038 * @li "clicked" - emitted when tickernoti is clicked, except at the
29039 * swallow/button region, if any.
29040 * @li "hide" - emitted when the tickernoti is completely hidden. In case of
29041 * any hide animation, this signal is emitted after the animation.
29045 typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
29047 struct _Colorpalette_Color
29049 unsigned int r, g, b;
29052 EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
29053 EAPI void elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
29054 EAPI void elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
29055 /* smart callbacks called:
29056 * "clicked" - when image clicked
29060 EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
29061 EAPI void elm_editfield_label_set(Evas_Object *obj, const char *label);
29062 EAPI const char *elm_editfield_label_get(Evas_Object *obj);
29063 EAPI void elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
29064 EAPI const char *elm_editfield_guide_text_get(Evas_Object *obj);
29065 EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
29066 // EAPI Evas_Object *elm_editfield_clear_button_show(Evas_Object *obj, Eina_Bool show);
29067 EAPI void elm_editfield_right_icon_set(Evas_Object *obj, Evas_Object *icon);
29068 EAPI Evas_Object *elm_editfield_right_icon_get(Evas_Object *obj);
29069 EAPI void elm_editfield_left_icon_set(Evas_Object *obj, Evas_Object *icon);
29070 EAPI Evas_Object *elm_editfield_left_icon_get(Evas_Object *obj);
29071 EAPI void elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
29072 EAPI Eina_Bool elm_editfield_entry_single_line_get(Evas_Object *obj);
29073 EAPI void elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
29074 EAPI Eina_Bool elm_editfield_eraser_get(Evas_Object *obj);
29075 /* smart callbacks called:
29076 * "clicked" - when an editfield is clicked
29077 * "unfocused" - when an editfield is unfocused
29081 /* Sliding Drawer */
29082 typedef enum _Elm_SlidingDrawer_Pos
29084 ELM_SLIDINGDRAWER_BOTTOM,
29085 ELM_SLIDINGDRAWER_LEFT,
29086 ELM_SLIDINGDRAWER_RIGHT,
29087 ELM_SLIDINGDRAWER_TOP
29088 } Elm_SlidingDrawer_Pos;
29090 typedef struct _Elm_SlidingDrawer_Drag_Value
29093 } Elm_SlidingDrawer_Drag_Value;
29095 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_add(Evas_Object *parent);
29096 EINA_DEPRECATED EAPI void elm_slidingdrawer_content_set (Evas_Object *obj, Evas_Object *content);
29097 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_content_unset(Evas_Object *obj);
29098 EINA_DEPRECATED EAPI void elm_slidingdrawer_pos_set(Evas_Object *obj, Elm_SlidingDrawer_Pos pos);
29099 EINA_DEPRECATED EAPI void elm_slidingdrawer_max_drag_value_set(Evas_Object *obj, double dw, double dh);
29100 EINA_DEPRECATED EAPI void elm_slidingdrawer_drag_value_set(Evas_Object *obj, double dx, double dy);
29102 /* multibuttonentry */
29103 typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
29104 typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
29105 EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent);
29106 EAPI const char *elm_multibuttonentry_label_get(const Evas_Object *obj);
29107 EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
29108 EAPI Evas_Object *elm_multibuttonentry_entry_get(const Evas_Object *obj);
29109 EAPI const char * elm_multibuttonentry_guide_text_get(const Evas_Object *obj);
29110 EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
29111 EAPI int elm_multibuttonentry_contracted_state_get(const Evas_Object *obj);
29112 EAPI void elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
29113 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
29114 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
29115 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
29116 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
29117 EAPI const Eina_List *elm_multibuttonentry_items_get(const Evas_Object *obj);
29118 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(const Evas_Object *obj);
29119 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(const Evas_Object *obj);
29120 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(const Evas_Object *obj);
29121 EAPI void elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
29122 EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
29123 EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
29124 EAPI void elm_multibuttonentry_items_del(Evas_Object *obj);
29125 EAPI const char *elm_multibuttonentry_item_label_get(const Elm_Multibuttonentry_Item *item);
29126 EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
29127 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
29128 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
29129 EAPI void *elm_multibuttonentry_item_data_get(const Elm_Multibuttonentry_Item *item);
29130 EAPI void elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
29131 EAPI void elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
29132 /* smart callback called:
29133 * "selected" - This signal is emitted when the selected item of multibuttonentry is changed.
29134 * "added" - This signal is emitted when a new multibuttonentry item is added.
29135 * "deleted" - This signal is emitted when a multibuttonentry item is deleted.
29136 * "expanded" - This signal is emitted when a multibuttonentry is expanded.
29137 * "contracted" - This signal is emitted when a multibuttonentry is contracted.
29138 * "contracted,state,changed" - This signal is emitted when the contracted state of multibuttonentry is changed.
29139 * "item,selected" - This signal is emitted when the selected item of multibuttonentry is changed.
29140 * "item,added" - This signal is emitted when a new multibuttonentry item is added.
29141 * "item,deleted" - This signal is emitted when a multibuttonentry item is deleted.
29142 * "item,clicked" - This signal is emitted when a multibuttonentry item is clicked.
29143 * "clicked" - This signal is emitted when a multibuttonentry is clicked.
29144 * "unfocused" - This signal is emitted when a multibuttonentry is unfocused.
29146 /* available styles:
29151 typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
29152 EAPI Evas_Object *elm_stackedicon_add(Evas_Object *parent);
29153 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
29154 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
29155 EAPI void elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
29156 EAPI Eina_List *elm_stackedicon_item_list_get(Evas_Object *obj);
29157 /* smart callback called:
29158 * "expanded" - This signal is emitted when a stackedicon is expanded.
29159 * "clicked" - This signal is emitted when a stackedicon is clicked.
29161 /* available styles:
29165 /* dialoguegroup */
29166 typedef struct _Dialogue_Item Dialogue_Item;
29168 typedef enum _Elm_Dialoguegourp_Item_Style
29170 ELM_DIALOGUEGROUP_ITEM_STYLE_DEFAULT = 0,
29171 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD = (1 << 0),
29172 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD_WITH_TITLE = (1 << 1),
29173 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_TITLE = (1 << 2),
29174 ELM_DIALOGUEGROUP_ITEM_STYLE_HIDDEN = (1 << 3),
29175 ELM_DIALOGUEGROUP_ITEM_STYLE_DATAVIEW = (1 << 4),
29176 ELM_DIALOGUEGROUP_ITEM_STYLE_NO_BG = (1 << 5),
29177 ELM_DIALOGUEGROUP_ITEM_STYLE_SUB = (1 << 6),
29178 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT = (1 << 7),
29179 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_MERGE = (1 << 8),
29180 ELM_DIALOGUEGROUP_ITEM_STYLE_LAST = (1 << 9)
29181 } Elm_Dialoguegroup_Item_Style;
29183 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_add(Evas_Object *parent);
29184 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_append(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
29185 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_prepend(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
29186 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_after(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *after, Elm_Dialoguegroup_Item_Style style);
29187 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_before(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *before, Elm_Dialoguegroup_Item_Style style);
29188 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove(Dialogue_Item *item);
29189 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove_all(Evas_Object *obj);
29190 EINA_DEPRECATED EAPI void elm_dialoguegroup_title_set(Evas_Object *obj, const char *title);
29191 EINA_DEPRECATED EAPI const char *elm_dialoguegroup_title_get(Evas_Object *obj);
29192 EINA_DEPRECATED EAPI void elm_dialoguegroup_press_effect_set(Dialogue_Item *item, Eina_Bool press);
29193 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_press_effect_get(Dialogue_Item *item);
29194 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_item_content_get(Dialogue_Item *item);
29195 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_style_set(Dialogue_Item *item, Elm_Dialoguegroup_Item_Style style);
29196 EINA_DEPRECATED EAPI Elm_Dialoguegroup_Item_Style elm_dialoguegroup_item_style_get(Dialogue_Item *item);
29197 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_disabled_set(Dialogue_Item *item, Eina_Bool disabled);
29198 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_item_disabled_get(Dialogue_Item *item);
29203 ELM_DAYSELECTOR_SUN,
29204 ELM_DAYSELECTOR_MON,
29205 ELM_DAYSELECTOR_TUE,
29206 ELM_DAYSELECTOR_WED,
29207 ELM_DAYSELECTOR_THU,
29208 ELM_DAYSELECTOR_FRI,
29209 ELM_DAYSELECTOR_SAT
29210 } Elm_DaySelector_Day;
29212 EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
29213 EAPI Eina_Bool elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
29214 EAPI void elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
29217 typedef struct _Imageslider_Item Elm_Imageslider_Item;
29218 typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
29219 EAPI Evas_Object *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
29220 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);
29221 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);
29222 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);
29223 EAPI void elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29224 EAPI Elm_Imageslider_Item *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
29225 EAPI Eina_Bool elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29226 EAPI void elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29227 EAPI const char *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29228 EAPI Elm_Imageslider_Item *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29229 EAPI Elm_Imageslider_Item *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29230 EAPI void elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
29231 EAPI void elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
29232 EAPI void elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
29233 EAPI void elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);