3 * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
8 @brief Elementary Widget Library
13 @image html elementary.png
17 @section intro What is Elementary?
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
22 It is meant to make the programmers work almost brainless but give them lots
25 @li @ref Start - Go here to quickly get started with writing Apps
27 @section organization Organization
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers which hold the widgets.
34 @section license License
36 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
37 all files in the source tree.
39 @section ack Acknowledgements
40 There is a lot that goes into making a widget set, and they don't happen out of
41 nothing. It's like trying to make everyone everywhere happy, regardless of age,
42 gender, race or nationality - and that is really tough. So thanks to people and
43 organisations behind this, as listed in the @ref authors page.
48 * @defgroup Start Getting Started
50 * To write an Elementary app, you can get started with the following:
53 #include <Elementary.h>
55 elm_main(int argc, char **argv)
57 // create window(s) here and do any application init
58 elm_run(); // run main loop
59 elm_shutdown(); // after mainloop finishes running, shutdown
60 return 0; // exit 0 for exit code
65 * To use autotools (which helps in many ways in the long run, like being able
66 * to immediately create releases of your software directly from your tree
67 * and ensure everything needed to build it is there) you will need a
68 * configure.ac, Makefile.am and autogen.sh file.
73 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
75 AC_CONFIG_SRCDIR(configure.ac)
76 AM_CONFIG_HEADER(config.h)
78 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
79 PKG_CHECK_MODULES([ELEMENTARY], elementary)
86 AUTOMAKE_OPTIONS = 1.4 foreign
87 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
89 INCLUDES = -I$(top_srcdir)
93 myapp_SOURCES = main.c
94 myapp_LDADD = @ELEMENTARY_LIBS@
95 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
102 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
103 echo "Running autoheader..." ; autoheader || exit 1
104 echo "Running autoconf..." ; autoconf || exit 1
105 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
109 * To generate all the things needed to bootstrap just run:
115 * This will generate Makefile.in's, the confgure script and everything else.
116 * After this it works like all normal autotools projects:
123 * Note sudo was assumed to get root permissions, as this would install in
124 * /usr/local which is system-owned. Use any way you like to gain root, or
125 * specify a different prefix with configure:
128 ./confiugre --prefix=$HOME/mysoftware
131 * Also remember that autotools buys you some useful commands like:
136 * This uninstalls the software after it was installed with "make install".
137 * It is very useful to clear up what you built if you wish to clean the
144 * This firstly checks if your build tree is "clean" and ready for
145 * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
146 * ready to upload and distribute to the world, that contains the generated
147 * Makefile.in's and configure script. The users do not need to run
148 * autogen.sh - just configure and on. They don't need autotools installed.
149 * This tarball also builds cleanly, has all the sources it needs to build
150 * included (that is sources for your application, not libraries it depends
151 * on like Elementary). It builds cleanly in a buildroot and does not
152 * contain any files that are temporarily generated like binaries and other
153 * build-generated files, so the tarball is clean, and no need to worry
154 * about cleaning up your tree before packaging.
160 * This cleans up all build files (binaries, objects etc.) from the tree.
166 * This cleans out all files from the build and from configure's output too.
169 make maintainer-clean
172 * This deletes all the files autogen.sh will produce so the tree is clean
173 * to be put into a revision-control system (like CVS, SVN or GIT for example).
175 * There is a more advanced way of making use of the quicklaunch infrastructure
176 * in Elementary (which will not be covered here due to its more advanced
179 * Now let's actually create an interactive "Hello World" gui that you can
180 * click the ok button to exit. It's more code because this now does something
181 * much more significant, but it's still very simple:
184 #include <Elementary.h>
187 on_done(void *data, Evas_Object *obj, void *event_info)
189 // quit the mainloop (elm_run function will return)
194 elm_main(int argc, char **argv)
196 Evas_Object *win, *bg, *box, *lab, *btn;
198 // new window - do the usual and give it a name (hello) and title (Hello)
199 win = elm_win_util_standard_add("hello", "Hello");
200 // when the user clicks "close" on a window there is a request to delete
201 evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
203 // add a box object - default is vertical. a box holds children in a row,
204 // either horizontally or vertically. nothing more.
205 box = elm_box_add(win);
206 // make the box hotizontal
207 elm_box_horizontal_set(box, EINA_TRUE);
208 // add object as a resize object for the window (controls window minimum
209 // size as well as gets resized if window is resized)
210 elm_win_resize_object_add(win, box);
211 evas_object_show(box);
213 // add a label widget, set the text and put it in the pad frame
214 lab = elm_label_add(win);
215 // set default text of the label
216 elm_object_text_set(lab, "Hello out there world!");
217 // pack the label at the end of the box
218 elm_box_pack_end(box, lab);
219 evas_object_show(lab);
222 btn = elm_button_add(win);
223 // set default text of button to "OK"
224 elm_object_text_set(btn, "OK");
225 // pack the button at the end of the box
226 elm_box_pack_end(box, btn);
227 evas_object_show(btn);
228 // call on_done when button is clicked
229 evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
231 // now we are done, show the window
232 evas_object_show(win);
234 // run the mainloop and process events and callbacks
244 @page authors Authors
245 @author Carsten Haitzler <raster@@rasterman.com>
246 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
247 @author Cedric Bail <cedric.bail@@free.fr>
248 @author Vincent Torri <vtorri@@univ-evry.fr>
249 @author Daniel Kolesa <quaker66@@gmail.com>
250 @author Jaime Thomas <avi.thomas@@gmail.com>
251 @author Swisscom - http://www.swisscom.ch/
252 @author Christopher Michael <devilhorns@@comcast.net>
253 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
254 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
255 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
256 @author Brian Wang <brian.wang.0721@@gmail.com>
257 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
258 @author Samsung Electronics <tbd>
259 @author Samsung SAIT <tbd>
260 @author Brett Nash <nash@@nash.id.au>
261 @author Bruno Dilly <bdilly@@profusion.mobi>
262 @author Rafael Fonseca <rfonseca@@profusion.mobi>
263 @author Chuneon Park <hermet@@hermet.pe.kr>
264 @author Woohyun Jung <wh0705.jung@@samsung.com>
265 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
266 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
267 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
268 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
269 @author Gustavo Lima Chaves <glima@@profusion.mobi>
270 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
271 @author Tiago Falcão <tiago@@profusion.mobi>
272 @author Otavio Pontes <otavio@@profusion.mobi>
273 @author Viktor Kojouharov <vkojouharov@@gmail.com>
274 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
275 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
276 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
277 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
278 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
279 @author Jihoon Kim <jihoon48.kim@@samsung.com>
280 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
281 @author Tom Hacohen <tom@@stosb.com>
282 @author Aharon Hillel <a.hillel@@partner.samsung.com>
283 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
284 @author Shinwoo Kim <kimcinoo@@gmail.com>
285 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
286 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
287 @author Sung W. Park <sungwoo@gmail.com>
288 @author Thierry el Borgi <thierry@substantiel.fr>
289 @author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
290 @author Chanwook Jung <joey.jung@samsung.com>
291 @author Hyoyoung Chang <hyoyoung.chang@samsung.com>
292 @author Guillaume "Kuri" Friloux <guillaume.friloux@asp64.com>
293 @author Kim Yunhan <spbear@gmail.com>
295 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
296 contact with the developers and maintainers.
304 * @brief Elementary's API
309 @ELM_UNIX_DEF@ ELM_UNIX
310 @ELM_WIN32_DEF@ ELM_WIN32
311 @ELM_WINCE_DEF@ ELM_WINCE
312 @ELM_EDBUS_DEF@ ELM_EDBUS
313 @ELM_EFREET_DEF@ ELM_EFREET
314 @ELM_ETHUMB_DEF@ ELM_ETHUMB
315 @ELM_WEB_DEF@ ELM_WEB
316 @ELM_EMAP_DEF@ ELM_EMAP
317 @ELM_DEBUG_DEF@ ELM_DEBUG
318 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
319 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
321 /* Standard headers for standard system calls etc. */
326 #include <sys/types.h>
327 #include <sys/stat.h>
328 #include <sys/time.h>
329 #include <sys/param.h>
342 # ifdef ELM_LIBINTL_H
343 # include <libintl.h>
354 #if defined (ELM_WIN32) || defined (ELM_WINCE)
357 # define alloca _alloca
368 #include <Ecore_Evas.h>
369 #include <Ecore_File.h>
370 #include <Ecore_IMF.h>
371 #include <Ecore_Con.h>
380 # include <Efreet_Mime.h>
381 # include <Efreet_Trash.h>
385 # include <Ethumb_Client.h>
397 # ifdef ELEMENTARY_BUILD
399 # define EAPI __declspec(dllexport)
402 # endif /* ! DLL_EXPORT */
404 # define EAPI __declspec(dllimport)
405 # endif /* ! EFL_EVAS_BUILD */
409 # define EAPI __attribute__ ((visibility("default")))
416 #endif /* ! _WIN32 */
421 # define EAPI_MAIN EAPI
424 /* allow usage from c++ */
429 #define ELM_VERSION_MAJOR @VMAJ@
430 #define ELM_VERSION_MINOR @VMIN@
432 typedef struct _Elm_Version
440 EAPI extern Elm_Version *elm_version;
443 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
444 #define ELM_PI 3.14159265358979323846
447 * @defgroup General General
449 * @brief General Elementary API. Functions that don't relate to
450 * Elementary objects specifically.
452 * Here are documented functions which init/shutdown the library,
453 * that apply to generic Elementary objects, that deal with
454 * configuration, et cetera.
456 * @ref general_functions_example_page "This" example contemplates
457 * some of these functions.
461 * @addtogroup General
466 * Defines couple of standard Evas_Object layers to be used
467 * with evas_object_layer_set().
469 * @note whenever extending with new values, try to keep some padding
470 * to siblings so there is room for further extensions.
472 typedef enum _Elm_Object_Layer
474 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
475 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
476 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
477 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
478 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
479 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
482 /**************************************************************************/
483 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
486 * Emitted when any Elementary's policy value is changed.
488 EAPI extern int ELM_EVENT_POLICY_CHANGED;
491 * @typedef Elm_Event_Policy_Changed
493 * Data on the event when an Elementary policy has changed
495 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
498 * @struct _Elm_Event_Policy_Changed
500 * Data on the event when an Elementary policy has changed
502 struct _Elm_Event_Policy_Changed
504 unsigned int policy; /**< the policy identifier */
505 int new_value; /**< value the policy had before the change */
506 int old_value; /**< new value the policy got */
510 * Policy identifiers.
512 typedef enum _Elm_Policy
514 ELM_POLICY_QUIT, /**< under which circumstances the application
515 * should quit automatically. @see
519 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
522 typedef enum _Elm_Policy_Quit
524 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
526 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
528 * window is closed */
529 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
531 typedef enum _Elm_Focus_Direction
535 } Elm_Focus_Direction;
537 typedef enum _Elm_Text_Format
539 ELM_TEXT_FORMAT_PLAIN_UTF8,
540 ELM_TEXT_FORMAT_MARKUP_UTF8
544 * Line wrapping types.
546 typedef enum _Elm_Wrap_Type
548 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
549 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
550 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
551 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
557 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
558 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
559 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
560 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
561 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
562 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
563 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
564 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
565 ELM_INPUT_PANEL_LAYOUT_INVALID
566 } Elm_Input_Panel_Layout;
570 ELM_AUTOCAPITAL_TYPE_NONE,
571 ELM_AUTOCAPITAL_TYPE_WORD,
572 ELM_AUTOCAPITAL_TYPE_SENTENCE,
573 ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
574 } Elm_Autocapital_Type;
577 * @typedef Elm_Object_Item
578 * An Elementary Object item handle.
581 typedef struct _Elm_Object_Item Elm_Object_Item;
585 * Called back when a widget's tooltip is activated and needs content.
586 * @param data user-data given to elm_object_tooltip_content_cb_set()
587 * @param obj owner widget.
589 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj);
592 * Called back when a widget's item tooltip is activated and needs content.
593 * @param data user-data given to elm_object_tooltip_content_cb_set()
594 * @param obj owner widget.
595 * @param item context dependent item. As an example, if tooltip was
596 * set on Elm_List_Item, then it is of this type.
598 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, void *item);
600 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
602 #ifndef ELM_LIB_QUICKLAUNCH
603 #define ELM_MAIN() int main(int argc, char **argv) {elm_init(argc, argv); return elm_main(argc, argv);} /**< macro to be used after the elm_main() function */
605 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
608 /**************************************************************************/
612 * Initialize Elementary
614 * @param[in] argc System's argument count value
615 * @param[in] argv System's pointer to array of argument strings
616 * @return The init counter value.
618 * This function initializes Elementary and increments a counter of
619 * the number of calls to it. It returns the new counter's value.
621 * @warning This call is exported only for use by the @c ELM_MAIN()
622 * macro. There is no need to use this if you use this macro (which
623 * is highly advisable). An elm_main() should contain the entry
624 * point code for your application, having the same prototype as
625 * elm_init(), and @b not being static (putting the @c EAPI symbol
626 * in front of its type declaration is advisable). The @c
627 * ELM_MAIN() call should be placed just after it.
630 * @dontinclude bg_example_01.c
634 * See the full @ref bg_example_01_c "example".
636 * @see elm_shutdown().
639 EAPI int elm_init(int argc, char **argv);
642 * Shut down Elementary
644 * @return The init counter value.
646 * This should be called at the end of your application, just
647 * before it ceases to do any more processing. This will clean up
648 * any permanent resources your application may have allocated via
649 * Elementary that would otherwise persist.
651 * @see elm_init() for an example
655 EAPI int elm_shutdown(void);
658 * Run Elementary's main loop
660 * This call should be issued just after all initialization is
661 * completed. This function will not return until elm_exit() is
662 * called. It will keep looping, running the main
663 * (event/processing) loop for Elementary.
665 * @see elm_init() for an example
669 EAPI void elm_run(void);
672 * Exit Elementary's main loop
674 * If this call is issued, it will flag the main loop to cease
675 * processing and return back to its parent function (usually your
676 * elm_main() function).
678 * @see elm_init() for an example. There, just after a request to
679 * close the window comes, the main loop will be left.
681 * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
682 * applications, you'll be able to get this function called automatically for you.
686 EAPI void elm_exit(void);
689 * Provide information in order to make Elementary determine the @b
690 * run time location of the software in question, so other data files
691 * such as images, sound files, executable utilities, libraries,
692 * modules and locale files can be found.
694 * @param mainfunc This is your application's main function name,
695 * whose binary's location is to be found. Providing @c NULL
696 * will make Elementary not to use it
697 * @param dom This will be used as the application's "domain", in the
698 * form of a prefix to any environment variables that may
699 * override prefix detection and the directory name, inside the
700 * standard share or data directories, where the software's
701 * data files will be looked for.
702 * @param checkfile This is an (optional) magic file's path to check
703 * for existence (and it must be located in the data directory,
704 * under the share directory provided above). Its presence will
705 * help determine the prefix found was correct. Pass @c NULL if
706 * the check is not to be done.
708 * This function allows one to re-locate the application somewhere
709 * else after compilation, if the developer wishes for easier
710 * distribution of pre-compiled binaries.
712 * The prefix system is designed to locate where the given software is
713 * installed (under a common path prefix) at run time and then report
714 * specific locations of this prefix and common directories inside
715 * this prefix like the binary, library, data and locale directories,
716 * through the @c elm_app_*_get() family of functions.
718 * Call elm_app_info_set() early on before you change working
719 * directory or anything about @c argv[0], so it gets accurate
722 * It will then try and trace back which file @p mainfunc comes from,
723 * if provided, to determine the application's prefix directory.
725 * The @p dom parameter provides a string prefix to prepend before
726 * environment variables, allowing a fallback to @b specific
727 * environment variables to locate the software. You would most
728 * probably provide a lowercase string there, because it will also
729 * serve as directory domain, explained next. For environment
730 * variables purposes, this string is made uppercase. For example if
731 * @c "myapp" is provided as the prefix, then the program would expect
732 * @c "MYAPP_PREFIX" as a master environment variable to specify the
733 * exact install prefix for the software, or more specific environment
734 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
735 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
736 * the user or scripts before launching. If not provided (@c NULL),
737 * environment variables will not be used to override compiled-in
738 * defaults or auto detections.
740 * The @p dom string also provides a subdirectory inside the system
741 * shared data directory for data files. For example, if the system
742 * directory is @c /usr/local/share, then this directory name is
743 * appended, creating @c /usr/local/share/myapp, if it @p was @c
744 * "myapp". It is expected that the application installs data files in
747 * The @p checkfile is a file name or path of something inside the
748 * share or data directory to be used to test that the prefix
749 * detection worked. For example, your app will install a wallpaper
750 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
751 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
754 * @see elm_app_compile_bin_dir_set()
755 * @see elm_app_compile_lib_dir_set()
756 * @see elm_app_compile_data_dir_set()
757 * @see elm_app_compile_locale_set()
758 * @see elm_app_prefix_dir_get()
759 * @see elm_app_bin_dir_get()
760 * @see elm_app_lib_dir_get()
761 * @see elm_app_data_dir_get()
762 * @see elm_app_locale_dir_get()
764 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
767 * Provide information on the @b fallback application's binaries
768 * directory, in scenarios where they get overriden by
769 * elm_app_info_set().
771 * @param dir The path to the default binaries directory (compile time
774 * @note Elementary will as well use this path to determine actual
775 * names of binaries' directory paths, maybe changing it to be @c
776 * something/local/bin instead of @c something/bin, only, for
779 * @warning You should call this function @b before
780 * elm_app_info_set().
782 EAPI void elm_app_compile_bin_dir_set(const char *dir);
785 * Provide information on the @b fallback application's libraries
786 * directory, on scenarios where they get overriden by
787 * elm_app_info_set().
789 * @param dir The path to the default libraries directory (compile
792 * @note Elementary will as well use this path to determine actual
793 * names of libraries' directory paths, maybe changing it to be @c
794 * something/lib32 or @c something/lib64 instead of @c something/lib,
797 * @warning You should call this function @b before
798 * elm_app_info_set().
800 EAPI void elm_app_compile_lib_dir_set(const char *dir);
803 * Provide information on the @b fallback application's data
804 * directory, on scenarios where they get overriden by
805 * elm_app_info_set().
807 * @param dir The path to the default data directory (compile time
810 * @note Elementary will as well use this path to determine actual
811 * names of data directory paths, maybe changing it to be @c
812 * something/local/share instead of @c something/share, only, for
815 * @warning You should call this function @b before
816 * elm_app_info_set().
818 EAPI void elm_app_compile_data_dir_set(const char *dir);
821 * Provide information on the @b fallback application's locale
822 * directory, on scenarios where they get overriden by
823 * elm_app_info_set().
825 * @param dir The path to the default locale directory (compile time
828 * @warning You should call this function @b before
829 * elm_app_info_set().
831 EAPI void elm_app_compile_locale_set(const char *dir);
834 * Retrieve the application's run time prefix directory, as set by
835 * elm_app_info_set() and the way (environment) the application was
838 * @return The directory prefix the application is actually using.
840 EAPI const char *elm_app_prefix_dir_get(void);
843 * Retrieve the application's run time binaries prefix directory, as
844 * set by elm_app_info_set() and the way (environment) the application
847 * @return The binaries directory prefix the application is actually
850 EAPI const char *elm_app_bin_dir_get(void);
853 * Retrieve the application's run time libraries prefix directory, as
854 * set by elm_app_info_set() and the way (environment) the application
857 * @return The libraries directory prefix the application is actually
860 EAPI const char *elm_app_lib_dir_get(void);
863 * Retrieve the application's run time data prefix directory, as
864 * set by elm_app_info_set() and the way (environment) the application
867 * @return The data directory prefix the application is actually
870 EAPI const char *elm_app_data_dir_get(void);
873 * Retrieve the application's run time locale prefix directory, as
874 * set by elm_app_info_set() and the way (environment) the application
877 * @return The locale directory prefix the application is actually
880 EAPI const char *elm_app_locale_dir_get(void);
882 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
883 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
884 EAPI int elm_quicklaunch_init(int argc, char **argv);
885 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
886 EAPI int elm_quicklaunch_sub_shutdown(void);
887 EAPI int elm_quicklaunch_shutdown(void);
888 EAPI void elm_quicklaunch_seed(void);
889 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
890 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
891 EAPI void elm_quicklaunch_cleanup(void);
892 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
893 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
895 EAPI Eina_Bool elm_need_efreet(void);
896 EAPI Eina_Bool elm_need_e_dbus(void);
899 * This must be called before any other function that deals with
900 * elm_thumb objects or ethumb_client instances.
904 EAPI Eina_Bool elm_need_ethumb(void);
907 * This must be called before any other function that deals with
908 * elm_web objects or ewk_view instances.
912 EAPI Eina_Bool elm_need_web(void);
915 * Set a new policy's value (for a given policy group/identifier).
917 * @param policy policy identifier, as in @ref Elm_Policy.
918 * @param value policy value, which depends on the identifier
920 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
922 * Elementary policies define applications' behavior,
923 * somehow. These behaviors are divided in policy groups (see
924 * #Elm_Policy enumeration). This call will emit the Ecore event
925 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
926 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
929 * @note Currently, we have only one policy identifier/group
930 * (#ELM_POLICY_QUIT), which has two possible values.
934 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
937 * Gets the policy value for given policy identifier.
939 * @param policy policy identifier, as in #Elm_Policy.
940 * @return The currently set policy value, for that
941 * identifier. Will be @c 0 if @p policy passed is invalid.
945 EAPI int elm_policy_get(unsigned int policy);
948 * Change the language of the current application
950 * The @p lang passed must be the full name of the locale to use, for
951 * example "en_US.utf8" or "es_ES@euro".
953 * Changing language with this function will make Elementary run through
954 * all its widgets, translating strings set with
955 * elm_object_domain_translatable_text_part_set(). This way, an entire
956 * UI can have its language changed without having to restart the program.
958 * For more complex cases, like having formatted strings that need
959 * translation, widgets will also emit a "language,changed" signal that
960 * the user can listen to to manually translate the text.
962 * @param lang Language to set, must be the full name of the locale
966 EAPI void elm_language_set(const char *lang);
969 * Set a label of an object
971 * @param obj The Elementary object
972 * @param part The text part name to set (NULL for the default label)
973 * @param label The new text of the label
975 * @note Elementary objects may have many labels (e.g. Action Slider)
979 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
981 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
984 * Get a label of an object
986 * @param obj The Elementary object
987 * @param part The text part name to get (NULL for the default label)
988 * @return text of the label or NULL for any error
990 * @note Elementary objects may have many labels (e.g. Action Slider)
994 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
996 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
999 * Set the text for an objects' part, marking it as translatable.
1001 * The string to set as @p text must be the original one. Do not pass the
1002 * return of @c gettext() here. Elementary will translate the string
1003 * internally and set it on the object using elm_object_text_part_set(),
1004 * also storing the original string so that it can be automatically
1005 * translated when the language is changed with elm_language_set().
1007 * The @p domain will be stored along to find the translation in the
1008 * correct catalog. It can be NULL, in which case it will use whatever
1009 * domain was set by the application with @c textdomain(). This is useful
1010 * in case you are building a library on top of Elementary that will have
1011 * its own translatable strings, that should not be mixed with those of
1012 * programs using the library.
1014 * @param obj The object containing the text part
1015 * @param part The name of the part to set
1016 * @param domain The translation domain to use
1017 * @param text The original, non-translated text to set
1021 EAPI void elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1023 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1025 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1028 * Gets the original string set as translatable for an object
1030 * When setting translated strings, the function elm_object_part_text_get()
1031 * will return the translation returned by @c gettext(). To get the
1032 * original string use this function.
1034 * @param obj The object
1035 * @param part The name of the part that was set
1037 * @return The original, untranslated string
1041 EAPI const char *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1043 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1046 * Set a content of an object
1048 * @param obj The Elementary object
1049 * @param part The content part name to set (NULL for the default content)
1050 * @param content The new content of the object
1052 * @note Elementary objects may have many contents
1056 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1058 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
1061 * Get a content of an object
1063 * @param obj The Elementary object
1064 * @param item The content part name to get (NULL for the default content)
1065 * @return content of the object or NULL for any error
1067 * @note Elementary objects may have many contents
1071 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1073 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
1076 * Unset a content of an object
1078 * @param obj The Elementary object
1079 * @param item The content part name to unset (NULL for the default content)
1081 * @note Elementary objects may have many contents
1085 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1087 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1090 * Get the widget object's handle which contains a given item
1092 * @param item The Elementary object item
1093 * @return The widget object
1095 * @note This returns the widget object itself that an item belongs to.
1099 EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1102 * Set a content of an object item
1104 * @param it The Elementary object item
1105 * @param part The content part name to set (NULL for the default content)
1106 * @param content The new content of the object item
1108 * @note Elementary object items may have many contents
1112 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1114 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1117 * Get a content of an object item
1119 * @param it The Elementary object item
1120 * @param part The content part name to unset (NULL for the default content)
1121 * @return content of the object item or NULL for any error
1123 * @note Elementary object items may have many contents
1127 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1129 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1132 * Unset a content of an object item
1134 * @param it The Elementary object item
1135 * @param part The content part name to unset (NULL for the default content)
1137 * @note Elementary object items may have many contents
1141 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1143 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1146 * Set a label of an object item
1148 * @param it The Elementary object item
1149 * @param part The text part name to set (NULL for the default label)
1150 * @param label The new text of the label
1152 * @note Elementary object items may have many labels
1156 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1158 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1161 * Get a label of an object item
1163 * @param it The Elementary object item
1164 * @param part The text part name to get (NULL for the default label)
1165 * @return text of the label or NULL for any error
1167 * @note Elementary object items may have many labels
1171 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1174 * Set the text to read out when in accessibility mode
1176 * @param obj The object which is to be described
1177 * @param txt The text that describes the widget to people with poor or no vision
1181 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1184 * Set the text to read out when in accessibility mode
1186 * @param it The object item which is to be described
1187 * @param txt The text that describes the widget to people with poor or no vision
1191 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1194 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1197 * Set the text to read out when in accessibility mode
1199 * @param obj The object which is to be described
1200 * @param txt The text that describes the widget to people with poor or no vision
1204 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1207 * Set the text to read out when in accessibility mode
1209 * @param it The object item which is to be described
1210 * @param txt The text that describes the widget to people with poor or no vision
1214 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1217 * Get the data associated with an object item
1218 * @param it The Elementary object item
1219 * @return The data associated with @p it
1223 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1226 * Set the data associated with an object item
1227 * @param it The Elementary object item
1228 * @param data The data to be associated with @p it
1232 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1235 * Send a signal to the edje object of the widget item.
1237 * This function sends a signal to the edje object of the obj item. An
1238 * edje program can respond to a signal by specifying matching
1239 * 'signal' and 'source' fields.
1241 * @param it The Elementary object item
1242 * @param emission The signal's name.
1243 * @param source The signal's source.
1246 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1253 * @defgroup Caches Caches
1255 * These are functions which let one fine-tune some cache values for
1256 * Elementary applications, thus allowing for performance adjustments.
1262 * @brief Flush all caches.
1264 * Frees all data that was in cache and is not currently being used to reduce
1265 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1266 * to calling all of the following functions:
1267 * @li edje_file_cache_flush()
1268 * @li edje_collection_cache_flush()
1269 * @li eet_clearcache()
1270 * @li evas_image_cache_flush()
1271 * @li evas_font_cache_flush()
1272 * @li evas_render_dump()
1273 * @note Evas caches are flushed for every canvas associated with a window.
1277 EAPI void elm_all_flush(void);
1280 * Get the configured cache flush interval time
1282 * This gets the globally configured cache flush interval time, in
1285 * @return The cache flush interval time
1288 * @see elm_all_flush()
1290 EAPI int elm_cache_flush_interval_get(void);
1293 * Set the configured cache flush interval time
1295 * This sets the globally configured cache flush interval time, in ticks
1297 * @param size The cache flush interval time
1300 * @see elm_all_flush()
1302 EAPI void elm_cache_flush_interval_set(int size);
1305 * Set the configured cache flush interval time for all applications on the
1308 * This sets the globally configured cache flush interval time -- in ticks
1309 * -- for all applications on the display.
1311 * @param size The cache flush interval time
1314 EAPI void elm_cache_flush_interval_all_set(int size);
1317 * Get the configured cache flush enabled state
1319 * This gets the globally configured cache flush state - if it is enabled
1320 * or not. When cache flushing is enabled, elementary will regularly
1321 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1322 * memory and allow usage to re-seed caches and data in memory where it
1323 * can do so. An idle application will thus minimise its memory usage as
1324 * data will be freed from memory and not be re-loaded as it is idle and
1325 * not rendering or doing anything graphically right now.
1327 * @return The cache flush state
1330 * @see elm_all_flush()
1332 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1335 * Set the configured cache flush enabled state
1337 * This sets the globally configured cache flush enabled state.
1339 * @param size The cache flush enabled state
1342 * @see elm_all_flush()
1344 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1347 * Set the configured cache flush enabled state for all applications on the
1350 * This sets the globally configured cache flush enabled state for all
1351 * applications on the display.
1353 * @param size The cache flush enabled state
1356 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1359 * Get the configured font cache size
1361 * This gets the globally configured font cache size, in bytes.
1363 * @return The font cache size
1366 EAPI int elm_font_cache_get(void);
1369 * Set the configured font cache size
1371 * This sets the globally configured font cache size, in bytes
1373 * @param size The font cache size
1376 EAPI void elm_font_cache_set(int size);
1379 * Set the configured font cache size for all applications on the
1382 * This sets the globally configured font cache size -- in bytes
1383 * -- for all applications on the display.
1385 * @param size The font cache size
1388 EAPI void elm_font_cache_all_set(int size);
1391 * Get the configured image cache size
1393 * This gets the globally configured image cache size, in bytes
1395 * @return The image cache size
1398 EAPI int elm_image_cache_get(void);
1401 * Set the configured image cache size
1403 * This sets the globally configured image cache size, in bytes
1405 * @param size The image cache size
1408 EAPI void elm_image_cache_set(int size);
1411 * Set the configured image cache size for all applications on the
1414 * This sets the globally configured image cache size -- in bytes
1415 * -- for all applications on the display.
1417 * @param size The image cache size
1420 EAPI void elm_image_cache_all_set(int size);
1423 * Get the configured edje file cache size.
1425 * This gets the globally configured edje file cache size, in number
1428 * @return The edje file cache size
1431 EAPI int elm_edje_file_cache_get(void);
1434 * Set the configured edje file cache size
1436 * This sets the globally configured edje file cache size, in number
1439 * @param size The edje file cache size
1442 EAPI void elm_edje_file_cache_set(int size);
1445 * Set the configured edje file cache size for all applications on the
1448 * This sets the globally configured edje file cache size -- in number
1449 * of files -- for all applications on the display.
1451 * @param size The edje file cache size
1454 EAPI void elm_edje_file_cache_all_set(int size);
1457 * Get the configured edje collections (groups) cache size.
1459 * This gets the globally configured edje collections cache size, in
1460 * number of collections.
1462 * @return The edje collections cache size
1465 EAPI int elm_edje_collection_cache_get(void);
1468 * Set the configured edje collections (groups) cache size
1470 * This sets the globally configured edje collections cache size, in
1471 * number of collections.
1473 * @param size The edje collections cache size
1476 EAPI void elm_edje_collection_cache_set(int size);
1479 * Set the configured edje collections (groups) cache size for all
1480 * applications on the display
1482 * This sets the globally configured edje collections cache size -- in
1483 * number of collections -- for all applications on the display.
1485 * @param size The edje collections cache size
1488 EAPI void elm_edje_collection_cache_all_set(int size);
1495 * @defgroup Scaling Widget Scaling
1497 * Different widgets can be scaled independently. These functions
1498 * allow you to manipulate this scaling on a per-widget basis. The
1499 * object and all its children get their scaling factors multiplied
1500 * by the scale factor set. This is multiplicative, in that if a
1501 * child also has a scale size set it is in turn multiplied by its
1502 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1503 * double size, @c 0.5 is half, etc.
1505 * @ref general_functions_example_page "This" example contemplates
1506 * some of these functions.
1510 * Get the global scaling factor
1512 * This gets the globally configured scaling factor that is applied to all
1515 * @return The scaling factor
1518 EAPI double elm_scale_get(void);
1521 * Set the global scaling factor
1523 * This sets the globally configured scaling factor that is applied to all
1526 * @param scale The scaling factor to set
1529 EAPI void elm_scale_set(double scale);
1532 * Set the global scaling factor for all applications on the display
1534 * This sets the globally configured scaling factor that is applied to all
1535 * objects for all applications.
1536 * @param scale The scaling factor to set
1539 EAPI void elm_scale_all_set(double scale);
1542 * Set the scaling factor for a given Elementary object
1544 * @param obj The Elementary to operate on
1545 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1550 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1553 * Get the scaling factor for a given Elementary object
1555 * @param obj The object
1556 * @return The scaling factor set by elm_object_scale_set()
1560 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1563 * @defgroup Password_last_show Password last input show
1565 * Last show feature of password mode enables user to view
1566 * the last input entered for few seconds before masking it.
1567 * These functions allow to set this feature in password mode
1568 * of entry widget and also allow to manipulate the duration
1569 * for which the input has to be visible.
1575 * Get show last setting of password mode.
1577 * This gets the show last input setting of password mode which might be
1578 * enabled or disabled.
1580 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1582 * @ingroup Password_last_show
1584 EAPI Eina_Bool elm_password_show_last_get(void);
1587 * Set show last setting in password mode.
1589 * This enables or disables show last setting of password mode.
1591 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1592 * @see elm_password_show_last_timeout_set()
1593 * @ingroup Password_last_show
1595 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1598 * Get's the timeout value in last show password mode.
1600 * This gets the time out value for which the last input entered in password
1601 * mode will be visible.
1603 * @return The timeout value of last show password mode.
1604 * @ingroup Password_last_show
1606 EAPI double elm_password_show_last_timeout_get(void);
1609 * Set's the timeout value in last show password mode.
1611 * This sets the time out value for which the last input entered in password
1612 * mode will be visible.
1614 * @param password_show_last_timeout The timeout value.
1615 * @see elm_password_show_last_set()
1616 * @ingroup Password_last_show
1618 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1625 * @defgroup UI-Mirroring Selective Widget mirroring
1627 * These functions allow you to set ui-mirroring on specific
1628 * widgets or the whole interface. Widgets can be in one of two
1629 * modes, automatic and manual. Automatic means they'll be changed
1630 * according to the system mirroring mode and manual means only
1631 * explicit changes will matter. You are not supposed to change
1632 * mirroring state of a widget set to automatic, will mostly work,
1633 * but the behavior is not really defined.
1638 EAPI Eina_Bool elm_mirrored_get(void);
1639 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1642 * Get the system mirrored mode. This determines the default mirrored mode
1645 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1647 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1650 * Set the system mirrored mode. This determines the default mirrored mode
1653 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1655 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1658 * Returns the widget's mirrored mode setting.
1660 * @param obj The widget.
1661 * @return mirrored mode setting of the object.
1664 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1667 * Sets the widget's mirrored mode setting.
1668 * When widget in automatic mode, it follows the system mirrored mode set by
1669 * elm_mirrored_set().
1670 * @param obj The widget.
1671 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1673 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1680 * Set the style to use by a widget
1682 * Sets the style name that will define the appearance of a widget. Styles
1683 * vary from widget to widget and may also be defined by other themes
1684 * by means of extensions and overlays.
1686 * @param obj The Elementary widget to style
1687 * @param style The style name to use
1689 * @see elm_theme_extension_add()
1690 * @see elm_theme_extension_del()
1691 * @see elm_theme_overlay_add()
1692 * @see elm_theme_overlay_del()
1696 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1698 * Get the style used by the widget
1700 * This gets the style being used for that widget. Note that the string
1701 * pointer is only valid as longas the object is valid and the style doesn't
1704 * @param obj The Elementary widget to query for its style
1705 * @return The style name used
1707 * @see elm_object_style_set()
1711 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1714 * @defgroup Styles Styles
1716 * Widgets can have different styles of look. These generic API's
1717 * set styles of widgets, if they support them (and if the theme(s)
1720 * @ref general_functions_example_page "This" example contemplates
1721 * some of these functions.
1725 * Set the disabled state of an Elementary object.
1727 * @param obj The Elementary object to operate on
1728 * @param disabled The state to put in in: @c EINA_TRUE for
1729 * disabled, @c EINA_FALSE for enabled
1731 * Elementary objects can be @b disabled, in which state they won't
1732 * receive input and, in general, will be themed differently from
1733 * their normal state, usually greyed out. Useful for contexts
1734 * where you don't want your users to interact with some of the
1735 * parts of you interface.
1737 * This sets the state for the widget, either disabling it or
1742 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1745 * Get the disabled state of an Elementary object.
1747 * @param obj The Elementary object to operate on
1748 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1749 * if it's enabled (or on errors)
1751 * This gets the state of the widget, which might be enabled or disabled.
1755 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1758 * @defgroup WidgetNavigation Widget Tree Navigation.
1760 * How to check if an Evas Object is an Elementary widget? How to
1761 * get the first elementary widget that is parent of the given
1762 * object? These are all covered in widget tree navigation.
1764 * @ref general_functions_example_page "This" example contemplates
1765 * some of these functions.
1769 * Check if the given Evas Object is an Elementary widget.
1771 * @param obj the object to query.
1772 * @return @c EINA_TRUE if it is an elementary widget variant,
1773 * @c EINA_FALSE otherwise
1774 * @ingroup WidgetNavigation
1776 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1779 * Get the first parent of the given object that is an Elementary
1782 * @param obj the Elementary object to query parent from.
1783 * @return the parent object that is an Elementary widget, or @c
1784 * NULL, if it was not found.
1786 * Use this to query for an object's parent widget.
1788 * @note Most of Elementary users wouldn't be mixing non-Elementary
1789 * smart objects in the objects tree of an application, as this is
1790 * an advanced usage of Elementary with Evas. So, except for the
1791 * application's window, which is the root of that tree, all other
1792 * objects would have valid Elementary widget parents.
1794 * @ingroup WidgetNavigation
1796 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1799 * Get the top level parent of an Elementary widget.
1801 * @param obj The object to query.
1802 * @return The top level Elementary widget, or @c NULL if parent cannot be
1804 * @ingroup WidgetNavigation
1806 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1809 * Get the string that represents this Elementary widget.
1811 * @note Elementary is weird and exposes itself as a single
1812 * Evas_Object_Smart_Class of type "elm_widget", so
1813 * evas_object_type_get() always return that, making debug and
1814 * language bindings hard. This function tries to mitigate this
1815 * problem, but the solution is to change Elementary to use
1816 * proper inheritance.
1818 * @param obj the object to query.
1819 * @return Elementary widget name, or @c NULL if not a valid widget.
1820 * @ingroup WidgetNavigation
1822 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1825 * @defgroup Config Elementary Config
1827 * Elementary configuration is formed by a set options bounded to a
1828 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1829 * "finger size", etc. These are functions with which one syncronizes
1830 * changes made to those values to the configuration storing files, de
1831 * facto. You most probably don't want to use the functions in this
1832 * group unlees you're writing an elementary configuration manager.
1838 * Save back Elementary's configuration, so that it will persist on
1841 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1844 * This function will take effect -- thus, do I/O -- immediately. Use
1845 * it when you want to apply all configuration changes at once. The
1846 * current configuration set will get saved onto the current profile
1847 * configuration file.
1850 EAPI Eina_Bool elm_config_save(void);
1853 * Reload Elementary's configuration, bounded to current selected
1856 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1859 * Useful when you want to force reloading of configuration values for
1860 * a profile. If one removes user custom configuration directories,
1861 * for example, it will force a reload with system values instead.
1864 EAPI void elm_config_reload(void);
1871 * @defgroup Profile Elementary Profile
1873 * Profiles are pre-set options that affect the whole look-and-feel of
1874 * Elementary-based applications. There are, for example, profiles
1875 * aimed at desktop computer applications and others aimed at mobile,
1876 * touchscreen-based ones. You most probably don't want to use the
1877 * functions in this group unlees you're writing an elementary
1878 * configuration manager.
1884 * Get Elementary's profile in use.
1886 * This gets the global profile that is applied to all Elementary
1889 * @return The profile's name
1892 EAPI const char *elm_profile_current_get(void);
1895 * Get an Elementary's profile directory path in the filesystem. One
1896 * may want to fetch a system profile's dir or an user one (fetched
1899 * @param profile The profile's name
1900 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1901 * or a system one (@c EINA_FALSE)
1902 * @return The profile's directory path.
1905 * @note You must free it with elm_profile_dir_free().
1907 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1910 * Free an Elementary's profile directory path, as returned by
1911 * elm_profile_dir_get().
1913 * @param p_dir The profile's path
1917 EAPI void elm_profile_dir_free(const char *p_dir);
1920 * Get Elementary's list of available profiles.
1922 * @return The profiles list. List node data are the profile name
1926 * @note One must free this list, after usage, with the function
1927 * elm_profile_list_free().
1929 EAPI Eina_List *elm_profile_list_get(void);
1932 * Free Elementary's list of available profiles.
1934 * @param l The profiles list, as returned by elm_profile_list_get().
1938 EAPI void elm_profile_list_free(Eina_List *l);
1941 * Set Elementary's profile.
1943 * This sets the global profile that is applied to Elementary
1944 * applications. Just the process the call comes from will be
1947 * @param profile The profile's name
1951 EAPI void elm_profile_set(const char *profile);
1954 * Set Elementary's profile.
1956 * This sets the global profile that is applied to all Elementary
1957 * applications. All running Elementary windows will be affected.
1959 * @param profile The profile's name
1963 EAPI void elm_profile_all_set(const char *profile);
1970 * @defgroup Engine Elementary Engine
1972 * These are functions setting and querying which rendering engine
1973 * Elementary will use for drawing its windows' pixels.
1975 * The following are the available engines:
1976 * @li "software_x11"
1979 * @li "software_16_x11"
1980 * @li "software_8_x11"
1983 * @li "software_gdi"
1984 * @li "software_16_wince_gdi"
1986 * @li "software_16_sdl"
1990 * @li "opengl_cocoa"
1997 * @brief Get Elementary's rendering engine in use.
1999 * @return The rendering engine's name
2000 * @note there's no need to free the returned string, here.
2002 * This gets the global rendering engine that is applied to all Elementary
2005 * @see elm_engine_set()
2007 EAPI const char *elm_engine_current_get(void);
2010 * @brief Set Elementary's rendering engine for use.
2012 * @param engine The rendering engine's name
2014 * This sets global rendering engine that is applied to all Elementary
2015 * applications. Note that it will take effect only to Elementary windows
2016 * created after this is called.
2018 * @see elm_win_add()
2020 EAPI void elm_engine_set(const char *engine);
2027 * @defgroup Fonts Elementary Fonts
2029 * These are functions dealing with font rendering, selection and the
2030 * like for Elementary applications. One might fetch which system
2031 * fonts are there to use and set custom fonts for individual classes
2032 * of UI items containing text (text classes).
2037 typedef struct _Elm_Text_Class
2043 typedef struct _Elm_Font_Overlay
2045 const char *text_class;
2047 Evas_Font_Size size;
2050 typedef struct _Elm_Font_Properties
2054 } Elm_Font_Properties;
2057 * Get Elementary's list of supported text classes.
2059 * @return The text classes list, with @c Elm_Text_Class blobs as data.
2062 * Release the list with elm_text_classes_list_free().
2064 EAPI const Eina_List *elm_text_classes_list_get(void);
2067 * Free Elementary's list of supported text classes.
2071 * @see elm_text_classes_list_get().
2073 EAPI void elm_text_classes_list_free(const Eina_List *list);
2076 * Get Elementary's list of font overlays, set with
2077 * elm_font_overlay_set().
2079 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2084 * For each text class, one can set a <b>font overlay</b> for it,
2085 * overriding the default font properties for that class coming from
2086 * the theme in use. There is no need to free this list.
2088 * @see elm_font_overlay_set() and elm_font_overlay_unset().
2090 EAPI const Eina_List *elm_font_overlay_list_get(void);
2093 * Set a font overlay for a given Elementary text class.
2095 * @param text_class Text class name
2096 * @param font Font name and style string
2097 * @param size Font size
2101 * @p font has to be in the format returned by
2102 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2103 * and elm_font_overlay_unset().
2105 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2108 * Unset a font overlay for a given Elementary text class.
2110 * @param text_class Text class name
2114 * This will bring back text elements belonging to text class
2115 * @p text_class back to their default font settings.
2117 EAPI void elm_font_overlay_unset(const char *text_class);
2120 * Apply the changes made with elm_font_overlay_set() and
2121 * elm_font_overlay_unset() on the current Elementary window.
2125 * This applies all font overlays set to all objects in the UI.
2127 EAPI void elm_font_overlay_apply(void);
2130 * Apply the changes made with elm_font_overlay_set() and
2131 * elm_font_overlay_unset() on all Elementary application windows.
2135 * This applies all font overlays set to all objects in the UI.
2137 EAPI void elm_font_overlay_all_apply(void);
2140 * Translate a font (family) name string in fontconfig's font names
2141 * syntax into an @c Elm_Font_Properties struct.
2143 * @param font The font name and styles string
2144 * @return the font properties struct
2148 * @note The reverse translation can be achived with
2149 * elm_font_fontconfig_name_get(), for one style only (single font
2150 * instance, not family).
2152 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2155 * Free font properties return by elm_font_properties_get().
2157 * @param efp the font properties struct
2161 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2164 * Translate a font name, bound to a style, into fontconfig's font names
2167 * @param name The font (family) name
2168 * @param style The given style (may be @c NULL)
2170 * @return the font name and style string
2174 * @note The reverse translation can be achived with
2175 * elm_font_properties_get(), for one style only (single font
2176 * instance, not family).
2178 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2181 * Free the font string return by elm_font_fontconfig_name_get().
2183 * @param efp the font properties struct
2187 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2190 * Create a font hash table of available system fonts.
2192 * One must call it with @p list being the return value of
2193 * evas_font_available_list(). The hash will be indexed by font
2194 * (family) names, being its values @c Elm_Font_Properties blobs.
2196 * @param list The list of available system fonts, as returned by
2197 * evas_font_available_list().
2198 * @return the font hash.
2202 * @note The user is supposed to get it populated at least with 3
2203 * default font families (Sans, Serif, Monospace), which should be
2204 * present on most systems.
2206 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2209 * Free the hash return by elm_font_available_hash_add().
2211 * @param hash the hash to be freed.
2215 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2222 * @defgroup Fingers Fingers
2224 * Elementary is designed to be finger-friendly for touchscreens,
2225 * and so in addition to scaling for display resolution, it can
2226 * also scale based on finger "resolution" (or size). You can then
2227 * customize the granularity of the areas meant to receive clicks
2230 * Different profiles may have pre-set values for finger sizes.
2232 * @ref general_functions_example_page "This" example contemplates
2233 * some of these functions.
2239 * Get the configured "finger size"
2241 * @return The finger size
2243 * This gets the globally configured finger size, <b>in pixels</b>
2247 EAPI Evas_Coord elm_finger_size_get(void);
2250 * Set the configured finger size
2252 * This sets the globally configured finger size in pixels
2254 * @param size The finger size
2257 EAPI void elm_finger_size_set(Evas_Coord size);
2260 * Set the configured finger size for all applications on the display
2262 * This sets the globally configured finger size in pixels for all
2263 * applications on the display
2265 * @param size The finger size
2268 EAPI void elm_finger_size_all_set(Evas_Coord size);
2275 * @defgroup Focus Focus
2277 * An Elementary application has, at all times, one (and only one)
2278 * @b focused object. This is what determines where the input
2279 * events go to within the application's window. Also, focused
2280 * objects can be decorated differently, in order to signal to the
2281 * user where the input is, at a given moment.
2283 * Elementary applications also have the concept of <b>focus
2284 * chain</b>: one can cycle through all the windows' focusable
2285 * objects by input (tab key) or programmatically. The default
2286 * focus chain for an application is the one define by the order in
2287 * which the widgets where added in code. One will cycle through
2288 * top level widgets, and, for each one containg sub-objects, cycle
2289 * through them all, before returning to the level
2290 * above. Elementary also allows one to set @b custom focus chains
2291 * for their applications.
2293 * Besides the focused decoration a widget may exhibit, when it
2294 * gets focus, Elementary has a @b global focus highlight object
2295 * that can be enabled for a window. If one chooses to do so, this
2296 * extra highlight effect will surround the current focused object,
2299 * @note Some Elementary widgets are @b unfocusable, after
2300 * creation, by their very nature: they are not meant to be
2301 * interacted with input events, but are there just for visual
2304 * @ref general_functions_example_page "This" example contemplates
2305 * some of these functions.
2309 * Get the enable status of the focus highlight
2311 * This gets whether the highlight on focused objects is enabled or not
2314 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2317 * Set the enable status of the focus highlight
2319 * Set whether to show or not the highlight on focused objects
2320 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2323 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2326 * Get the enable status of the highlight animation
2328 * Get whether the focus highlight, if enabled, will animate its switch from
2329 * one object to the next
2332 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2335 * Set the enable status of the highlight animation
2337 * Set whether the focus highlight, if enabled, will animate its switch from
2338 * one object to the next
2339 * @param animate Enable animation if EINA_TRUE, disable otherwise
2342 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2345 * Get the whether an Elementary object has the focus or not.
2347 * @param obj The Elementary object to get the information from
2348 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2349 * not (and on errors).
2351 * @see elm_object_focus_set()
2355 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2358 * Set/unset focus to a given Elementary object.
2360 * @param obj The Elementary object to operate on.
2361 * @param enable @c EINA_TRUE Set focus to a given object,
2362 * @c EINA_FALSE Unset focus to a given object.
2364 * @note When you set focus to this object, if it can handle focus, will
2365 * take the focus away from the one who had it previously and will, for
2366 * now on, be the one receiving input events. Unsetting focus will remove
2367 * the focus from @p obj, passing it back to the previous element in the
2370 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2374 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2377 * Make a given Elementary object the focused one.
2379 * @param obj The Elementary object to make focused.
2381 * @note This object, if it can handle focus, will take the focus
2382 * away from the one who had it previously and will, for now on, be
2383 * the one receiving input events.
2385 * @see elm_object_focus_get()
2389 EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2392 * Remove the focus from an Elementary object
2394 * @param obj The Elementary to take focus from
2396 * This removes the focus from @p obj, passing it back to the
2397 * previous element in the focus chain list.
2399 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2403 EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2406 * Set the ability for an Element object to be focused
2408 * @param obj The Elementary object to operate on
2409 * @param enable @c EINA_TRUE if the object can be focused, @c
2410 * EINA_FALSE if not (and on errors)
2412 * This sets whether the object @p obj is able to take focus or
2413 * not. Unfocusable objects do nothing when programmatically
2414 * focused, being the nearest focusable parent object the one
2415 * really getting focus. Also, when they receive mouse input, they
2416 * will get the event, but not take away the focus from where it
2421 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2424 * Get whether an Elementary object is focusable or not
2426 * @param obj The Elementary object to operate on
2427 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2428 * EINA_FALSE if not (and on errors)
2430 * @note Objects which are meant to be interacted with by input
2431 * events are created able to be focused, by default. All the
2436 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2439 * Set custom focus chain.
2441 * This function overwrites any previous custom focus chain within
2442 * the list of objects. The previous list will be deleted and this list
2443 * will be managed by elementary. After it is set, don't modify it.
2445 * @note On focus cycle, only will be evaluated children of this container.
2447 * @param obj The container object
2448 * @param objs Chain of objects to pass focus
2451 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2454 * Unset a custom focus chain on a given Elementary widget
2456 * @param obj The container object to remove focus chain from
2458 * Any focus chain previously set on @p obj (for its child objects)
2459 * is removed entirely after this call.
2463 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2466 * Get custom focus chain
2468 * @param obj The container object
2471 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2474 * Append object to custom focus chain.
2476 * @note If relative_child equal to NULL or not in custom chain, the object
2477 * will be added in end.
2479 * @note On focus cycle, only will be evaluated children of this container.
2481 * @param obj The container object
2482 * @param child The child to be added in custom chain
2483 * @param relative_child The relative object to position the child
2486 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2489 * Prepend object to custom focus chain.
2491 * @note If relative_child equal to NULL or not in custom chain, the object
2492 * will be added in begin.
2494 * @note On focus cycle, only will be evaluated children of this container.
2496 * @param obj The container object
2497 * @param child The child to be added in custom chain
2498 * @param relative_child The relative object to position the child
2501 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2504 * Give focus to next object in object tree.
2506 * Give focus to next object in focus chain of one object sub-tree.
2507 * If the last object of chain already have focus, the focus will go to the
2508 * first object of chain.
2510 * @param obj The object root of sub-tree
2511 * @param dir Direction to cycle the focus
2515 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2518 * Give focus to near object in one direction.
2520 * Give focus to near object in direction of one object.
2521 * If none focusable object in given direction, the focus will not change.
2523 * @param obj The reference object
2524 * @param x Horizontal component of direction to focus
2525 * @param y Vertical component of direction to focus
2529 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2532 * Make the elementary object and its children to be unfocusable
2535 * @param obj The Elementary object to operate on
2536 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2537 * @c EINA_FALSE for focusable.
2539 * This sets whether the object @p obj and its children objects
2540 * are able to take focus or not. If the tree is set as unfocusable,
2541 * newest focused object which is not in this tree will get focus.
2542 * This API can be helpful for an object to be deleted.
2543 * When an object will be deleted soon, it and its children may not
2544 * want to get focus (by focus reverting or by other focus controls).
2545 * Then, just use this API before deleting.
2547 * @see elm_object_tree_unfocusable_get()
2551 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2554 * Get whether an Elementary object and its children are unfocusable or not.
2556 * @param obj The Elementary object to get the information from
2557 * @return @c EINA_TRUE, if the tree is unfocussable,
2558 * @c EINA_FALSE if not (and on errors).
2560 * @see elm_object_tree_unfocusable_set()
2564 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2567 * @defgroup Scrolling Scrolling
2569 * These are functions setting how scrollable views in Elementary
2570 * widgets should behave on user interaction.
2576 * Get whether scrollers should bounce when they reach their
2577 * viewport's edge during a scroll.
2579 * @return the thumb scroll bouncing state
2581 * This is the default behavior for touch screens, in general.
2582 * @ingroup Scrolling
2584 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2587 * Set whether scrollers should bounce when they reach their
2588 * viewport's edge during a scroll.
2590 * @param enabled the thumb scroll bouncing state
2592 * @see elm_thumbscroll_bounce_enabled_get()
2593 * @ingroup Scrolling
2595 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2598 * Set whether scrollers should bounce when they reach their
2599 * viewport's edge during a scroll, for all Elementary application
2602 * @param enabled the thumb scroll bouncing state
2604 * @see elm_thumbscroll_bounce_enabled_get()
2605 * @ingroup Scrolling
2607 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2610 * Get the amount of inertia a scroller will impose at bounce
2613 * @return the thumb scroll bounce friction
2615 * @ingroup Scrolling
2617 EAPI double elm_scroll_bounce_friction_get(void);
2620 * Set the amount of inertia a scroller will impose at bounce
2623 * @param friction the thumb scroll bounce friction
2625 * @see elm_thumbscroll_bounce_friction_get()
2626 * @ingroup Scrolling
2628 EAPI void elm_scroll_bounce_friction_set(double friction);
2631 * Set the amount of inertia a scroller will impose at bounce
2632 * animations, for all Elementary application windows.
2634 * @param friction the thumb scroll bounce friction
2636 * @see elm_thumbscroll_bounce_friction_get()
2637 * @ingroup Scrolling
2639 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2642 * Get the amount of inertia a <b>paged</b> scroller will impose at
2643 * page fitting animations.
2645 * @return the page scroll friction
2647 * @ingroup Scrolling
2649 EAPI double elm_scroll_page_scroll_friction_get(void);
2652 * Set the amount of inertia a <b>paged</b> scroller will impose at
2653 * page fitting animations.
2655 * @param friction the page scroll friction
2657 * @see elm_thumbscroll_page_scroll_friction_get()
2658 * @ingroup Scrolling
2660 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2663 * Set the amount of inertia a <b>paged</b> scroller will impose at
2664 * page fitting animations, for all Elementary application windows.
2666 * @param friction the page scroll friction
2668 * @see elm_thumbscroll_page_scroll_friction_get()
2669 * @ingroup Scrolling
2671 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2674 * Get the amount of inertia a scroller will impose at region bring
2677 * @return the bring in scroll friction
2679 * @ingroup Scrolling
2681 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2684 * Set the amount of inertia a scroller will impose at region bring
2687 * @param friction the bring in scroll friction
2689 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2690 * @ingroup Scrolling
2692 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2695 * Set the amount of inertia a scroller will impose at region bring
2696 * animations, for all Elementary application windows.
2698 * @param friction the bring in scroll friction
2700 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2701 * @ingroup Scrolling
2703 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2706 * Get the amount of inertia scrollers will impose at animations
2707 * triggered by Elementary widgets' zooming API.
2709 * @return the zoom friction
2711 * @ingroup Scrolling
2713 EAPI double elm_scroll_zoom_friction_get(void);
2716 * Set the amount of inertia scrollers will impose at animations
2717 * triggered by Elementary widgets' zooming API.
2719 * @param friction the zoom friction
2721 * @see elm_thumbscroll_zoom_friction_get()
2722 * @ingroup Scrolling
2724 EAPI void elm_scroll_zoom_friction_set(double friction);
2727 * Set the amount of inertia scrollers will impose at animations
2728 * triggered by Elementary widgets' zooming API, for all Elementary
2729 * application windows.
2731 * @param friction the zoom friction
2733 * @see elm_thumbscroll_zoom_friction_get()
2734 * @ingroup Scrolling
2736 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2739 * Get whether scrollers should be draggable from any point in their
2742 * @return the thumb scroll state
2744 * @note This is the default behavior for touch screens, in general.
2745 * @note All other functions namespaced with "thumbscroll" will only
2746 * have effect if this mode is enabled.
2748 * @ingroup Scrolling
2750 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2753 * Set whether scrollers should be draggable from any point in their
2756 * @param enabled the thumb scroll state
2758 * @see elm_thumbscroll_enabled_get()
2759 * @ingroup Scrolling
2761 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2764 * Set whether scrollers should be draggable from any point in their
2765 * views, for all Elementary application windows.
2767 * @param enabled the thumb scroll state
2769 * @see elm_thumbscroll_enabled_get()
2770 * @ingroup Scrolling
2772 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2775 * Get the number of pixels one should travel while dragging a
2776 * scroller's view to actually trigger scrolling.
2778 * @return the thumb scroll threshould
2780 * One would use higher values for touch screens, in general, because
2781 * of their inherent imprecision.
2782 * @ingroup Scrolling
2784 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2787 * Set the number of pixels one should travel while dragging a
2788 * scroller's view to actually trigger scrolling.
2790 * @param threshold the thumb scroll threshould
2792 * @see elm_thumbscroll_threshould_get()
2793 * @ingroup Scrolling
2795 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2798 * Set the number of pixels one should travel while dragging a
2799 * scroller's view to actually trigger scrolling, for all Elementary
2800 * application windows.
2802 * @param threshold the thumb scroll threshould
2804 * @see elm_thumbscroll_threshould_get()
2805 * @ingroup Scrolling
2807 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2810 * Get the minimum speed of mouse cursor movement which will trigger
2811 * list self scrolling animation after a mouse up event
2814 * @return the thumb scroll momentum threshould
2816 * @ingroup Scrolling
2818 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2821 * Set the minimum speed of mouse cursor movement which will trigger
2822 * list self scrolling animation after a mouse up event
2825 * @param threshold the thumb scroll momentum threshould
2827 * @see elm_thumbscroll_momentum_threshould_get()
2828 * @ingroup Scrolling
2830 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2833 * Set the minimum speed of mouse cursor movement which will trigger
2834 * list self scrolling animation after a mouse up event
2835 * (pixels/second), for all Elementary application windows.
2837 * @param threshold the thumb scroll momentum threshould
2839 * @see elm_thumbscroll_momentum_threshould_get()
2840 * @ingroup Scrolling
2842 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2845 * Get the amount of inertia a scroller will impose at self scrolling
2848 * @return the thumb scroll friction
2850 * @ingroup Scrolling
2852 EAPI double elm_scroll_thumbscroll_friction_get(void);
2855 * Set the amount of inertia a scroller will impose at self scrolling
2858 * @param friction the thumb scroll friction
2860 * @see elm_thumbscroll_friction_get()
2861 * @ingroup Scrolling
2863 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
2866 * Set the amount of inertia a scroller will impose at self scrolling
2867 * animations, for all Elementary application windows.
2869 * @param friction the thumb scroll friction
2871 * @see elm_thumbscroll_friction_get()
2872 * @ingroup Scrolling
2874 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
2877 * Get the amount of lag between your actual mouse cursor dragging
2878 * movement and a scroller's view movement itself, while pushing it
2879 * into bounce state manually.
2881 * @return the thumb scroll border friction
2883 * @ingroup Scrolling
2885 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
2888 * Set the amount of lag between your actual mouse cursor dragging
2889 * movement and a scroller's view movement itself, while pushing it
2890 * into bounce state manually.
2892 * @param friction the thumb scroll border friction. @c 0.0 for
2893 * perfect synchrony between two movements, @c 1.0 for maximum
2896 * @see elm_thumbscroll_border_friction_get()
2897 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2899 * @ingroup Scrolling
2901 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
2904 * Set the amount of lag between your actual mouse cursor dragging
2905 * movement and a scroller's view movement itself, while pushing it
2906 * into bounce state manually, for all Elementary application windows.
2908 * @param friction the thumb scroll border friction. @c 0.0 for
2909 * perfect synchrony between two movements, @c 1.0 for maximum
2912 * @see elm_thumbscroll_border_friction_get()
2913 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2915 * @ingroup Scrolling
2917 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
2920 * Get the sensitivity amount which is be multiplied by the length of
2923 * @return the thumb scroll sensitivity friction
2925 * @ingroup Scrolling
2927 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
2930 * Set the sensitivity amount which is be multiplied by the length of
2933 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2934 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2937 * @see elm_thumbscroll_sensitivity_friction_get()
2938 * @note parameter value will get bound to 0.1 - 1.0 interval, always
2940 * @ingroup Scrolling
2942 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
2945 * Set the sensitivity amount which is be multiplied by the length of
2946 * mouse dragging, for all Elementary application windows.
2948 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2949 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2952 * @see elm_thumbscroll_sensitivity_friction_get()
2953 * @note parameter value will get bound to 0.1 - 1.0 interval, always
2955 * @ingroup Scrolling
2957 EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
2964 * @defgroup Scrollhints Scrollhints
2966 * Objects when inside a scroller can scroll, but this may not always be
2967 * desirable in certain situations. This allows an object to hint to itself
2968 * and parents to "not scroll" in one of 2 ways. If any child object of a
2969 * scroller has pushed a scroll freeze or hold then it affects all parent
2970 * scrollers until all children have released them.
2972 * 1. To hold on scrolling. This means just flicking and dragging may no
2973 * longer scroll, but pressing/dragging near an edge of the scroller will
2974 * still scroll. This is automatically used by the entry object when
2977 * 2. To totally freeze scrolling. This means it stops. until
2984 * Push the scroll hold by 1
2986 * This increments the scroll hold count by one. If it is more than 0 it will
2987 * take effect on the parents of the indicated object.
2989 * @param obj The object
2990 * @ingroup Scrollhints
2992 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2995 * Pop the scroll hold by 1
2997 * This decrements the scroll hold count by one. If it is more than 0 it will
2998 * take effect on the parents of the indicated object.
3000 * @param obj The object
3001 * @ingroup Scrollhints
3003 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3006 * Push the scroll freeze by 1
3008 * This increments the scroll freeze count by one. If it is more
3009 * than 0 it will take effect on the parents of the indicated
3012 * @param obj The object
3013 * @ingroup Scrollhints
3015 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3018 * Pop the scroll freeze by 1
3020 * This decrements the scroll freeze count by one. If it is more
3021 * than 0 it will take effect on the parents of the indicated
3024 * @param obj The object
3025 * @ingroup Scrollhints
3027 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3030 * Lock the scrolling of the given widget (and thus all parents)
3032 * This locks the given object from scrolling in the X axis (and implicitly
3033 * also locks all parent scrollers too from doing the same).
3035 * @param obj The object
3036 * @param lock The lock state (1 == locked, 0 == unlocked)
3037 * @ingroup Scrollhints
3039 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3042 * Lock the scrolling of the given widget (and thus all parents)
3044 * This locks the given object from scrolling in the Y axis (and implicitly
3045 * also locks all parent scrollers too from doing the same).
3047 * @param obj The object
3048 * @param lock The lock state (1 == locked, 0 == unlocked)
3049 * @ingroup Scrollhints
3051 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3054 * Get the scrolling lock of the given widget
3056 * This gets the lock for X axis scrolling.
3058 * @param obj The object
3059 * @ingroup Scrollhints
3061 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3064 * Get the scrolling lock of the given widget
3066 * This gets the lock for X axis scrolling.
3068 * @param obj The object
3069 * @ingroup Scrollhints
3071 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3078 * Send a signal to the widget edje object.
3080 * This function sends a signal to the edje object of the obj. An
3081 * edje program can respond to a signal by specifying matching
3082 * 'signal' and 'source' fields.
3084 * @param obj The object
3085 * @param emission The signal's name.
3086 * @param source The signal's source.
3089 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3092 * Add a callback for a signal emitted by widget edje object.
3094 * This function connects a callback function to a signal emitted by the
3095 * edje object of the obj.
3096 * Globs can occur in either the emission or source name.
3098 * @param obj The object
3099 * @param emission The signal's name.
3100 * @param source The signal's source.
3101 * @param func The callback function to be executed when the signal is
3103 * @param data A pointer to data to pass in to the callback function.
3106 EAPI void elm_object_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func, void *data) EINA_ARG_NONNULL(1, 4);
3109 * Remove a signal-triggered callback from a widget edje object.
3111 * This function removes a callback, previoulsy attached to a
3112 * signal emitted by the edje object of the obj. The parameters
3113 * emission, source and func must match exactly those passed to a
3114 * previous call to elm_object_signal_callback_add(). The data
3115 * pointer that was passed to this call will be returned.
3117 * @param obj The object
3118 * @param emission The signal's name.
3119 * @param source The signal's source.
3120 * @param func The callback function to be executed when the signal is
3122 * @return The data pointer
3125 EAPI void *elm_object_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func) EINA_ARG_NONNULL(1, 4);
3128 * Add a callback for input events (key up, key down, mouse wheel)
3129 * on a given Elementary widget
3131 * @param obj The widget to add an event callback on
3132 * @param func The callback function to be executed when the event
3134 * @param data Data to pass in to @p func
3136 * Every widget in an Elementary interface set to receive focus,
3137 * with elm_object_focus_allow_set(), will propagate @b all of its
3138 * key up, key down and mouse wheel input events up to its parent
3139 * object, and so on. All of the focusable ones in this chain which
3140 * had an event callback set, with this call, will be able to treat
3141 * those events. There are two ways of making the propagation of
3142 * these event upwards in the tree of widgets to @b cease:
3143 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3144 * the event was @b not processed, so the propagation will go on.
3145 * - The @c event_info pointer passed to @p func will contain the
3146 * event's structure and, if you OR its @c event_flags inner
3147 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3148 * one has already handled it, thus killing the event's
3151 * @note Your event callback will be issued on those events taking
3152 * place only if no other child widget of @obj has consumed the
3155 * @note Not to be confused with @c
3156 * evas_object_event_callback_add(), which will add event callbacks
3157 * per type on general Evas objects (no event propagation
3158 * infrastructure taken in account).
3160 * @note Not to be confused with @c
3161 * elm_object_signal_callback_add(), which will add callbacks to @b
3162 * signals coming from a widget's theme, not input events.
3164 * @note Not to be confused with @c
3165 * edje_object_signal_callback_add(), which does the same as
3166 * elm_object_signal_callback_add(), but directly on an Edje
3169 * @note Not to be confused with @c
3170 * evas_object_smart_callback_add(), which adds callbacks to smart
3171 * objects' <b>smart events</b>, and not input events.
3173 * @see elm_object_event_callback_del()
3177 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3180 * Remove an event callback from a widget.
3182 * This function removes a callback, previoulsy attached to event emission
3184 * The parameters func and data must match exactly those passed to
3185 * a previous call to elm_object_event_callback_add(). The data pointer that
3186 * was passed to this call will be returned.
3188 * @param obj The object
3189 * @param func The callback function to be executed when the event is
3191 * @param data Data to pass in to the callback function.
3192 * @return The data pointer
3195 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3198 * Adjust size of an element for finger usage.
3200 * @param times_w How many fingers should fit horizontally
3201 * @param w Pointer to the width size to adjust
3202 * @param times_h How many fingers should fit vertically
3203 * @param h Pointer to the height size to adjust
3205 * This takes width and height sizes (in pixels) as input and a
3206 * size multiple (which is how many fingers you want to place
3207 * within the area, being "finger" the size set by
3208 * elm_finger_size_set()), and adjusts the size to be large enough
3209 * to accommodate the resulting size -- if it doesn't already
3210 * accommodate it. On return the @p w and @p h sizes pointed to by
3211 * these parameters will be modified, on those conditions.
3213 * @note This is kind of a low level Elementary call, most useful
3214 * on size evaluation times for widgets. An external user wouldn't
3215 * be calling, most of the time.
3219 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3222 * Get the duration for occuring long press event.
3224 * @return Timeout for long press event
3225 * @ingroup Longpress
3227 EAPI double elm_longpress_timeout_get(void);
3230 * Set the duration for occuring long press event.
3232 * @param lonpress_timeout Timeout for long press event
3233 * @ingroup Longpress
3235 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3238 * @defgroup Debug Debug
3239 * don't use it unless you are sure
3245 * Print Tree object hierarchy in stdout
3247 * @param obj The root object
3250 EAPI void elm_object_tree_dump(const Evas_Object *top);
3251 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3253 EAPI void elm_autocapitalization_allow_all_set(Eina_Bool autocap);
3254 EAPI void elm_autoperiod_allow_all_set(Eina_Bool autoperiod);
3256 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3258 * @param obj The root object
3259 * @param file The path of output file
3262 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3269 * @defgroup Theme Theme
3271 * Elementary uses Edje to theme its widgets, naturally. But for the most
3272 * part this is hidden behind a simpler interface that lets the user set
3273 * extensions and choose the style of widgets in a much easier way.
3275 * Instead of thinking in terms of paths to Edje files and their groups
3276 * each time you want to change the appearance of a widget, Elementary
3277 * works so you can add any theme file with extensions or replace the
3278 * main theme at one point in the application, and then just set the style
3279 * of widgets with elm_object_style_set() and related functions. Elementary
3280 * will then look in its list of themes for a matching group and apply it,
3281 * and when the theme changes midway through the application, all widgets
3282 * will be updated accordingly.
3284 * There are three concepts you need to know to understand how Elementary
3285 * theming works: default theme, extensions and overlays.
3287 * Default theme, obviously enough, is the one that provides the default
3288 * look of all widgets. End users can change the theme used by Elementary
3289 * by setting the @c ELM_THEME environment variable before running an
3290 * application, or globally for all programs using the @c elementary_config
3291 * utility. Applications can change the default theme using elm_theme_set(),
3292 * but this can go against the user wishes, so it's not an adviced practice.
3294 * Ideally, applications should find everything they need in the already
3295 * provided theme, but there may be occasions when that's not enough and
3296 * custom styles are required to correctly express the idea. For this
3297 * cases, Elementary has extensions.
3299 * Extensions allow the application developer to write styles of its own
3300 * to apply to some widgets. This requires knowledge of how each widget
3301 * is themed, as extensions will always replace the entire group used by
3302 * the widget, so important signals and parts need to be there for the
3303 * object to behave properly (see documentation of Edje for details).
3304 * Once the theme for the extension is done, the application needs to add
3305 * it to the list of themes Elementary will look into, using
3306 * elm_theme_extension_add(), and set the style of the desired widgets as
3307 * he would normally with elm_object_style_set().
3309 * Overlays, on the other hand, can replace the look of all widgets by
3310 * overriding the default style. Like extensions, it's up to the application
3311 * developer to write the theme for the widgets it wants, the difference
3312 * being that when looking for the theme, Elementary will check first the
3313 * list of overlays, then the set theme and lastly the list of extensions,
3314 * so with overlays it's possible to replace the default view and every
3315 * widget will be affected. This is very much alike to setting the whole
3316 * theme for the application and will probably clash with the end user
3317 * options, not to mention the risk of ending up with not matching styles
3318 * across the program. Unless there's a very special reason to use them,
3319 * overlays should be avoided for the resons exposed before.
3321 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3322 * keeps one default internally and every function that receives one of
3323 * these can be called with NULL to refer to this default (except for
3324 * elm_theme_free()). It's possible to create a new instance of a
3325 * ::Elm_Theme to set other theme for a specific widget (and all of its
3326 * children), but this is as discouraged, if not even more so, than using
3327 * overlays. Don't use this unless you really know what you are doing.
3329 * But to be less negative about things, you can look at the following
3331 * @li @ref theme_example_01 "Using extensions"
3332 * @li @ref theme_example_02 "Using overlays"
3337 * @typedef Elm_Theme
3339 * Opaque handler for the list of themes Elementary looks for when
3340 * rendering widgets.
3342 * Stay out of this unless you really know what you are doing. For most
3343 * cases, sticking to the default is all a developer needs.
3345 typedef struct _Elm_Theme Elm_Theme;
3348 * Create a new specific theme
3350 * This creates an empty specific theme that only uses the default theme. A
3351 * specific theme has its own private set of extensions and overlays too
3352 * (which are empty by default). Specific themes do not fall back to themes
3353 * of parent objects. They are not intended for this use. Use styles, overlays
3354 * and extensions when needed, but avoid specific themes unless there is no
3355 * other way (example: you want to have a preview of a new theme you are
3356 * selecting in a "theme selector" window. The preview is inside a scroller
3357 * and should display what the theme you selected will look like, but not
3358 * actually apply it yet. The child of the scroller will have a specific
3359 * theme set to show this preview before the user decides to apply it to all
3362 EAPI Elm_Theme *elm_theme_new(void);
3364 * Free a specific theme
3366 * @param th The theme to free
3368 * This frees a theme created with elm_theme_new().
3370 EAPI void elm_theme_free(Elm_Theme *th);
3372 * Copy the theme fom the source to the destination theme
3374 * @param th The source theme to copy from
3375 * @param thdst The destination theme to copy data to
3377 * This makes a one-time static copy of all the theme config, extensions
3378 * and overlays from @p th to @p thdst. If @p th references a theme, then
3379 * @p thdst is also set to reference it, with all the theme settings,
3380 * overlays and extensions that @p th had.
3382 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3384 * Tell the source theme to reference the ref theme
3386 * @param th The theme that will do the referencing
3387 * @param thref The theme that is the reference source
3389 * This clears @p th to be empty and then sets it to refer to @p thref
3390 * so @p th acts as an override to @p thref, but where its overrides
3391 * don't apply, it will fall through to @p thref for configuration.
3393 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3395 * Return the theme referred to
3397 * @param th The theme to get the reference from
3398 * @return The referenced theme handle
3400 * This gets the theme set as the reference theme by elm_theme_ref_set().
3401 * If no theme is set as a reference, NULL is returned.
3403 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3405 * Return the default theme
3407 * @return The default theme handle
3409 * This returns the internal default theme setup handle that all widgets
3410 * use implicitly unless a specific theme is set. This is also often use
3411 * as a shorthand of NULL.
3413 EAPI Elm_Theme *elm_theme_default_get(void);
3415 * Prepends a theme overlay to the list of overlays
3417 * @param th The theme to add to, or if NULL, the default theme
3418 * @param item The Edje file path to be used
3420 * Use this if your application needs to provide some custom overlay theme
3421 * (An Edje file that replaces some default styles of widgets) where adding
3422 * new styles, or changing system theme configuration is not possible. Do
3423 * NOT use this instead of a proper system theme configuration. Use proper
3424 * configuration files, profiles, environment variables etc. to set a theme
3425 * so that the theme can be altered by simple confiugration by a user. Using
3426 * this call to achieve that effect is abusing the API and will create lots
3429 * @see elm_theme_extension_add()
3431 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3433 * Delete a theme overlay from the list of overlays
3435 * @param th The theme to delete from, or if NULL, the default theme
3436 * @param item The name of the theme overlay
3438 * @see elm_theme_overlay_add()
3440 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3442 * Appends a theme extension to the list of extensions.
3444 * @param th The theme to add to, or if NULL, the default theme
3445 * @param item The Edje file path to be used
3447 * This is intended when an application needs more styles of widgets or new
3448 * widget themes that the default does not provide (or may not provide). The
3449 * application has "extended" usage by coming up with new custom style names
3450 * for widgets for specific uses, but as these are not "standard", they are
3451 * not guaranteed to be provided by a default theme. This means the
3452 * application is required to provide these extra elements itself in specific
3453 * Edje files. This call adds one of those Edje files to the theme search
3454 * path to be search after the default theme. The use of this call is
3455 * encouraged when default styles do not meet the needs of the application.
3456 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3458 * @see elm_object_style_set()
3460 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3462 * Deletes a theme extension from the list of extensions.
3464 * @param th The theme to delete from, or if NULL, the default theme
3465 * @param item The name of the theme extension
3467 * @see elm_theme_extension_add()
3469 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3471 * Set the theme search order for the given theme
3473 * @param th The theme to set the search order, or if NULL, the default theme
3474 * @param theme Theme search string
3476 * This sets the search string for the theme in path-notation from first
3477 * theme to search, to last, delimited by the : character. Example:
3479 * "shiny:/path/to/file.edj:default"
3481 * See the ELM_THEME environment variable for more information.
3483 * @see elm_theme_get()
3484 * @see elm_theme_list_get()
3486 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3488 * Return the theme search order
3490 * @param th The theme to get the search order, or if NULL, the default theme
3491 * @return The internal search order path
3493 * This function returns a colon separated string of theme elements as
3494 * returned by elm_theme_list_get().
3496 * @see elm_theme_set()
3497 * @see elm_theme_list_get()
3499 EAPI const char *elm_theme_get(Elm_Theme *th);
3501 * Return a list of theme elements to be used in a theme.
3503 * @param th Theme to get the list of theme elements from.
3504 * @return The internal list of theme elements
3506 * This returns the internal list of theme elements (will only be valid as
3507 * long as the theme is not modified by elm_theme_set() or theme is not
3508 * freed by elm_theme_free(). This is a list of strings which must not be
3509 * altered as they are also internal. If @p th is NULL, then the default
3510 * theme element list is returned.
3512 * A theme element can consist of a full or relative path to a .edj file,
3513 * or a name, without extension, for a theme to be searched in the known
3514 * theme paths for Elemementary.
3516 * @see elm_theme_set()
3517 * @see elm_theme_get()
3519 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3521 * Return the full patrh for a theme element
3523 * @param f The theme element name
3524 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3525 * @return The full path to the file found.
3527 * This returns a string you should free with free() on success, NULL on
3528 * failure. This will search for the given theme element, and if it is a
3529 * full or relative path element or a simple searchable name. The returned
3530 * path is the full path to the file, if searched, and the file exists, or it
3531 * is simply the full path given in the element or a resolved path if
3532 * relative to home. The @p in_search_path boolean pointed to is set to
3533 * EINA_TRUE if the file was a searchable file andis in the search path,
3534 * and EINA_FALSE otherwise.
3536 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3538 * Flush the current theme.
3540 * @param th Theme to flush
3542 * This flushes caches that let elementary know where to find theme elements
3543 * in the given theme. If @p th is NULL, then the default theme is flushed.
3544 * Call this function if source theme data has changed in such a way as to
3545 * make any caches Elementary kept invalid.
3547 EAPI void elm_theme_flush(Elm_Theme *th);
3549 * This flushes all themes (default and specific ones).
3551 * This will flush all themes in the current application context, by calling
3552 * elm_theme_flush() on each of them.
3554 EAPI void elm_theme_full_flush(void);
3556 * Set the theme for all elementary using applications on the current display
3558 * @param theme The name of the theme to use. Format same as the ELM_THEME
3559 * environment variable.
3561 EAPI void elm_theme_all_set(const char *theme);
3563 * Return a list of theme elements in the theme search path
3565 * @return A list of strings that are the theme element names.
3567 * This lists all available theme files in the standard Elementary search path
3568 * for theme elements, and returns them in alphabetical order as theme
3569 * element names in a list of strings. Free this with
3570 * elm_theme_name_available_list_free() when you are done with the list.
3572 EAPI Eina_List *elm_theme_name_available_list_new(void);
3574 * Free the list returned by elm_theme_name_available_list_new()
3576 * This frees the list of themes returned by
3577 * elm_theme_name_available_list_new(). Once freed the list should no longer
3578 * be used. a new list mys be created.
3580 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3582 * Set a specific theme to be used for this object and its children
3584 * @param obj The object to set the theme on
3585 * @param th The theme to set
3587 * This sets a specific theme that will be used for the given object and any
3588 * child objects it has. If @p th is NULL then the theme to be used is
3589 * cleared and the object will inherit its theme from its parent (which
3590 * ultimately will use the default theme if no specific themes are set).
3592 * Use special themes with great care as this will annoy users and make
3593 * configuration difficult. Avoid any custom themes at all if it can be
3596 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3598 * Get the specific theme to be used
3600 * @param obj The object to get the specific theme from
3601 * @return The specifc theme set.
3603 * This will return a specific theme set, or NULL if no specific theme is
3604 * set on that object. It will not return inherited themes from parents, only
3605 * the specific theme set for that specific object. See elm_object_theme_set()
3606 * for more information.
3608 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3611 * Get a data item from a theme
3613 * @param th The theme, or NULL for default theme
3614 * @param key The data key to search with
3615 * @return The data value, or NULL on failure
3617 * This function is used to return data items from edc in @p th, an overlay, or an extension.
3618 * It works the same way as edje_file_data_get() except that the return is stringshared.
3620 EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3626 /** @defgroup Win Win
3628 * @image html img/widget/win/preview-00.png
3629 * @image latex img/widget/win/preview-00.eps
3631 * The window class of Elementary. Contains functions to manipulate
3632 * windows. The Evas engine used to render the window contents is specified
3633 * in the system or user elementary config files (whichever is found last),
3634 * and can be overridden with the ELM_ENGINE environment variable for
3635 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3636 * compilation setup and modules actually installed at runtime) are (listed
3637 * in order of best supported and most likely to be complete and work to
3640 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3641 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3643 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3645 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3647 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3649 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3650 * rendering using SDL as the buffer)
3651 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3652 * GDI with software)
3653 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3654 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3655 * grayscale using dedicated 8bit software engine in X11)
3656 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3657 * X11 using 16bit software engine)
3658 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3659 * (Windows CE rendering via GDI with 16bit software renderer)
3660 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3661 * buffer with 16bit software renderer)
3662 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3663 * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3664 * @li "psl1ght" (PS3 rendering using PSL1GHT)
3666 * All engines use a simple string to select the engine to render, EXCEPT
3667 * the "shot" engine. This actually encodes the output of the virtual
3668 * screenshot and how long to delay in the engine string. The engine string
3669 * is encoded in the following way:
3671 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3673 * Where options are separated by a ":" char if more than one option is
3674 * given, with delay, if provided being the first option and file the last
3675 * (order is important). The delay specifies how long to wait after the
3676 * window is shown before doing the virtual "in memory" rendering and then
3677 * save the output to the file specified by the file option (and then exit).
3678 * If no delay is given, the default is 0.5 seconds. If no file is given the
3679 * default output file is "out.png". Repeat option is for continous
3680 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3681 * fixed to "out001.png" Some examples of using the shot engine:
3683 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3684 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3685 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3686 * ELM_ENGINE="shot:delay=2.0" elementary_test
3687 * ELM_ENGINE="shot:" elementary_test
3689 * Signals that you can add callbacks for are:
3691 * @li "delete,request": the user requested to close the window. See
3692 * elm_win_autodel_set().
3693 * @li "focus,in": window got focus
3694 * @li "focus,out": window lost focus
3695 * @li "moved": window that holds the canvas was moved
3698 * @li @ref win_example_01
3703 * Defines the types of window that can be created
3705 * These are hints set on the window so that a running Window Manager knows
3706 * how the window should be handled and/or what kind of decorations it
3709 * Currently, only the X11 backed engines use them.
3711 typedef enum _Elm_Win_Type
3713 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3714 window. Almost every window will be created with this
3716 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3717 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3718 window holding desktop icons. */
3719 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3720 be kept on top of any other window by the Window
3722 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3724 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3725 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3727 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3728 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3729 entry in a menubar is clicked. Typically used
3730 with elm_win_override_set(). This hint exists
3731 for completion only, as the EFL way of
3732 implementing a menu would not normally use a
3733 separate window for its contents. */
3734 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3735 triggered by right-clicking an object. */
3736 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3737 explanatory text that typically appear after the
3738 mouse cursor hovers over an object for a while.
3739 Typically used with elm_win_override_set() and also
3740 not very commonly used in the EFL. */
3741 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3742 battery life or a new E-Mail received. */
3743 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3744 usually used in the EFL. */
3745 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3746 object being dragged across different windows, or even
3747 applications. Typically used with
3748 elm_win_override_set(). */
3749 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3750 buffer. No actual window is created for this
3751 type, instead the window and all of its
3752 contents will be rendered to an image buffer.
3753 This allows to have children window inside a
3754 parent one just like any other object would
3755 be, and do other things like applying @c
3756 Evas_Map effects to it. This is the only type
3757 of window that requires the @c parent
3758 parameter of elm_win_add() to be a valid @c
3763 * The differents layouts that can be requested for the virtual keyboard.
3765 * When the application window is being managed by Illume, it may request
3766 * any of the following layouts for the virtual keyboard.
3768 typedef enum _Elm_Win_Keyboard_Mode
3770 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3771 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3772 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3773 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3774 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3775 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3776 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3777 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3778 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3779 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3780 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3781 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3782 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3783 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3784 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3785 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3786 } Elm_Win_Keyboard_Mode;
3789 * Available commands that can be sent to the Illume manager.
3791 * When running under an Illume session, a window may send commands to the
3792 * Illume manager to perform different actions.
3794 typedef enum _Elm_Illume_Command
3796 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3798 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3800 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3802 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3803 } Elm_Illume_Command;
3806 * Adds a window object. If this is the first window created, pass NULL as
3809 * @param parent Parent object to add the window to, or NULL
3810 * @param name The name of the window
3811 * @param type The window type, one of #Elm_Win_Type.
3813 * The @p parent paramter can be @c NULL for every window @p type except
3814 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3815 * which the image object will be created.
3817 * @return The created object, or NULL on failure
3819 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3821 * Adds a window object with standard setup
3823 * @param name The name of the window
3824 * @param title The title for the window
3826 * This creates a window like elm_win_add() but also puts in a standard
3827 * background with elm_bg_add(), as well as setting the window title to
3828 * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
3829 * as the parent widget.
3831 * @return The created object, or NULL on failure
3833 * @see elm_win_add()
3835 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
3837 * Add @p subobj as a resize object of window @p obj.
3840 * Setting an object as a resize object of the window means that the
3841 * @p subobj child's size and position will be controlled by the window
3842 * directly. That is, the object will be resized to match the window size
3843 * and should never be moved or resized manually by the developer.
3845 * In addition, resize objects of the window control what the minimum size
3846 * of it will be, as well as whether it can or not be resized by the user.
3848 * For the end user to be able to resize a window by dragging the handles
3849 * or borders provided by the Window Manager, or using any other similar
3850 * mechanism, all of the resize objects in the window should have their
3851 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3853 * @param obj The window object
3854 * @param subobj The resize object to add
3856 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3858 * Delete @p subobj as a resize object of window @p obj.
3860 * This function removes the object @p subobj from the resize objects of
3861 * the window @p obj. It will not delete the object itself, which will be
3862 * left unmanaged and should be deleted by the developer, manually handled
3863 * or set as child of some other container.
3865 * @param obj The window object
3866 * @param subobj The resize object to add
3868 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3870 * Set the title of the window
3872 * @param obj The window object
3873 * @param title The title to set
3875 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3877 * Get the title of the window
3879 * The returned string is an internal one and should not be freed or
3880 * modified. It will also be rendered invalid if a new title is set or if
3881 * the window is destroyed.
3883 * @param obj The window object
3886 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3888 * Set the window's autodel state.
3890 * When closing the window in any way outside of the program control, like
3891 * pressing the X button in the titlebar or using a command from the
3892 * Window Manager, a "delete,request" signal is emitted to indicate that
3893 * this event occurred and the developer can take any action, which may
3894 * include, or not, destroying the window object.
3896 * When the @p autodel parameter is set, the window will be automatically
3897 * destroyed when this event occurs, after the signal is emitted.
3898 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3899 * and is up to the program to do so when it's required.
3901 * @param obj The window object
3902 * @param autodel If true, the window will automatically delete itself when
3905 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3907 * Get the window's autodel state.
3909 * @param obj The window object
3910 * @return If the window will automatically delete itself when closed
3912 * @see elm_win_autodel_set()
3914 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3916 * Activate a window object.
3918 * This function sends a request to the Window Manager to activate the
3919 * window pointed by @p obj. If honored by the WM, the window will receive
3920 * the keyboard focus.
3922 * @note This is just a request that a Window Manager may ignore, so calling
3923 * this function does not ensure in any way that the window will be the
3924 * active one after it.
3926 * @param obj The window object
3928 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3930 * Lower a window object.
3932 * Places the window pointed by @p obj at the bottom of the stack, so that
3933 * no other window is covered by it.
3935 * If elm_win_override_set() is not set, the Window Manager may ignore this
3938 * @param obj The window object
3940 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3942 * Raise a window object.
3944 * Places the window pointed by @p obj at the top of the stack, so that it's
3945 * not covered by any other window.
3947 * If elm_win_override_set() is not set, the Window Manager may ignore this
3950 * @param obj The window object
3952 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3954 * Set the borderless state of a window.
3956 * This function requests the Window Manager to not draw any decoration
3957 * around the window.
3959 * @param obj The window object
3960 * @param borderless If true, the window is borderless
3962 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3964 * Get the borderless state of a window.
3966 * @param obj The window object
3967 * @return If true, the window is borderless
3969 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3971 * Set the shaped state of a window.
3973 * Shaped windows, when supported, will render the parts of the window that
3974 * has no content, transparent.
3976 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3977 * background object or cover the entire window in any other way, or the
3978 * parts of the canvas that have no data will show framebuffer artifacts.
3980 * @param obj The window object
3981 * @param shaped If true, the window is shaped
3983 * @see elm_win_alpha_set()
3985 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3987 * Get the shaped state of a window.
3989 * @param obj The window object
3990 * @return If true, the window is shaped
3992 * @see elm_win_shaped_set()
3994 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3996 * Set the alpha channel state of a window.
3998 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3999 * possibly making parts of the window completely or partially transparent.
4000 * This is also subject to the underlying system supporting it, like for
4001 * example, running under a compositing manager. If no compositing is
4002 * available, enabling this option will instead fallback to using shaped
4003 * windows, with elm_win_shaped_set().
4005 * @param obj The window object
4006 * @param alpha If true, the window has an alpha channel
4008 * @see elm_win_alpha_set()
4010 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
4012 * Get the transparency state of a window.
4014 * @param obj The window object
4015 * @return If true, the window is transparent
4017 * @see elm_win_transparent_set()
4019 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4021 * Set the transparency state of a window.
4023 * Use elm_win_alpha_set() instead.
4025 * @param obj The window object
4026 * @param transparent If true, the window is transparent
4028 * @see elm_win_alpha_set()
4030 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4032 * Get the alpha channel state of a window.
4034 * @param obj The window object
4035 * @return If true, the window has an alpha channel
4037 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4039 * Set the override state of a window.
4041 * A window with @p override set to EINA_TRUE will not be managed by the
4042 * Window Manager. This means that no decorations of any kind will be shown
4043 * for it, moving and resizing must be handled by the application, as well
4044 * as the window visibility.
4046 * This should not be used for normal windows, and even for not so normal
4047 * ones, it should only be used when there's a good reason and with a lot
4048 * of care. Mishandling override windows may result situations that
4049 * disrupt the normal workflow of the end user.
4051 * @param obj The window object
4052 * @param override If true, the window is overridden
4054 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4056 * Get the override state of a window.
4058 * @param obj The window object
4059 * @return If true, the window is overridden
4061 * @see elm_win_override_set()
4063 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4065 * Set the fullscreen state of a window.
4067 * @param obj The window object
4068 * @param fullscreen If true, the window is fullscreen
4070 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4072 * Get the fullscreen state of a window.
4074 * @param obj The window object
4075 * @return If true, the window is fullscreen
4077 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4079 * Set the maximized state of a window.
4081 * @param obj The window object
4082 * @param maximized If true, the window is maximized
4084 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4086 * Get the maximized state of a window.
4088 * @param obj The window object
4089 * @return If true, the window is maximized
4091 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4093 * Set the iconified state of a window.
4095 * @param obj The window object
4096 * @param iconified If true, the window is iconified
4098 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4100 * Get the iconified state of a window.
4102 * @param obj The window object
4103 * @return If true, the window is iconified
4105 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4107 * Set the layer of the window.
4109 * What this means exactly will depend on the underlying engine used.
4111 * In the case of X11 backed engines, the value in @p layer has the
4112 * following meanings:
4113 * @li < 3: The window will be placed below all others.
4114 * @li > 5: The window will be placed above all others.
4115 * @li other: The window will be placed in the default layer.
4117 * @param obj The window object
4118 * @param layer The layer of the window
4120 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4122 * Get the layer of the window.
4124 * @param obj The window object
4125 * @return The layer of the window
4127 * @see elm_win_layer_set()
4129 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4131 * Set the rotation of the window.
4133 * Most engines only work with multiples of 90.
4135 * This function is used to set the orientation of the window @p obj to
4136 * match that of the screen. The window itself will be resized to adjust
4137 * to the new geometry of its contents. If you want to keep the window size,
4138 * see elm_win_rotation_with_resize_set().
4140 * @param obj The window object
4141 * @param rotation The rotation of the window, in degrees (0-360),
4142 * counter-clockwise.
4144 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4146 * Rotates the window and resizes it.
4148 * Like elm_win_rotation_set(), but it also resizes the window's contents so
4149 * that they fit inside the current window geometry.
4151 * @param obj The window object
4152 * @param layer The rotation of the window in degrees (0-360),
4153 * counter-clockwise.
4155 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4157 * Get the rotation of the window.
4159 * @param obj The window object
4160 * @return The rotation of the window in degrees (0-360)
4162 * @see elm_win_rotation_set()
4163 * @see elm_win_rotation_with_resize_set()
4165 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4167 * Set the sticky state of the window.
4169 * Hints the Window Manager that the window in @p obj should be left fixed
4170 * at its position even when the virtual desktop it's on moves or changes.
4172 * @param obj The window object
4173 * @param sticky If true, the window's sticky state is enabled
4175 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4177 * Get the sticky state of the window.
4179 * @param obj The window object
4180 * @return If true, the window's sticky state is enabled
4182 * @see elm_win_sticky_set()
4184 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4186 * Set if this window is an illume conformant window
4188 * @param obj The window object
4189 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4191 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4193 * Get if this window is an illume conformant window
4195 * @param obj The window object
4196 * @return A boolean if this window is illume conformant or not
4198 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4200 * Set a window to be an illume quickpanel window
4202 * By default window objects are not quickpanel windows.
4204 * @param obj The window object
4205 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4207 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4209 * Get if this window is a quickpanel or not
4211 * @param obj The window object
4212 * @return A boolean if this window is a quickpanel or not
4214 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4216 * Set the major priority of a quickpanel window
4218 * @param obj The window object
4219 * @param priority The major priority for this quickpanel
4221 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4223 * Get the major priority of a quickpanel window
4225 * @param obj The window object
4226 * @return The major priority of this quickpanel
4228 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4230 * Set the minor priority of a quickpanel window
4232 * @param obj The window object
4233 * @param priority The minor priority for this quickpanel
4235 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4237 * Get the minor priority of a quickpanel window
4239 * @param obj The window object
4240 * @return The minor priority of this quickpanel
4242 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4244 * Set which zone this quickpanel should appear in
4246 * @param obj The window object
4247 * @param zone The requested zone for this quickpanel
4249 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4251 * Get which zone this quickpanel should appear in
4253 * @param obj The window object
4254 * @return The requested zone for this quickpanel
4256 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4258 * Set the window to be skipped by keyboard focus
4260 * This sets the window to be skipped by normal keyboard input. This means
4261 * a window manager will be asked to not focus this window as well as omit
4262 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4264 * Call this and enable it on a window BEFORE you show it for the first time,
4265 * otherwise it may have no effect.
4267 * Use this for windows that have only output information or might only be
4268 * interacted with by the mouse or fingers, and never for typing input.
4269 * Be careful that this may have side-effects like making the window
4270 * non-accessible in some cases unless the window is specially handled. Use
4273 * @param obj The window object
4274 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4276 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4278 * Send a command to the windowing environment
4280 * This is intended to work in touchscreen or small screen device
4281 * environments where there is a more simplistic window management policy in
4282 * place. This uses the window object indicated to select which part of the
4283 * environment to control (the part that this window lives in), and provides
4284 * a command and an optional parameter structure (use NULL for this if not
4287 * @param obj The window object that lives in the environment to control
4288 * @param command The command to send
4289 * @param params Optional parameters for the command
4291 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4293 * Get the inlined image object handle
4295 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4296 * then the window is in fact an evas image object inlined in the parent
4297 * canvas. You can get this object (be careful to not manipulate it as it
4298 * is under control of elementary), and use it to do things like get pixel
4299 * data, save the image to a file, etc.
4301 * @param obj The window object to get the inlined image from
4302 * @return The inlined image object, or NULL if none exists
4304 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4306 * Set the enabled status for the focus highlight in a window
4308 * This function will enable or disable the focus highlight only for the
4309 * given window, regardless of the global setting for it
4311 * @param obj The window where to enable the highlight
4312 * @param enabled The enabled value for the highlight
4314 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4316 * Get the enabled value of the focus highlight for this window
4318 * @param obj The window in which to check if the focus highlight is enabled
4320 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4322 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4324 * Set the style for the focus highlight on this window
4326 * Sets the style to use for theming the highlight of focused objects on
4327 * the given window. If @p style is NULL, the default will be used.
4329 * @param obj The window where to set the style
4330 * @param style The style to set
4332 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4334 * Get the style set for the focus highlight object
4336 * Gets the style set for this windows highilght object, or NULL if none
4339 * @param obj The window to retrieve the highlights style from
4341 * @return The style set or NULL if none was. Default is used in that case.
4343 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4344 EAPI void elm_win_indicator_state_set(Evas_Object *obj, int show_state);
4345 EAPI int elm_win_indicator_state_get(Evas_Object *obj);
4347 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4348 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4349 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4350 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4351 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4352 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4353 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4355 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4356 * (blank mouse, private mouse obj, defaultmouse)
4360 * Sets the keyboard mode of the window.
4362 * @param obj The window object
4363 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4365 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4367 * Gets the keyboard mode of the window.
4369 * @param obj The window object
4370 * @return The mode, one of #Elm_Win_Keyboard_Mode
4372 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4374 * Sets whether the window is a keyboard.
4376 * @param obj The window object
4377 * @param is_keyboard If true, the window is a virtual keyboard
4379 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4381 * Gets whether the window is a keyboard.
4383 * @param obj The window object
4384 * @return If the window is a virtual keyboard
4386 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4389 * Get the screen position of a window.
4391 * @param obj The window object
4392 * @param x The int to store the x coordinate to
4393 * @param y The int to store the y coordinate to
4395 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4401 * @defgroup Inwin Inwin
4403 * @image html img/widget/inwin/preview-00.png
4404 * @image latex img/widget/inwin/preview-00.eps
4405 * @image html img/widget/inwin/preview-01.png
4406 * @image latex img/widget/inwin/preview-01.eps
4407 * @image html img/widget/inwin/preview-02.png
4408 * @image latex img/widget/inwin/preview-02.eps
4410 * An inwin is a window inside a window that is useful for a quick popup.
4411 * It does not hover.
4413 * It works by creating an object that will occupy the entire window, so it
4414 * must be created using an @ref Win "elm_win" as parent only. The inwin
4415 * object can be hidden or restacked below every other object if it's
4416 * needed to show what's behind it without destroying it. If this is done,
4417 * the elm_win_inwin_activate() function can be used to bring it back to
4418 * full visibility again.
4420 * There are three styles available in the default theme. These are:
4421 * @li default: The inwin is sized to take over most of the window it's
4423 * @li minimal: The size of the inwin will be the minimum necessary to show
4425 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4426 * possible, but it's sized vertically the most it needs to fit its\
4429 * Some examples of Inwin can be found in the following:
4430 * @li @ref inwin_example_01
4435 * Adds an inwin to the current window
4437 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4438 * Never call this function with anything other than the top-most window
4439 * as its parameter, unless you are fond of undefined behavior.
4441 * After creating the object, the widget will set itself as resize object
4442 * for the window with elm_win_resize_object_add(), so when shown it will
4443 * appear to cover almost the entire window (how much of it depends on its
4444 * content and the style used). It must not be added into other container
4445 * objects and it needs not be moved or resized manually.
4447 * @param parent The parent object
4448 * @return The new object or NULL if it cannot be created
4450 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4452 * Activates an inwin object, ensuring its visibility
4454 * This function will make sure that the inwin @p obj is completely visible
4455 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4456 * to the front. It also sets the keyboard focus to it, which will be passed
4459 * The object's theme will also receive the signal "elm,action,show" with
4462 * @param obj The inwin to activate
4464 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4466 * Set the content of an inwin object.
4468 * Once the content object is set, a previously set one will be deleted.
4469 * If you want to keep that old content object, use the
4470 * elm_win_inwin_content_unset() function.
4472 * @param obj The inwin object
4473 * @param content The object to set as content
4475 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4477 * Get the content of an inwin object.
4479 * Return the content object which is set for this widget.
4481 * The returned object is valid as long as the inwin is still alive and no
4482 * other content is set on it. Deleting the object will notify the inwin
4483 * about it and this one will be left empty.
4485 * If you need to remove an inwin's content to be reused somewhere else,
4486 * see elm_win_inwin_content_unset().
4488 * @param obj The inwin object
4489 * @return The content that is being used
4491 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4493 * Unset the content of an inwin object.
4495 * Unparent and return the content object which was set for this widget.
4497 * @param obj The inwin object
4498 * @return The content that was being used
4500 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4504 /* X specific calls - won't work on non-x engines (return 0) */
4507 * Get the Ecore_X_Window of an Evas_Object
4509 * @param obj The object
4511 * @return The Ecore_X_Window of @p obj
4515 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4517 /* smart callbacks called:
4518 * "delete,request" - the user requested to delete the window
4519 * "focus,in" - window got focus
4520 * "focus,out" - window lost focus
4521 * "moved" - window that holds the canvas was moved
4527 * @image html img/widget/bg/preview-00.png
4528 * @image latex img/widget/bg/preview-00.eps
4530 * @brief Background object, used for setting a solid color, image or Edje
4531 * group as background to a window or any container object.
4533 * The bg object is used for setting a solid background to a window or
4534 * packing into any container object. It works just like an image, but has
4535 * some properties useful to a background, like setting it to tiled,
4536 * centered, scaled or stretched.
4538 * Default contents parts of the bg widget that you can use for are:
4539 * @li "overlay" - overlay of the bg
4541 * Here is some sample code using it:
4542 * @li @ref bg_01_example_page
4543 * @li @ref bg_02_example_page
4544 * @li @ref bg_03_example_page
4548 typedef enum _Elm_Bg_Option
4550 ELM_BG_OPTION_CENTER, /**< center the background */
4551 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4552 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4553 ELM_BG_OPTION_TILE /**< tile background at its original size */
4557 * Add a new background to the parent
4559 * @param parent The parent object
4560 * @return The new object or NULL if it cannot be created
4564 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4567 * Set the file (image or edje) used for the background
4569 * @param obj The bg object
4570 * @param file The file path
4571 * @param group Optional key (group in Edje) within the file
4573 * This sets the image file used in the background object. The image (or edje)
4574 * will be stretched (retaining aspect if its an image file) to completely fill
4575 * the bg object. This may mean some parts are not visible.
4577 * @note Once the image of @p obj is set, a previously set one will be deleted,
4578 * even if @p file is NULL.
4582 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4585 * Get the file (image or edje) used for the background
4587 * @param obj The bg object
4588 * @param file The file path
4589 * @param group Optional key (group in Edje) within the file
4593 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4596 * Set the option used for the background image
4598 * @param obj The bg object
4599 * @param option The desired background option (TILE, SCALE)
4601 * This sets the option used for manipulating the display of the background
4602 * image. The image can be tiled or scaled.
4606 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4609 * Get the option used for the background image
4611 * @param obj The bg object
4612 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4616 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4618 * Set the option used for the background color
4620 * @param obj The bg object
4625 * This sets the color used for the background rectangle. Its range goes
4630 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4632 * Get the option used for the background color
4634 * @param obj The bg object
4641 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4644 * Set the overlay object used for the background object.
4646 * @param obj The bg object
4647 * @param overlay The overlay object
4649 * This provides a way for elm_bg to have an 'overlay' that will be on top
4650 * of the bg. Once the over object is set, a previously set one will be
4651 * deleted, even if you set the new one to NULL. If you want to keep that
4652 * old content object, use the elm_bg_overlay_unset() function.
4654 * @deprecated use elm_object_content_set() instead
4659 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4662 * Get the overlay object used for the background object.
4664 * @param obj The bg object
4665 * @return The content that is being used
4667 * Return the content object which is set for this widget
4669 * @deprecated use elm_object_part_content_get() instead
4673 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4676 * Get the overlay object used for the background object.
4678 * @param obj The bg object
4679 * @return The content that was being used
4681 * Unparent and return the overlay object which was set for this widget
4683 * @deprecated use elm_object_content_unset() instead
4687 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4690 * Set the size of the pixmap representation of the image.
4692 * This option just makes sense if an image is going to be set in the bg.
4694 * @param obj The bg object
4695 * @param w The new width of the image pixmap representation.
4696 * @param h The new height of the image pixmap representation.
4698 * This function sets a new size for pixmap representation of the given bg
4699 * image. It allows the image to be loaded already in the specified size,
4700 * reducing the memory usage and load time when loading a big image with load
4701 * size set to a smaller size.
4703 * NOTE: this is just a hint, the real size of the pixmap may differ
4704 * depending on the type of image being loaded, being bigger than requested.
4708 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4709 /* smart callbacks called:
4713 * @defgroup Icon Icon
4715 * @image html img/widget/icon/preview-00.png
4716 * @image latex img/widget/icon/preview-00.eps
4718 * An object that provides standard icon images (delete, edit, arrows, etc.)
4719 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4721 * The icon image requested can be in the elementary theme, or in the
4722 * freedesktop.org paths. It's possible to set the order of preference from
4723 * where the image will be used.
4725 * This API is very similar to @ref Image, but with ready to use images.
4727 * Default images provided by the theme are described below.
4729 * The first list contains icons that were first intended to be used in
4730 * toolbars, but can be used in many other places too:
4746 * Now some icons that were designed to be used in menus (but again, you can
4747 * use them anywhere else):
4752 * @li menu/arrow_down
4753 * @li menu/arrow_left
4754 * @li menu/arrow_right
4763 * And here we have some media player specific icons:
4764 * @li media_player/forward
4765 * @li media_player/info
4766 * @li media_player/next
4767 * @li media_player/pause
4768 * @li media_player/play
4769 * @li media_player/prev
4770 * @li media_player/rewind
4771 * @li media_player/stop
4773 * Signals that you can add callbacks for are:
4775 * "clicked" - This is called when a user has clicked the icon
4777 * An example of usage for this API follows:
4778 * @li @ref tutorial_icon
4786 typedef enum _Elm_Icon_Type
4793 * @enum _Elm_Icon_Lookup_Order
4794 * @typedef Elm_Icon_Lookup_Order
4796 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4797 * theme, FDO paths, or both?
4801 typedef enum _Elm_Icon_Lookup_Order
4803 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4804 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4805 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4806 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4807 } Elm_Icon_Lookup_Order;
4810 * Add a new icon object to the parent.
4812 * @param parent The parent object
4813 * @return The new object or NULL if it cannot be created
4815 * @see elm_icon_file_set()
4819 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4821 * Set the file that will be used as icon.
4823 * @param obj The icon object
4824 * @param file The path to file that will be used as icon image
4825 * @param group The group that the icon belongs to an edje file
4827 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4829 * @note The icon image set by this function can be changed by
4830 * elm_icon_standard_set().
4832 * @see elm_icon_file_get()
4836 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4838 * Set a location in memory to be used as an icon
4840 * @param obj The icon object
4841 * @param img The binary data that will be used as an image
4842 * @param size The size of binary data @p img
4843 * @param format Optional format of @p img to pass to the image loader
4844 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4846 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4848 * @note The icon image set by this function can be changed by
4849 * elm_icon_standard_set().
4853 EAPI Eina_Bool elm_icon_memfile_set(Evas_Object *obj, const void *img, size_t size, const char *format, const char *key); EINA_ARG_NONNULL(1, 2);
4855 * Get the file that will be used as icon.
4857 * @param obj The icon object
4858 * @param file The path to file that will be used as the icon image
4859 * @param group The group that the icon belongs to, in edje file
4861 * @see elm_icon_file_set()
4865 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4866 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4868 * Set the icon by icon standards names.
4870 * @param obj The icon object
4871 * @param name The icon name
4873 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4875 * For example, freedesktop.org defines standard icon names such as "home",
4876 * "network", etc. There can be different icon sets to match those icon
4877 * keys. The @p name given as parameter is one of these "keys", and will be
4878 * used to look in the freedesktop.org paths and elementary theme. One can
4879 * change the lookup order with elm_icon_order_lookup_set().
4881 * If name is not found in any of the expected locations and it is the
4882 * absolute path of an image file, this image will be used.
4884 * @note The icon image set by this function can be changed by
4885 * elm_icon_file_set().
4887 * @see elm_icon_standard_get()
4888 * @see elm_icon_file_set()
4892 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4894 * Get the icon name set by icon standard names.
4896 * @param obj The icon object
4897 * @return The icon name
4899 * If the icon image was set using elm_icon_file_set() instead of
4900 * elm_icon_standard_set(), then this function will return @c NULL.
4902 * @see elm_icon_standard_set()
4906 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4908 * Set the smooth scaling for an icon object.
4910 * @param obj The icon object
4911 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4912 * otherwise. Default is @c EINA_TRUE.
4914 * Set the scaling algorithm to be used when scaling the icon image. Smooth
4915 * scaling provides a better resulting image, but is slower.
4917 * The smooth scaling should be disabled when making animations that change
4918 * the icon size, since they will be faster. Animations that don't require
4919 * resizing of the icon can keep the smooth scaling enabled (even if the icon
4920 * is already scaled, since the scaled icon image will be cached).
4922 * @see elm_icon_smooth_get()
4926 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4928 * Get whether smooth scaling is enabled for an icon object.
4930 * @param obj The icon object
4931 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4933 * @see elm_icon_smooth_set()
4937 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4939 * Disable scaling of this object.
4941 * @param obj The icon object.
4942 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4943 * otherwise. Default is @c EINA_FALSE.
4945 * This function disables scaling of the icon object through the function
4946 * elm_object_scale_set(). However, this does not affect the object
4947 * size/resize in any way. For that effect, take a look at
4948 * elm_icon_scale_set().
4950 * @see elm_icon_no_scale_get()
4951 * @see elm_icon_scale_set()
4952 * @see elm_object_scale_set()
4956 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4958 * Get whether scaling is disabled on the object.
4960 * @param obj The icon object
4961 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4963 * @see elm_icon_no_scale_set()
4967 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4969 * Set if the object is (up/down) resizable.
4971 * @param obj The icon object
4972 * @param scale_up A bool to set if the object is resizable up. Default is
4974 * @param scale_down A bool to set if the object is resizable down. Default
4977 * This function limits the icon object resize ability. If @p scale_up is set to
4978 * @c EINA_FALSE, the object can't have its height or width resized to a value
4979 * higher than the original icon size. Same is valid for @p scale_down.
4981 * @see elm_icon_scale_get()
4985 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4987 * Get if the object is (up/down) resizable.
4989 * @param obj The icon object
4990 * @param scale_up A bool to set if the object is resizable up
4991 * @param scale_down A bool to set if the object is resizable down
4993 * @see elm_icon_scale_set()
4997 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4999 * Get the object's image size
5001 * @param obj The icon object
5002 * @param w A pointer to store the width in
5003 * @param h A pointer to store the height in
5007 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5009 * Set if the icon fill the entire object area.
5011 * @param obj The icon object
5012 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5013 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5015 * When the icon object is resized to a different aspect ratio from the
5016 * original icon image, the icon image will still keep its aspect. This flag
5017 * tells how the image should fill the object's area. They are: keep the
5018 * entire icon inside the limits of height and width of the object (@p
5019 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5020 * of the object, and the icon will fill the entire object (@p fill_outside
5023 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5024 * retain property to false. Thus, the icon image will always keep its
5025 * original aspect ratio.
5027 * @see elm_icon_fill_outside_get()
5028 * @see elm_image_fill_outside_set()
5032 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5034 * Get if the object is filled outside.
5036 * @param obj The icon object
5037 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5039 * @see elm_icon_fill_outside_set()
5043 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5045 * Set the prescale size for the icon.
5047 * @param obj The icon object
5048 * @param size The prescale size. This value is used for both width and
5051 * This function sets a new size for pixmap representation of the given
5052 * icon. It allows the icon to be loaded already in the specified size,
5053 * reducing the memory usage and load time when loading a big icon with load
5054 * size set to a smaller size.
5056 * It's equivalent to the elm_bg_load_size_set() function for bg.
5058 * @note this is just a hint, the real size of the pixmap may differ
5059 * depending on the type of icon being loaded, being bigger than requested.
5061 * @see elm_icon_prescale_get()
5062 * @see elm_bg_load_size_set()
5066 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5068 * Get the prescale size for the icon.
5070 * @param obj The icon object
5071 * @return The prescale size
5073 * @see elm_icon_prescale_set()
5077 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5079 * Gets the image object of the icon. DO NOT MODIFY THIS.
5081 * @param obj The icon object
5082 * @return The internal icon object
5086 EAPI Evas_Object *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5088 * Sets the icon lookup order used by elm_icon_standard_set().
5090 * @param obj The icon object
5091 * @param order The icon lookup order (can be one of
5092 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5093 * or ELM_ICON_LOOKUP_THEME)
5095 * @see elm_icon_order_lookup_get()
5096 * @see Elm_Icon_Lookup_Order
5100 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5102 * Gets the icon lookup order.
5104 * @param obj The icon object
5105 * @return The icon lookup order
5107 * @see elm_icon_order_lookup_set()
5108 * @see Elm_Icon_Lookup_Order
5112 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5114 * Enable or disable preloading of the icon
5116 * @param obj The icon object
5117 * @param disable If EINA_TRUE, preloading will be disabled
5120 EAPI void elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5122 * Get if the icon supports animation or not.
5124 * @param obj The icon object
5125 * @return @c EINA_TRUE if the icon supports animation,
5126 * @c EINA_FALSE otherwise.
5128 * Return if this elm icon's image can be animated. Currently Evas only
5129 * supports gif animation. If the return value is EINA_FALSE, other
5130 * elm_icon_animated_XXX APIs won't work.
5133 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5135 * Set animation mode of the icon.
5137 * @param obj The icon object
5138 * @param anim @c EINA_TRUE if the object do animation job,
5139 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5141 * Since the default animation mode is set to EINA_FALSE,
5142 * the icon is shown without animation.
5143 * This might be desirable when the application developer wants to show
5144 * a snapshot of the animated icon.
5145 * Set it to EINA_TRUE when the icon needs to be animated.
5148 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5150 * Get animation mode of the icon.
5152 * @param obj The icon object
5153 * @return The animation mode of the icon object
5154 * @see elm_icon_animated_set
5157 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5159 * Set animation play mode of the icon.
5161 * @param obj The icon object
5162 * @param play @c EINA_TRUE the object play animation images,
5163 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5165 * To play elm icon's animation, set play to EINA_TURE.
5166 * For example, you make gif player using this set/get API and click event.
5168 * 1. Click event occurs
5169 * 2. Check play flag using elm_icon_animaged_play_get
5170 * 3. If elm icon was playing, set play to EINA_FALSE.
5171 * Then animation will be stopped and vice versa
5174 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5176 * Get animation play mode of the icon.
5178 * @param obj The icon object
5179 * @return The play mode of the icon object
5181 * @see elm_icon_animated_play_get
5184 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5186 /* compatibility code to avoid API and ABI breaks */
5187 EINA_DEPRECATED EAPI extern inline void elm_icon_anim_set(Evas_Object *obj, Eina_Bool animated)
5189 elm_icon_animated_set(obj, animated);
5192 EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_get(const Evas_Object *obj)
5194 return elm_icon_animated_get(obj);
5197 EINA_DEPRECATED EAPI extern inline void elm_icon_anim_play_set(Evas_Object *obj, Eina_Bool play)
5199 elm_icon_animated_play_set(obj, play);
5202 EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_play_get(const Evas_Object *obj)
5204 return elm_icon_animated_play_get(obj);
5212 * @defgroup Image Image
5214 * @image html img/widget/image/preview-00.png
5215 * @image latex img/widget/image/preview-00.eps
5218 * An object that allows one to load an image file to it. It can be used
5219 * anywhere like any other elementary widget.
5221 * This widget provides most of the functionality provided from @ref Bg or @ref
5222 * Icon, but with a slightly different API (use the one that fits better your
5225 * The features not provided by those two other image widgets are:
5226 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5227 * @li change the object orientation with elm_image_orient_set();
5228 * @li and turning the image editable with elm_image_editable_set().
5230 * Signals that you can add callbacks for are:
5232 * @li @c "clicked" - This is called when a user has clicked the image
5234 * An example of usage for this API follows:
5235 * @li @ref tutorial_image
5244 * @enum _Elm_Image_Orient
5245 * @typedef Elm_Image_Orient
5247 * Possible orientation options for elm_image_orient_set().
5249 * @image html elm_image_orient_set.png
5250 * @image latex elm_image_orient_set.eps width=\textwidth
5254 typedef enum _Elm_Image_Orient
5256 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5257 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5258 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5259 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5260 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5261 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5262 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5263 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5267 * Add a new image to the parent.
5269 * @param parent The parent object
5270 * @return The new object or NULL if it cannot be created
5272 * @see elm_image_file_set()
5276 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5278 * Set the file that will be used as image.
5280 * @param obj The image object
5281 * @param file The path to file that will be used as image
5282 * @param group The group that the image belongs in edje file (if it's an
5285 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5287 * @see elm_image_file_get()
5291 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5293 * Get the file that will be used as image.
5295 * @param obj The image object
5296 * @param file The path to file
5297 * @param group The group that the image belongs in edje file
5299 * @see elm_image_file_set()
5303 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5305 * Set the smooth effect for an image.
5307 * @param obj The image object
5308 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5309 * otherwise. Default is @c EINA_TRUE.
5311 * Set the scaling algorithm to be used when scaling the image. Smooth
5312 * scaling provides a better resulting image, but is slower.
5314 * The smooth scaling should be disabled when making animations that change
5315 * the image size, since it will be faster. Animations that don't require
5316 * resizing of the image can keep the smooth scaling enabled (even if the
5317 * image is already scaled, since the scaled image will be cached).
5319 * @see elm_image_smooth_get()
5323 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5325 * Get the smooth effect for an image.
5327 * @param obj The image object
5328 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5330 * @see elm_image_smooth_get()
5334 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5337 * Gets the current size of the image.
5339 * @param obj The image object.
5340 * @param w Pointer to store width, or NULL.
5341 * @param h Pointer to store height, or NULL.
5343 * This is the real size of the image, not the size of the object.
5345 * On error, neither w or h will be written.
5349 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5351 * Disable scaling of this object.
5353 * @param obj The image object.
5354 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5355 * otherwise. Default is @c EINA_FALSE.
5357 * This function disables scaling of the elm_image widget through the
5358 * function elm_object_scale_set(). However, this does not affect the widget
5359 * size/resize in any way. For that effect, take a look at
5360 * elm_image_scale_set().
5362 * @see elm_image_no_scale_get()
5363 * @see elm_image_scale_set()
5364 * @see elm_object_scale_set()
5368 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5370 * Get whether scaling is disabled on the object.
5372 * @param obj The image object
5373 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5375 * @see elm_image_no_scale_set()
5379 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5381 * Set if the object is (up/down) resizable.
5383 * @param obj The image object
5384 * @param scale_up A bool to set if the object is resizable up. Default is
5386 * @param scale_down A bool to set if the object is resizable down. Default
5389 * This function limits the image resize ability. If @p scale_up is set to
5390 * @c EINA_FALSE, the object can't have its height or width resized to a value
5391 * higher than the original image size. Same is valid for @p scale_down.
5393 * @see elm_image_scale_get()
5397 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5399 * Get if the object is (up/down) resizable.
5401 * @param obj The image object
5402 * @param scale_up A bool to set if the object is resizable up
5403 * @param scale_down A bool to set if the object is resizable down
5405 * @see elm_image_scale_set()
5409 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5411 * Set if the image fills the entire object area, when keeping the aspect ratio.
5413 * @param obj The image object
5414 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5415 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5417 * When the image should keep its aspect ratio even if resized to another
5418 * aspect ratio, there are two possibilities to resize it: keep the entire
5419 * image inside the limits of height and width of the object (@p fill_outside
5420 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5421 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5423 * @note This option will have no effect if
5424 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5426 * @see elm_image_fill_outside_get()
5427 * @see elm_image_aspect_ratio_retained_set()
5431 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5433 * Get if the object is filled outside
5435 * @param obj The image object
5436 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5438 * @see elm_image_fill_outside_set()
5442 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5444 * Set the prescale size for the image
5446 * @param obj The image object
5447 * @param size The prescale size. This value is used for both width and
5450 * This function sets a new size for pixmap representation of the given
5451 * image. It allows the image to be loaded already in the specified size,
5452 * reducing the memory usage and load time when loading a big image with load
5453 * size set to a smaller size.
5455 * It's equivalent to the elm_bg_load_size_set() function for bg.
5457 * @note this is just a hint, the real size of the pixmap may differ
5458 * depending on the type of image being loaded, being bigger than requested.
5460 * @see elm_image_prescale_get()
5461 * @see elm_bg_load_size_set()
5465 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5467 * Get the prescale size for the image
5469 * @param obj The image object
5470 * @return The prescale size
5472 * @see elm_image_prescale_set()
5476 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5478 * Set the image orientation.
5480 * @param obj The image object
5481 * @param orient The image orientation @ref Elm_Image_Orient
5482 * Default is #ELM_IMAGE_ORIENT_NONE.
5484 * This function allows to rotate or flip the given image.
5486 * @see elm_image_orient_get()
5487 * @see @ref Elm_Image_Orient
5491 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5493 * Get the image orientation.
5495 * @param obj The image object
5496 * @return The image orientation @ref Elm_Image_Orient
5498 * @see elm_image_orient_set()
5499 * @see @ref Elm_Image_Orient
5503 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5505 * Make the image 'editable'.
5507 * @param obj Image object.
5508 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5510 * This means the image is a valid drag target for drag and drop, and can be
5511 * cut or pasted too.
5515 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5517 * Check if the image 'editable'.
5519 * @param obj Image object.
5520 * @return Editability.
5522 * A return value of EINA_TRUE means the image is a valid drag target
5523 * for drag and drop, and can be cut or pasted too.
5527 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5529 * Get the basic Evas_Image object from this object (widget).
5531 * @param obj The image object to get the inlined image from
5532 * @return The inlined image object, or NULL if none exists
5534 * This function allows one to get the underlying @c Evas_Object of type
5535 * Image from this elementary widget. It can be useful to do things like get
5536 * the pixel data, save the image to a file, etc.
5538 * @note Be careful to not manipulate it, as it is under control of
5543 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5545 * Set whether the original aspect ratio of the image should be kept on resize.
5547 * @param obj The image object.
5548 * @param retained @c EINA_TRUE if the image should retain the aspect,
5549 * @c EINA_FALSE otherwise.
5551 * The original aspect ratio (width / height) of the image is usually
5552 * distorted to match the object's size. Enabling this option will retain
5553 * this original aspect, and the way that the image is fit into the object's
5554 * area depends on the option set by elm_image_fill_outside_set().
5556 * @see elm_image_aspect_ratio_retained_get()
5557 * @see elm_image_fill_outside_set()
5561 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5563 * Get if the object retains the original aspect ratio.
5565 * @param obj The image object.
5566 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5571 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5578 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5580 /* old API compatibility */
5581 typedef Elm_GLView_Func_Cb Elm_GLView_Func;
5583 typedef enum _Elm_GLView_Mode
5585 ELM_GLVIEW_ALPHA = 1,
5586 ELM_GLVIEW_DEPTH = 2,
5587 ELM_GLVIEW_STENCIL = 4
5591 * Defines a policy for the glview resizing.
5593 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5595 typedef enum _Elm_GLView_Resize_Policy
5597 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5598 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5599 } Elm_GLView_Resize_Policy;
5601 typedef enum _Elm_GLView_Render_Policy
5603 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5604 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5605 } Elm_GLView_Render_Policy;
5610 * A simple GLView widget that allows GL rendering.
5612 * Signals that you can add callbacks for are:
5618 * Add a new glview to the parent
5620 * @param parent The parent object
5621 * @return The new object or NULL if it cannot be created
5625 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5628 * Sets the size of the glview
5630 * @param obj The glview object
5631 * @param width width of the glview object
5632 * @param height height of the glview object
5636 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5639 * Gets the size of the glview.
5641 * @param obj The glview object
5642 * @param width width of the glview object
5643 * @param height height of the glview object
5645 * Note that this function returns the actual image size of the
5646 * glview. This means that when the scale policy is set to
5647 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5652 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5655 * Gets the gl api struct for gl rendering
5657 * @param obj The glview object
5658 * @return The api object or NULL if it cannot be created
5662 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5665 * Set the mode of the GLView. Supports Three simple modes.
5667 * @param obj The glview object
5668 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5669 * @return True if set properly.
5673 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5676 * Set the resize policy for the glview object.
5678 * @param obj The glview object.
5679 * @param policy The scaling policy.
5681 * By default, the resize policy is set to
5682 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5683 * destroys the previous surface and recreates the newly specified
5684 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5685 * however, glview only scales the image object and not the underlying
5690 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5693 * Set the render policy for the glview object.
5695 * @param obj The glview object.
5696 * @param policy The render policy.
5698 * By default, the render policy is set to
5699 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5700 * that during the render loop, glview is only redrawn if it needs
5701 * to be redrawn. (i.e. When it is visible) If the policy is set to
5702 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5703 * whether it is visible/need redrawing or not.
5707 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5710 * Set the init function that runs once in the main loop.
5712 * @param obj The glview object.
5713 * @param func The init function to be registered.
5715 * The registered init function gets called once during the render loop.
5719 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5722 * Set the render function that runs in the main loop.
5724 * @param obj The glview object.
5725 * @param func The delete function to be registered.
5727 * The registered del function gets called when GLView object is deleted.
5731 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5734 * Set the resize function that gets called when resize happens.
5736 * @param obj The glview object.
5737 * @param func The resize function to be registered.
5741 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5744 * Set the render function that runs in the main loop.
5746 * @param obj The glview object.
5747 * @param func The render function to be registered.
5751 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5754 * Notifies that there has been changes in the GLView.
5756 * @param obj The glview object.
5760 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5770 * @image html img/widget/box/preview-00.png
5771 * @image latex img/widget/box/preview-00.eps width=\textwidth
5773 * @image html img/box.png
5774 * @image latex img/box.eps width=\textwidth
5776 * A box arranges objects in a linear fashion, governed by a layout function
5777 * that defines the details of this arrangement.
5779 * By default, the box will use an internal function to set the layout to
5780 * a single row, either vertical or horizontal. This layout is affected
5781 * by a number of parameters, such as the homogeneous flag set by
5782 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5783 * elm_box_align_set() and the hints set to each object in the box.
5785 * For this default layout, it's possible to change the orientation with
5786 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5787 * placing its elements ordered from top to bottom. When horizontal is set,
5788 * the order will go from left to right. If the box is set to be
5789 * homogeneous, every object in it will be assigned the same space, that
5790 * of the largest object. Padding can be used to set some spacing between
5791 * the cell given to each object. The alignment of the box, set with
5792 * elm_box_align_set(), determines how the bounding box of all the elements
5793 * will be placed within the space given to the box widget itself.
5795 * The size hints of each object also affect how they are placed and sized
5796 * within the box. evas_object_size_hint_min_set() will give the minimum
5797 * size the object can have, and the box will use it as the basis for all
5798 * latter calculations. Elementary widgets set their own minimum size as
5799 * needed, so there's rarely any need to use it manually.
5801 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5802 * used to tell whether the object will be allocated the minimum size it
5803 * needs or if the space given to it should be expanded. It's important
5804 * to realize that expanding the size given to the object is not the same
5805 * thing as resizing the object. It could very well end being a small
5806 * widget floating in a much larger empty space. If not set, the weight
5807 * for objects will normally be 0.0 for both axis, meaning the widget will
5808 * not be expanded. To take as much space possible, set the weight to
5809 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5811 * Besides how much space each object is allocated, it's possible to control
5812 * how the widget will be placed within that space using
5813 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5814 * for both axis, meaning the object will be centered, but any value from
5815 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5816 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5817 * is -1.0, means the object will be resized to fill the entire space it
5820 * In addition, customized functions to define the layout can be set, which
5821 * allow the application developer to organize the objects within the box
5822 * in any number of ways.
5824 * The special elm_box_layout_transition() function can be used
5825 * to switch from one layout to another, animating the motion of the
5826 * children of the box.
5828 * @note Objects should not be added to box objects using _add() calls.
5830 * Some examples on how to use boxes follow:
5831 * @li @ref box_example_01
5832 * @li @ref box_example_02
5837 * @typedef Elm_Box_Transition
5839 * Opaque handler containing the parameters to perform an animated
5840 * transition of the layout the box uses.
5842 * @see elm_box_transition_new()
5843 * @see elm_box_layout_set()
5844 * @see elm_box_layout_transition()
5846 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5849 * Add a new box to the parent
5851 * By default, the box will be in vertical mode and non-homogeneous.
5853 * @param parent The parent object
5854 * @return The new object or NULL if it cannot be created
5856 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5858 * Set the horizontal orientation
5860 * By default, box object arranges their contents vertically from top to
5862 * By calling this function with @p horizontal as EINA_TRUE, the box will
5863 * become horizontal, arranging contents from left to right.
5865 * @note This flag is ignored if a custom layout function is set.
5867 * @param obj The box object
5868 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5869 * EINA_FALSE = vertical)
5871 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5873 * Get the horizontal orientation
5875 * @param obj The box object
5876 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5878 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5880 * Set the box to arrange its children homogeneously
5882 * If enabled, homogeneous layout makes all items the same size, according
5883 * to the size of the largest of its children.
5885 * @note This flag is ignored if a custom layout function is set.
5887 * @param obj The box object
5888 * @param homogeneous The homogeneous flag
5890 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5892 * Get whether the box is using homogeneous mode or not
5894 * @param obj The box object
5895 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5897 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5898 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5899 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5901 * Add an object to the beginning of the pack list
5903 * Pack @p subobj into the box @p obj, placing it first in the list of
5904 * children objects. The actual position the object will get on screen
5905 * depends on the layout used. If no custom layout is set, it will be at
5906 * the top or left, depending if the box is vertical or horizontal,
5909 * @param obj The box object
5910 * @param subobj The object to add to the box
5912 * @see elm_box_pack_end()
5913 * @see elm_box_pack_before()
5914 * @see elm_box_pack_after()
5915 * @see elm_box_unpack()
5916 * @see elm_box_unpack_all()
5917 * @see elm_box_clear()
5919 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5921 * Add an object at the end of the pack list
5923 * Pack @p subobj into the box @p obj, placing it last in the list of
5924 * children objects. The actual position the object will get on screen
5925 * depends on the layout used. If no custom layout is set, it will be at
5926 * the bottom or right, depending if the box is vertical or horizontal,
5929 * @param obj The box object
5930 * @param subobj The object to add to the box
5932 * @see elm_box_pack_start()
5933 * @see elm_box_pack_before()
5934 * @see elm_box_pack_after()
5935 * @see elm_box_unpack()
5936 * @see elm_box_unpack_all()
5937 * @see elm_box_clear()
5939 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5941 * Adds an object to the box before the indicated object
5943 * This will add the @p subobj to the box indicated before the object
5944 * indicated with @p before. If @p before is not already in the box, results
5945 * are undefined. Before means either to the left of the indicated object or
5946 * above it depending on orientation.
5948 * @param obj The box object
5949 * @param subobj The object to add to the box
5950 * @param before The object before which to add it
5952 * @see elm_box_pack_start()
5953 * @see elm_box_pack_end()
5954 * @see elm_box_pack_after()
5955 * @see elm_box_unpack()
5956 * @see elm_box_unpack_all()
5957 * @see elm_box_clear()
5959 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5961 * Adds an object to the box after the indicated object
5963 * This will add the @p subobj to the box indicated after the object
5964 * indicated with @p after. If @p after is not already in the box, results
5965 * are undefined. After means either to the right of the indicated object or
5966 * below it depending on orientation.
5968 * @param obj The box object
5969 * @param subobj The object to add to the box
5970 * @param after The object after which to add it
5972 * @see elm_box_pack_start()
5973 * @see elm_box_pack_end()
5974 * @see elm_box_pack_before()
5975 * @see elm_box_unpack()
5976 * @see elm_box_unpack_all()
5977 * @see elm_box_clear()
5979 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5981 * Clear the box of all children
5983 * Remove all the elements contained by the box, deleting the respective
5986 * @param obj The box object
5988 * @see elm_box_unpack()
5989 * @see elm_box_unpack_all()
5991 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5995 * Remove the object given by @p subobj from the box @p obj without
5998 * @param obj The box object
6000 * @see elm_box_unpack_all()
6001 * @see elm_box_clear()
6003 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6005 * Remove all items from the box, without deleting them
6007 * Clear the box from all children, but don't delete the respective objects.
6008 * If no other references of the box children exist, the objects will never
6009 * be deleted, and thus the application will leak the memory. Make sure
6010 * when using this function that you hold a reference to all the objects
6011 * in the box @p obj.
6013 * @param obj The box object
6015 * @see elm_box_clear()
6016 * @see elm_box_unpack()
6018 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6020 * Retrieve a list of the objects packed into the box
6022 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
6023 * The order of the list corresponds to the packing order the box uses.
6025 * You must free this list with eina_list_free() once you are done with it.
6027 * @param obj The box object
6029 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6031 * Set the space (padding) between the box's elements.
6033 * Extra space in pixels that will be added between a box child and its
6034 * neighbors after its containing cell has been calculated. This padding
6035 * is set for all elements in the box, besides any possible padding that
6036 * individual elements may have through their size hints.
6038 * @param obj The box object
6039 * @param horizontal The horizontal space between elements
6040 * @param vertical The vertical space between elements
6042 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
6044 * Get the space (padding) between the box's elements.
6046 * @param obj The box object
6047 * @param horizontal The horizontal space between elements
6048 * @param vertical The vertical space between elements
6050 * @see elm_box_padding_set()
6052 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
6054 * Set the alignment of the whole bouding box of contents.
6056 * Sets how the bounding box containing all the elements of the box, after
6057 * their sizes and position has been calculated, will be aligned within
6058 * the space given for the whole box widget.
6060 * @param obj The box object
6061 * @param horizontal The horizontal alignment of elements
6062 * @param vertical The vertical alignment of elements
6064 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6066 * Get the alignment of the whole bouding box of contents.
6068 * @param obj The box object
6069 * @param horizontal The horizontal alignment of elements
6070 * @param vertical The vertical alignment of elements
6072 * @see elm_box_align_set()
6074 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6077 * Force the box to recalculate its children packing.
6079 * If any children was added or removed, box will not calculate the
6080 * values immediately rather leaving it to the next main loop
6081 * iteration. While this is great as it would save lots of
6082 * recalculation, whenever you need to get the position of a just
6083 * added item you must force recalculate before doing so.
6085 * @param obj The box object.
6087 EAPI void elm_box_recalculate(Evas_Object *obj);
6090 * Set the layout defining function to be used by the box
6092 * Whenever anything changes that requires the box in @p obj to recalculate
6093 * the size and position of its elements, the function @p cb will be called
6094 * to determine what the layout of the children will be.
6096 * Once a custom function is set, everything about the children layout
6097 * is defined by it. The flags set by elm_box_horizontal_set() and
6098 * elm_box_homogeneous_set() no longer have any meaning, and the values
6099 * given by elm_box_padding_set() and elm_box_align_set() are up to this
6100 * layout function to decide if they are used and how. These last two
6101 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6102 * passed to @p cb. The @c Evas_Object the function receives is not the
6103 * Elementary widget, but the internal Evas Box it uses, so none of the
6104 * functions described here can be used on it.
6106 * Any of the layout functions in @c Evas can be used here, as well as the
6107 * special elm_box_layout_transition().
6109 * The final @p data argument received by @p cb is the same @p data passed
6110 * here, and the @p free_data function will be called to free it
6111 * whenever the box is destroyed or another layout function is set.
6113 * Setting @p cb to NULL will revert back to the default layout function.
6115 * @param obj The box object
6116 * @param cb The callback function used for layout
6117 * @param data Data that will be passed to layout function
6118 * @param free_data Function called to free @p data
6120 * @see elm_box_layout_transition()
6122 EAPI void elm_box_layout_set(Evas_Object *obj, Evas_Object_Box_Layout cb, const void *data, void (*free_data)(void *data)) EINA_ARG_NONNULL(1);
6124 * Special layout function that animates the transition from one layout to another
6126 * Normally, when switching the layout function for a box, this will be
6127 * reflected immediately on screen on the next render, but it's also
6128 * possible to do this through an animated transition.
6130 * This is done by creating an ::Elm_Box_Transition and setting the box
6131 * layout to this function.
6135 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6136 * evas_object_box_layout_vertical, // start
6137 * NULL, // data for initial layout
6138 * NULL, // free function for initial data
6139 * evas_object_box_layout_horizontal, // end
6140 * NULL, // data for final layout
6141 * NULL, // free function for final data
6142 * anim_end, // will be called when animation ends
6143 * NULL); // data for anim_end function\
6144 * elm_box_layout_set(box, elm_box_layout_transition, t,
6145 * elm_box_transition_free);
6148 * @note This function can only be used with elm_box_layout_set(). Calling
6149 * it directly will not have the expected results.
6151 * @see elm_box_transition_new
6152 * @see elm_box_transition_free
6153 * @see elm_box_layout_set
6155 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6157 * Create a new ::Elm_Box_Transition to animate the switch of layouts
6159 * If you want to animate the change from one layout to another, you need
6160 * to set the layout function of the box to elm_box_layout_transition(),
6161 * passing as user data to it an instance of ::Elm_Box_Transition with the
6162 * necessary information to perform this animation. The free function to
6163 * set for the layout is elm_box_transition_free().
6165 * The parameters to create an ::Elm_Box_Transition sum up to how long
6166 * will it be, in seconds, a layout function to describe the initial point,
6167 * another for the final position of the children and one function to be
6168 * called when the whole animation ends. This last function is useful to
6169 * set the definitive layout for the box, usually the same as the end
6170 * layout for the animation, but could be used to start another transition.
6172 * @param start_layout The layout function that will be used to start the animation
6173 * @param start_layout_data The data to be passed the @p start_layout function
6174 * @param start_layout_free_data Function to free @p start_layout_data
6175 * @param end_layout The layout function that will be used to end the animation
6176 * @param end_layout_free_data The data to be passed the @p end_layout function
6177 * @param end_layout_free_data Function to free @p end_layout_data
6178 * @param transition_end_cb Callback function called when animation ends
6179 * @param transition_end_data Data to be passed to @p transition_end_cb
6180 * @return An instance of ::Elm_Box_Transition
6182 * @see elm_box_transition_new
6183 * @see elm_box_layout_transition
6185 EAPI Elm_Box_Transition *elm_box_transition_new(const double duration, Evas_Object_Box_Layout start_layout, void *start_layout_data, void(*start_layout_free_data)(void *data), Evas_Object_Box_Layout end_layout, void *end_layout_data, void(*end_layout_free_data)(void *data), void(*transition_end_cb)(void *data), void *transition_end_data) EINA_ARG_NONNULL(2, 5);
6187 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6189 * This function is mostly useful as the @c free_data parameter in
6190 * elm_box_layout_set() when elm_box_layout_transition().
6192 * @param data The Elm_Box_Transition instance to be freed.
6194 * @see elm_box_transition_new
6195 * @see elm_box_layout_transition
6197 EAPI void elm_box_transition_free(void *data);
6204 * @defgroup Button Button
6206 * @image html img/widget/button/preview-00.png
6207 * @image latex img/widget/button/preview-00.eps
6208 * @image html img/widget/button/preview-01.png
6209 * @image latex img/widget/button/preview-01.eps
6210 * @image html img/widget/button/preview-02.png
6211 * @image latex img/widget/button/preview-02.eps
6213 * This is a push-button. Press it and run some function. It can contain
6214 * a simple label and icon object and it also has an autorepeat feature.
6216 * This widgets emits the following signals:
6217 * @li "clicked": the user clicked the button (press/release).
6218 * @li "repeated": the user pressed the button without releasing it.
6219 * @li "pressed": button was pressed.
6220 * @li "unpressed": button was released after being pressed.
6221 * In all three cases, the @c event parameter of the callback will be
6224 * Also, defined in the default theme, the button has the following styles
6226 * @li default: a normal button.
6227 * @li anchor: Like default, but the button fades away when the mouse is not
6228 * over it, leaving only the text or icon.
6229 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6230 * continuous look across its options.
6231 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6233 * Default contents parts of the button widget that you can use for are:
6234 * @li "elm.swallow.content" - A icon of the button
6236 * Default text parts of the button widget that you can use for are:
6237 * @li "elm.text" - Label of the button
6239 * Follow through a complete example @ref button_example_01 "here".
6245 UIControlStateDefault,
6246 UIControlStateHighlighted,
6247 UIControlStateDisabled,
6248 UIControlStateFocused,
6249 UIControlStateReserved
6253 * Add a new button to the parent's canvas
6255 * @param parent The parent object
6256 * @return The new object or NULL if it cannot be created
6258 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6260 * Set the label used in the button
6262 * The passed @p label can be NULL to clean any existing text in it and
6263 * leave the button as an icon only object.
6265 * @param obj The button object
6266 * @param label The text will be written on the button
6267 * @deprecated use elm_object_text_set() instead.
6269 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6271 * Get the label set for the button
6273 * The string returned is an internal pointer and should not be freed or
6274 * altered. It will also become invalid when the button is destroyed.
6275 * The string returned, if not NULL, is a stringshare, so if you need to
6276 * keep it around even after the button is destroyed, you can use
6277 * eina_stringshare_ref().
6279 * @param obj The button object
6280 * @return The text set to the label, or NULL if nothing is set
6281 * @deprecated use elm_object_text_set() instead.
6283 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6285 * Set the label for each state of button
6287 * The passed @p label can be NULL to clean any existing text in it and
6288 * leave the button as an icon only object for the state.
6290 * @param obj The button object
6291 * @param label The text will be written on the button
6292 * @param state The state of button
6296 EINA_DEPRECATED EAPI void elm_button_label_set_for_state(Evas_Object *obj, const char *label, UIControlState state) EINA_ARG_NONNULL(1);
6298 * Get the label of button for each state
6300 * The string returned is an internal pointer and should not be freed or
6301 * altered. It will also become invalid when the button is destroyed.
6302 * The string returned, if not NULL, is a stringshare, so if you need to
6303 * keep it around even after the button is destroyed, you can use
6304 * eina_stringshare_ref().
6306 * @param obj The button object
6307 * @param state The state of button
6308 * @return The title of button for state
6312 EINA_DEPRECATED EAPI const char *elm_button_label_get_for_state(const Evas_Object *obj, UIControlState state) EINA_ARG_NONNULL(1);
6314 * Set the icon used for the button
6316 * Setting a new icon will delete any other that was previously set, making
6317 * any reference to them invalid. If you need to maintain the previous
6318 * object alive, unset it first with elm_button_icon_unset().
6320 * @param obj The button object
6321 * @param icon The icon object for the button
6322 * @deprecated use elm_object_content_set() instead.
6324 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6326 * Get the icon used for the button
6328 * Return the icon object which is set for this widget. If the button is
6329 * destroyed or another icon is set, the returned object will be deleted
6330 * and any reference to it will be invalid.
6332 * @param obj The button object
6333 * @return The icon object that is being used
6335 * @deprecated use elm_button_icon_unset() instead
6337 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6339 * Remove the icon set without deleting it and return the object
6341 * This function drops the reference the button holds of the icon object
6342 * and returns this last object. It is used in case you want to remove any
6343 * icon, or set another one, without deleting the actual object. The button
6344 * will be left without an icon set.
6346 * @param obj The button object
6347 * @return The icon object that was being used
6348 * @deprecated use elm_object_content_unset() instead.
6350 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6352 * Turn on/off the autorepeat event generated when the button is kept pressed
6354 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6355 * signal when they are clicked.
6357 * When on, keeping a button pressed will continuously emit a @c repeated
6358 * signal until the button is released. The time it takes until it starts
6359 * emitting the signal is given by
6360 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6361 * new emission by elm_button_autorepeat_gap_timeout_set().
6363 * @param obj The button object
6364 * @param on A bool to turn on/off the event
6366 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6368 * Get whether the autorepeat feature is enabled
6370 * @param obj The button object
6371 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6373 * @see elm_button_autorepeat_set()
6375 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6377 * Set the initial timeout before the autorepeat event is generated
6379 * Sets the timeout, in seconds, since the button is pressed until the
6380 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6381 * won't be any delay and the even will be fired the moment the button is
6384 * @param obj The button object
6385 * @param t Timeout in seconds
6387 * @see elm_button_autorepeat_set()
6388 * @see elm_button_autorepeat_gap_timeout_set()
6390 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6392 * Get the initial timeout before the autorepeat event is generated
6394 * @param obj The button object
6395 * @return Timeout in seconds
6397 * @see elm_button_autorepeat_initial_timeout_set()
6399 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6401 * Set the interval between each generated autorepeat event
6403 * After the first @c repeated event is fired, all subsequent ones will
6404 * follow after a delay of @p t seconds for each.
6406 * @param obj The button object
6407 * @param t Interval in seconds
6409 * @see elm_button_autorepeat_initial_timeout_set()
6411 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6413 * Get the interval between each generated autorepeat event
6415 * @param obj The button object
6416 * @return Interval in seconds
6418 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6424 * @defgroup File_Selector_Button File Selector Button
6426 * @image html img/widget/fileselector_button/preview-00.png
6427 * @image latex img/widget/fileselector_button/preview-00.eps
6428 * @image html img/widget/fileselector_button/preview-01.png
6429 * @image latex img/widget/fileselector_button/preview-01.eps
6430 * @image html img/widget/fileselector_button/preview-02.png
6431 * @image latex img/widget/fileselector_button/preview-02.eps
6433 * This is a button that, when clicked, creates an Elementary
6434 * window (or inner window) <b> with a @ref Fileselector "file
6435 * selector widget" within</b>. When a file is chosen, the (inner)
6436 * window is closed and the button emits a signal having the
6437 * selected file as it's @c event_info.
6439 * This widget encapsulates operations on its internal file
6440 * selector on its own API. There is less control over its file
6441 * selector than that one would have instatiating one directly.
6443 * The following styles are available for this button:
6446 * @li @c "hoversel_vertical"
6447 * @li @c "hoversel_vertical_entry"
6449 * Smart callbacks one can register to:
6450 * - @c "file,chosen" - the user has selected a path, whose string
6451 * pointer comes as the @c event_info data (a stringshared
6454 * Here is an example on its usage:
6455 * @li @ref fileselector_button_example
6457 * @see @ref File_Selector_Entry for a similar widget.
6462 * Add a new file selector button widget to the given parent
6463 * Elementary (container) object
6465 * @param parent The parent object
6466 * @return a new file selector button widget handle or @c NULL, on
6469 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6472 * Set the label for a given file selector button widget
6474 * @param obj The file selector button widget
6475 * @param label The text label to be displayed on @p obj
6477 * @deprecated use elm_object_text_set() instead.
6479 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6482 * Get the label set for a given file selector button widget
6484 * @param obj The file selector button widget
6485 * @return The button label
6487 * @deprecated use elm_object_text_set() instead.
6489 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6492 * Set the icon on a given file selector button widget
6494 * @param obj The file selector button widget
6495 * @param icon The icon object for the button
6497 * Once the icon object is set, a previously set one will be
6498 * deleted. If you want to keep the latter, use the
6499 * elm_fileselector_button_icon_unset() function.
6501 * @see elm_fileselector_button_icon_get()
6503 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6506 * Get the icon set for a given file selector button widget
6508 * @param obj The file selector button widget
6509 * @return The icon object currently set on @p obj or @c NULL, if
6512 * @see elm_fileselector_button_icon_set()
6514 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6517 * Unset the icon used in a given file selector button widget
6519 * @param obj The file selector button widget
6520 * @return The icon object that was being used on @p obj or @c
6523 * Unparent and return the icon object which was set for this
6526 * @see elm_fileselector_button_icon_set()
6528 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6531 * Set the title for a given file selector button widget's window
6533 * @param obj The file selector button widget
6534 * @param title The title string
6536 * This will change the window's title, when the file selector pops
6537 * out after a click on the button. Those windows have the default
6538 * (unlocalized) value of @c "Select a file" as titles.
6540 * @note It will only take any effect if the file selector
6541 * button widget is @b not under "inwin mode".
6543 * @see elm_fileselector_button_window_title_get()
6545 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6548 * Get the title set for a given file selector button widget's
6551 * @param obj The file selector button widget
6552 * @return Title of the file selector button's window
6554 * @see elm_fileselector_button_window_title_get() for more details
6556 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6559 * Set the size of a given file selector button widget's window,
6560 * holding the file selector itself.
6562 * @param obj The file selector button widget
6563 * @param width The window's width
6564 * @param height The window's height
6566 * @note it will only take any effect if the file selector button
6567 * widget is @b not under "inwin mode". The default size for the
6568 * window (when applicable) is 400x400 pixels.
6570 * @see elm_fileselector_button_window_size_get()
6572 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6575 * Get the size of a given file selector button widget's window,
6576 * holding the file selector itself.
6578 * @param obj The file selector button widget
6579 * @param width Pointer into which to store the width value
6580 * @param height Pointer into which to store the height value
6582 * @note Use @c NULL pointers on the size values you're not
6583 * interested in: they'll be ignored by the function.
6585 * @see elm_fileselector_button_window_size_set(), for more details
6587 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6590 * Set the initial file system path for a given file selector
6593 * @param obj The file selector button widget
6594 * @param path The path string
6596 * It must be a <b>directory</b> path, which will have the contents
6597 * displayed initially in the file selector's view, when invoked
6598 * from @p obj. The default initial path is the @c "HOME"
6599 * environment variable's value.
6601 * @see elm_fileselector_button_path_get()
6603 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6606 * Get the initial file system path set for a given file selector
6609 * @param obj The file selector button widget
6610 * @return path The path string
6612 * @see elm_fileselector_button_path_set() for more details
6614 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6617 * Enable/disable a tree view in the given file selector button
6618 * widget's internal file selector
6620 * @param obj The file selector button widget
6621 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6624 * This has the same effect as elm_fileselector_expandable_set(),
6625 * but now applied to a file selector button's internal file
6628 * @note There's no way to put a file selector button's internal
6629 * file selector in "grid mode", as one may do with "pure" file
6632 * @see elm_fileselector_expandable_get()
6634 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6637 * Get whether tree view is enabled for the given file selector
6638 * button widget's internal file selector
6640 * @param obj The file selector button widget
6641 * @return @c EINA_TRUE if @p obj widget's internal file selector
6642 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6644 * @see elm_fileselector_expandable_set() for more details
6646 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6649 * Set whether a given file selector button widget's internal file
6650 * selector is to display folders only or the directory contents,
6653 * @param obj The file selector button widget
6654 * @param only @c EINA_TRUE to make @p obj widget's internal file
6655 * selector only display directories, @c EINA_FALSE to make files
6656 * to be displayed in it too
6658 * This has the same effect as elm_fileselector_folder_only_set(),
6659 * but now applied to a file selector button's internal file
6662 * @see elm_fileselector_folder_only_get()
6664 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6667 * Get whether a given file selector button widget's internal file
6668 * selector is displaying folders only or the directory contents,
6671 * @param obj The file selector button widget
6672 * @return @c EINA_TRUE if @p obj widget's internal file
6673 * selector is only displaying directories, @c EINA_FALSE if files
6674 * are being displayed in it too (and on errors)
6676 * @see elm_fileselector_button_folder_only_set() for more details
6678 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6681 * Enable/disable the file name entry box where the user can type
6682 * in a name for a file, in a given file selector button widget's
6683 * internal file selector.
6685 * @param obj The file selector button widget
6686 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6687 * file selector a "saving dialog", @c EINA_FALSE otherwise
6689 * This has the same effect as elm_fileselector_is_save_set(),
6690 * but now applied to a file selector button's internal file
6693 * @see elm_fileselector_is_save_get()
6695 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6698 * Get whether the given file selector button widget's internal
6699 * file selector is in "saving dialog" mode
6701 * @param obj The file selector button widget
6702 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6703 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6706 * @see elm_fileselector_button_is_save_set() for more details
6708 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6711 * Set whether a given file selector button widget's internal file
6712 * selector will raise an Elementary "inner window", instead of a
6713 * dedicated Elementary window. By default, it won't.
6715 * @param obj The file selector button widget
6716 * @param value @c EINA_TRUE to make it use an inner window, @c
6717 * EINA_TRUE to make it use a dedicated window
6719 * @see elm_win_inwin_add() for more information on inner windows
6720 * @see elm_fileselector_button_inwin_mode_get()
6722 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6725 * Get whether a given file selector button widget's internal file
6726 * selector will raise an Elementary "inner window", instead of a
6727 * dedicated Elementary window.
6729 * @param obj The file selector button widget
6730 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6731 * if it will use a dedicated window
6733 * @see elm_fileselector_button_inwin_mode_set() for more details
6735 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6742 * @defgroup File_Selector_Entry File Selector Entry
6744 * @image html img/widget/fileselector_entry/preview-00.png
6745 * @image latex img/widget/fileselector_entry/preview-00.eps
6747 * This is an entry made to be filled with or display a <b>file
6748 * system path string</b>. Besides the entry itself, the widget has
6749 * a @ref File_Selector_Button "file selector button" on its side,
6750 * which will raise an internal @ref Fileselector "file selector widget",
6751 * when clicked, for path selection aided by file system
6754 * This file selector may appear in an Elementary window or in an
6755 * inner window. When a file is chosen from it, the (inner) window
6756 * is closed and the selected file's path string is exposed both as
6757 * an smart event and as the new text on the entry.
6759 * This widget encapsulates operations on its internal file
6760 * selector on its own API. There is less control over its file
6761 * selector than that one would have instatiating one directly.
6763 * Smart callbacks one can register to:
6764 * - @c "changed" - The text within the entry was changed
6765 * - @c "activated" - The entry has had editing finished and
6766 * changes are to be "committed"
6767 * - @c "press" - The entry has been clicked
6768 * - @c "longpressed" - The entry has been clicked (and held) for a
6770 * - @c "clicked" - The entry has been clicked
6771 * - @c "clicked,double" - The entry has been double clicked
6772 * - @c "focused" - The entry has received focus
6773 * - @c "unfocused" - The entry has lost focus
6774 * - @c "selection,paste" - A paste action has occurred on the
6776 * - @c "selection,copy" - A copy action has occurred on the entry
6777 * - @c "selection,cut" - A cut action has occurred on the entry
6778 * - @c "unpressed" - The file selector entry's button was released
6779 * after being pressed.
6780 * - @c "file,chosen" - The user has selected a path via the file
6781 * selector entry's internal file selector, whose string pointer
6782 * comes as the @c event_info data (a stringshared string)
6784 * Here is an example on its usage:
6785 * @li @ref fileselector_entry_example
6787 * @see @ref File_Selector_Button for a similar widget.
6792 * Add a new file selector entry widget to the given parent
6793 * Elementary (container) object
6795 * @param parent The parent object
6796 * @return a new file selector entry widget handle or @c NULL, on
6799 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6802 * Set the label for a given file selector entry widget's button
6804 * @param obj The file selector entry widget
6805 * @param label The text label to be displayed on @p obj widget's
6808 * @deprecated use elm_object_text_set() instead.
6810 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6813 * Get the label set for a given file selector entry widget's button
6815 * @param obj The file selector entry widget
6816 * @return The widget button's label
6818 * @deprecated use elm_object_text_set() instead.
6820 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6823 * Set the icon on a given file selector entry widget's button
6825 * @param obj The file selector entry widget
6826 * @param icon The icon object for the entry's button
6828 * Once the icon object is set, a previously set one will be
6829 * deleted. If you want to keep the latter, use the
6830 * elm_fileselector_entry_button_icon_unset() function.
6832 * @see elm_fileselector_entry_button_icon_get()
6834 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6837 * Get the icon set for a given file selector entry widget's button
6839 * @param obj The file selector entry widget
6840 * @return The icon object currently set on @p obj widget's button
6841 * or @c NULL, if none is
6843 * @see elm_fileselector_entry_button_icon_set()
6845 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6848 * Unset the icon used in a given file selector entry widget's
6851 * @param obj The file selector entry widget
6852 * @return The icon object that was being used on @p obj widget's
6853 * button or @c NULL, on errors
6855 * Unparent and return the icon object which was set for this
6858 * @see elm_fileselector_entry_button_icon_set()
6860 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6863 * Set the title for a given file selector entry widget's window
6865 * @param obj The file selector entry widget
6866 * @param title The title string
6868 * This will change the window's title, when the file selector pops
6869 * out after a click on the entry's button. Those windows have the
6870 * default (unlocalized) value of @c "Select a file" as titles.
6872 * @note It will only take any effect if the file selector
6873 * entry widget is @b not under "inwin mode".
6875 * @see elm_fileselector_entry_window_title_get()
6877 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6880 * Get the title set for a given file selector entry widget's
6883 * @param obj The file selector entry widget
6884 * @return Title of the file selector entry's window
6886 * @see elm_fileselector_entry_window_title_get() for more details
6888 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6891 * Set the size of a given file selector entry widget's window,
6892 * holding the file selector itself.
6894 * @param obj The file selector entry widget
6895 * @param width The window's width
6896 * @param height The window's height
6898 * @note it will only take any effect if the file selector entry
6899 * widget is @b not under "inwin mode". The default size for the
6900 * window (when applicable) is 400x400 pixels.
6902 * @see elm_fileselector_entry_window_size_get()
6904 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6907 * Get the size of a given file selector entry widget's window,
6908 * holding the file selector itself.
6910 * @param obj The file selector entry widget
6911 * @param width Pointer into which to store the width value
6912 * @param height Pointer into which to store the height value
6914 * @note Use @c NULL pointers on the size values you're not
6915 * interested in: they'll be ignored by the function.
6917 * @see elm_fileselector_entry_window_size_set(), for more details
6919 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6922 * Set the initial file system path and the entry's path string for
6923 * a given file selector entry widget
6925 * @param obj The file selector entry widget
6926 * @param path The path string
6928 * It must be a <b>directory</b> path, which will have the contents
6929 * displayed initially in the file selector's view, when invoked
6930 * from @p obj. The default initial path is the @c "HOME"
6931 * environment variable's value.
6933 * @see elm_fileselector_entry_path_get()
6935 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6938 * Get the entry's path string for a given file selector entry
6941 * @param obj The file selector entry widget
6942 * @return path The path string
6944 * @see elm_fileselector_entry_path_set() for more details
6946 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6949 * Enable/disable a tree view in the given file selector entry
6950 * widget's internal file selector
6952 * @param obj The file selector entry widget
6953 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6956 * This has the same effect as elm_fileselector_expandable_set(),
6957 * but now applied to a file selector entry's internal file
6960 * @note There's no way to put a file selector entry's internal
6961 * file selector in "grid mode", as one may do with "pure" file
6964 * @see elm_fileselector_expandable_get()
6966 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6969 * Get whether tree view is enabled for the given file selector
6970 * entry widget's internal file selector
6972 * @param obj The file selector entry widget
6973 * @return @c EINA_TRUE if @p obj widget's internal file selector
6974 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6976 * @see elm_fileselector_expandable_set() for more details
6978 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6981 * Set whether a given file selector entry widget's internal file
6982 * selector is to display folders only or the directory contents,
6985 * @param obj The file selector entry widget
6986 * @param only @c EINA_TRUE to make @p obj widget's internal file
6987 * selector only display directories, @c EINA_FALSE to make files
6988 * to be displayed in it too
6990 * This has the same effect as elm_fileselector_folder_only_set(),
6991 * but now applied to a file selector entry's internal file
6994 * @see elm_fileselector_folder_only_get()
6996 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6999 * Get whether a given file selector entry widget's internal file
7000 * selector is displaying folders only or the directory contents,
7003 * @param obj The file selector entry widget
7004 * @return @c EINA_TRUE if @p obj widget's internal file
7005 * selector is only displaying directories, @c EINA_FALSE if files
7006 * are being displayed in it too (and on errors)
7008 * @see elm_fileselector_entry_folder_only_set() for more details
7010 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7013 * Enable/disable the file name entry box where the user can type
7014 * in a name for a file, in a given file selector entry widget's
7015 * internal file selector.
7017 * @param obj The file selector entry widget
7018 * @param is_save @c EINA_TRUE to make @p obj widget's internal
7019 * file selector a "saving dialog", @c EINA_FALSE otherwise
7021 * This has the same effect as elm_fileselector_is_save_set(),
7022 * but now applied to a file selector entry's internal file
7025 * @see elm_fileselector_is_save_get()
7027 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7030 * Get whether the given file selector entry widget's internal
7031 * file selector is in "saving dialog" mode
7033 * @param obj The file selector entry widget
7034 * @return @c EINA_TRUE, if @p obj widget's internal file selector
7035 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7038 * @see elm_fileselector_entry_is_save_set() for more details
7040 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7043 * Set whether a given file selector entry widget's internal file
7044 * selector will raise an Elementary "inner window", instead of a
7045 * dedicated Elementary window. By default, it won't.
7047 * @param obj The file selector entry widget
7048 * @param value @c EINA_TRUE to make it use an inner window, @c
7049 * EINA_TRUE to make it use a dedicated window
7051 * @see elm_win_inwin_add() for more information on inner windows
7052 * @see elm_fileselector_entry_inwin_mode_get()
7054 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7057 * Get whether a given file selector entry widget's internal file
7058 * selector will raise an Elementary "inner window", instead of a
7059 * dedicated Elementary window.
7061 * @param obj The file selector entry widget
7062 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7063 * if it will use a dedicated window
7065 * @see elm_fileselector_entry_inwin_mode_set() for more details
7067 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7070 * Set the initial file system path for a given file selector entry
7073 * @param obj The file selector entry widget
7074 * @param path The path string
7076 * It must be a <b>directory</b> path, which will have the contents
7077 * displayed initially in the file selector's view, when invoked
7078 * from @p obj. The default initial path is the @c "HOME"
7079 * environment variable's value.
7081 * @see elm_fileselector_entry_path_get()
7083 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7086 * Get the parent directory's path to the latest file selection on
7087 * a given filer selector entry widget
7089 * @param obj The file selector object
7090 * @return The (full) path of the directory of the last selection
7091 * on @p obj widget, a @b stringshared string
7093 * @see elm_fileselector_entry_path_set()
7095 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7102 * @defgroup Scroller Scroller
7104 * A scroller holds a single object and "scrolls it around". This means that
7105 * it allows the user to use a scrollbar (or a finger) to drag the viewable
7106 * region around, allowing to move through a much larger object that is
7107 * contained in the scroller. The scroller will always have a small minimum
7108 * size by default as it won't be limited by the contents of the scroller.
7110 * Signals that you can add callbacks for are:
7111 * @li "edge,left" - the left edge of the content has been reached
7112 * @li "edge,right" - the right edge of the content has been reached
7113 * @li "edge,top" - the top edge of the content has been reached
7114 * @li "edge,bottom" - the bottom edge of the content has been reached
7115 * @li "scroll" - the content has been scrolled (moved)
7116 * @li "scroll,anim,start" - scrolling animation has started
7117 * @li "scroll,anim,stop" - scrolling animation has stopped
7118 * @li "scroll,drag,start" - dragging the contents around has started
7119 * @li "scroll,drag,stop" - dragging the contents around has stopped
7120 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7123 * @note When Elemementary is in embedded mode the scrollbars will not be
7124 * dragable, they appear merely as indicators of how much has been scrolled.
7125 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7126 * fingerscroll) won't work.
7128 * Default contents parts of the scroller widget that you can use for are:
7129 * @li "default" - A content of the scroller
7131 * In @ref tutorial_scroller you'll find an example of how to use most of
7136 * @brief Type that controls when scrollbars should appear.
7138 * @see elm_scroller_policy_set()
7140 typedef enum _Elm_Scroller_Policy
7142 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7143 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7144 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7145 ELM_SCROLLER_POLICY_LAST
7146 } Elm_Scroller_Policy;
7148 * @brief Add a new scroller to the parent
7150 * @param parent The parent object
7151 * @return The new object or NULL if it cannot be created
7153 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7155 * @brief Set the content of the scroller widget (the object to be scrolled around).
7157 * @param obj The scroller object
7158 * @param content The new content object
7160 * Once the content object is set, a previously set one will be deleted.
7161 * If you want to keep that old content object, use the
7162 * elm_scroller_content_unset() function.
7163 * @deprecated use elm_object_content_set() instead
7165 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7167 * @brief Get the content of the scroller widget
7169 * @param obj The slider object
7170 * @return The content that is being used
7172 * Return the content object which is set for this widget
7174 * @see elm_scroller_content_set()
7175 * @deprecated use elm_object_content_get() instead.
7177 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7179 * @brief Unset the content of the scroller widget
7181 * @param obj The slider object
7182 * @return The content that was being used
7184 * Unparent and return the content object which was set for this widget
7186 * @see elm_scroller_content_set()
7187 * @deprecated use elm_object_content_unset() instead.
7189 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7191 * @brief Set custom theme elements for the scroller
7193 * @param obj The scroller object
7194 * @param widget The widget name to use (default is "scroller")
7195 * @param base The base name to use (default is "base")
7197 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7199 * @brief Make the scroller minimum size limited to the minimum size of the content
7201 * @param obj The scroller object
7202 * @param w Enable limiting minimum size horizontally
7203 * @param h Enable limiting minimum size vertically
7205 * By default the scroller will be as small as its design allows,
7206 * irrespective of its content. This will make the scroller minimum size the
7207 * right size horizontally and/or vertically to perfectly fit its content in
7210 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7212 * @brief Show a specific virtual region within the scroller content object
7214 * @param obj The scroller object
7215 * @param x X coordinate of the region
7216 * @param y Y coordinate of the region
7217 * @param w Width of the region
7218 * @param h Height of the region
7220 * This will ensure all (or part if it does not fit) of the designated
7221 * region in the virtual content object (0, 0 starting at the top-left of the
7222 * virtual content object) is shown within the scroller.
7224 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);
7226 * @brief Set the scrollbar visibility policy
7228 * @param obj The scroller object
7229 * @param policy_h Horizontal scrollbar policy
7230 * @param policy_v Vertical scrollbar policy
7232 * This sets the scrollbar visibility policy for the given scroller.
7233 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7234 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7235 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7236 * respectively for the horizontal and vertical scrollbars.
7238 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7240 * @brief Gets scrollbar visibility policy
7242 * @param obj The scroller object
7243 * @param policy_h Horizontal scrollbar policy
7244 * @param policy_v Vertical scrollbar policy
7246 * @see elm_scroller_policy_set()
7248 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7250 * @brief Get the currently visible content region
7252 * @param obj The scroller object
7253 * @param x X coordinate of the region
7254 * @param y Y coordinate of the region
7255 * @param w Width of the region
7256 * @param h Height of the region
7258 * This gets the current region in the content object that is visible through
7259 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7260 * w, @p h values pointed to.
7262 * @note All coordinates are relative to the content.
7264 * @see elm_scroller_region_show()
7266 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);
7268 * @brief Get the size of the content object
7270 * @param obj The scroller object
7271 * @param w Width of the content object.
7272 * @param h Height of the content object.
7274 * This gets the size of the content object of the scroller.
7276 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7278 * @brief Set bouncing behavior
7280 * @param obj The scroller object
7281 * @param h_bounce Allow bounce horizontally
7282 * @param v_bounce Allow bounce vertically
7284 * When scrolling, the scroller may "bounce" when reaching an edge of the
7285 * content object. This is a visual way to indicate the end has been reached.
7286 * This is enabled by default for both axis. This API will set if it is enabled
7287 * for the given axis with the boolean parameters for each axis.
7289 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7291 * @brief Get the bounce behaviour
7293 * @param obj The Scroller object
7294 * @param h_bounce Will the scroller bounce horizontally or not
7295 * @param v_bounce Will the scroller bounce vertically or not
7297 * @see elm_scroller_bounce_set()
7299 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7301 * @brief Set scroll page size relative to viewport size.
7303 * @param obj The scroller object
7304 * @param h_pagerel The horizontal page relative size
7305 * @param v_pagerel The vertical page relative size
7307 * The scroller is capable of limiting scrolling by the user to "pages". That
7308 * is to jump by and only show a "whole page" at a time as if the continuous
7309 * area of the scroller content is split into page sized pieces. This sets
7310 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7311 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7312 * axis. This is mutually exclusive with page size
7313 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7314 * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7315 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7318 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7320 * @brief Set scroll page size.
7322 * @param obj The scroller object
7323 * @param h_pagesize The horizontal page size
7324 * @param v_pagesize The vertical page size
7326 * This sets the page size to an absolute fixed value, with 0 turning it off
7329 * @see elm_scroller_page_relative_set()
7331 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7333 * @brief Get scroll current page number.
7335 * @param obj The scroller object
7336 * @param h_pagenumber The horizontal page number
7337 * @param v_pagenumber The vertical page number
7339 * The page number starts from 0. 0 is the first page.
7340 * Current page means the page which meets the top-left of the viewport.
7341 * If there are two or more pages in the viewport, it returns the number of the page
7342 * which meets the top-left of the viewport.
7344 * @see elm_scroller_last_page_get()
7345 * @see elm_scroller_page_show()
7346 * @see elm_scroller_page_brint_in()
7348 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7350 * @brief Get scroll last page number.
7352 * @param obj The scroller object
7353 * @param h_pagenumber The horizontal page number
7354 * @param v_pagenumber The vertical page number
7356 * The page number starts from 0. 0 is the first page.
7357 * This returns the last page number among the pages.
7359 * @see elm_scroller_current_page_get()
7360 * @see elm_scroller_page_show()
7361 * @see elm_scroller_page_brint_in()
7363 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7365 * Show a specific virtual region within the scroller content object by page number.
7367 * @param obj The scroller object
7368 * @param h_pagenumber The horizontal page number
7369 * @param v_pagenumber The vertical page number
7371 * 0, 0 of the indicated page is located at the top-left of the viewport.
7372 * This will jump to the page directly without animation.
7377 * sc = elm_scroller_add(win);
7378 * elm_scroller_content_set(sc, content);
7379 * elm_scroller_page_relative_set(sc, 1, 0);
7380 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7381 * elm_scroller_page_show(sc, h_page + 1, v_page);
7384 * @see elm_scroller_page_bring_in()
7386 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7388 * Show a specific virtual region within the scroller content object by page number.
7390 * @param obj The scroller object
7391 * @param h_pagenumber The horizontal page number
7392 * @param v_pagenumber The vertical page number
7394 * 0, 0 of the indicated page is located at the top-left of the viewport.
7395 * This will slide to the page with animation.
7400 * sc = elm_scroller_add(win);
7401 * elm_scroller_content_set(sc, content);
7402 * elm_scroller_page_relative_set(sc, 1, 0);
7403 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7404 * elm_scroller_page_bring_in(sc, h_page, v_page);
7407 * @see elm_scroller_page_show()
7409 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7411 * @brief Show a specific virtual region within the scroller content object.
7413 * @param obj The scroller object
7414 * @param x X coordinate of the region
7415 * @param y Y coordinate of the region
7416 * @param w Width of the region
7417 * @param h Height of the region
7419 * This will ensure all (or part if it does not fit) of the designated
7420 * region in the virtual content object (0, 0 starting at the top-left of the
7421 * virtual content object) is shown within the scroller. Unlike
7422 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7423 * to this location (if configuration in general calls for transitions). It
7424 * may not jump immediately to the new location and make take a while and
7425 * show other content along the way.
7427 * @see elm_scroller_region_show()
7429 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);
7431 * @brief Set event propagation on a scroller
7433 * @param obj The scroller object
7434 * @param propagation If propagation is enabled or not
7436 * This enables or disabled event propagation from the scroller content to
7437 * the scroller and its parent. By default event propagation is disabled.
7439 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7441 * @brief Get event propagation for a scroller
7443 * @param obj The scroller object
7444 * @return The propagation state
7446 * This gets the event propagation for a scroller.
7448 * @see elm_scroller_propagate_events_set()
7450 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7452 * @brief Set scrolling gravity on a scroller
7454 * @param obj The scroller object
7455 * @param x The scrolling horizontal gravity
7456 * @param y The scrolling vertical gravity
7458 * The gravity, defines how the scroller will adjust its view
7459 * when the size of the scroller contents increase.
7461 * The scroller will adjust the view to glue itself as follows.
7463 * x=0.0, for showing the left most region of the content.
7464 * x=1.0, for showing the right most region of the content.
7465 * y=0.0, for showing the bottom most region of the content.
7466 * y=1.0, for showing the top most region of the content.
7468 * Default values for x and y are 0.0
7470 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7472 * @brief Get scrolling gravity values for a scroller
7474 * @param obj The scroller object
7475 * @param x The scrolling horizontal gravity
7476 * @param y The scrolling vertical gravity
7478 * This gets gravity values for a scroller.
7480 * @see elm_scroller_gravity_set()
7483 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7489 * @defgroup Label Label
7491 * @image html img/widget/label/preview-00.png
7492 * @image latex img/widget/label/preview-00.eps
7494 * @brief Widget to display text, with simple html-like markup.
7496 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7497 * text doesn't fit the geometry of the label it will be ellipsized or be
7498 * cut. Elementary provides several themes for this widget:
7499 * @li default - No animation
7500 * @li marker - Centers the text in the label and make it bold by default
7501 * @li slide_long - The entire text appears from the right of the screen and
7502 * slides until it disappears in the left of the screen(reappering on the
7504 * @li slide_short - The text appears in the left of the label and slides to
7505 * the right to show the overflow. When all of the text has been shown the
7506 * position is reset.
7507 * @li slide_bounce - The text appears in the left of the label and slides to
7508 * the right to show the overflow. When all of the text has been shown the
7509 * animation reverses, moving the text to the left.
7511 * Custom themes can of course invent new markup tags and style them any way
7514 * The following signals may be emitted by the label widget:
7515 * @li "language,changed": The program's language changed.
7517 * See @ref tutorial_label for a demonstration of how to use a label widget.
7521 * @brief Add a new label to the parent
7523 * @param parent The parent object
7524 * @return The new object or NULL if it cannot be created
7526 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7528 * @brief Set the label on the label object
7530 * @param obj The label object
7531 * @param label The label will be used on the label object
7532 * @deprecated See elm_object_text_set()
7534 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 */
7536 * @brief Get the label used on the label object
7538 * @param obj The label object
7539 * @return The string inside the label
7540 * @deprecated See elm_object_text_get()
7542 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7544 * @brief Set the wrapping behavior of the label
7546 * @param obj The label object
7547 * @param wrap To wrap text or not
7549 * By default no wrapping is done. Possible values for @p wrap are:
7550 * @li ELM_WRAP_NONE - No wrapping
7551 * @li ELM_WRAP_CHAR - wrap between characters
7552 * @li ELM_WRAP_WORD - wrap between words
7553 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7555 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7557 * @brief Get the wrapping behavior of the label
7559 * @param obj The label object
7562 * @see elm_label_line_wrap_set()
7564 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7566 * @brief Set wrap width of the label
7568 * @param obj The label object
7569 * @param w The wrap width in pixels at a minimum where words need to wrap
7571 * This function sets the maximum width size hint of the label.
7573 * @warning This is only relevant if the label is inside a container.
7575 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7577 * @brief Get wrap width of the label
7579 * @param obj The label object
7580 * @return The wrap width in pixels at a minimum where words need to wrap
7582 * @see elm_label_wrap_width_set()
7584 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7586 * @brief Set wrap height of the label
7588 * @param obj The label object
7589 * @param h The wrap height in pixels at a minimum where words need to wrap
7591 * This function sets the maximum height size hint of the label.
7593 * @warning This is only relevant if the label is inside a container.
7595 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7597 * @brief get wrap width of the label
7599 * @param obj The label object
7600 * @return The wrap height in pixels at a minimum where words need to wrap
7602 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7604 * @brief Set the font size on the label object.
7606 * @param obj The label object
7607 * @param size font size
7609 * @warning NEVER use this. It is for hyper-special cases only. use styles
7610 * instead. e.g. "big", "medium", "small" - or better name them by use:
7611 * "title", "footnote", "quote" etc.
7613 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7615 * @brief Set the text color on the label object
7617 * @param obj The label object
7618 * @param r Red property background color of The label object
7619 * @param g Green property background color of The label object
7620 * @param b Blue property background color of The label object
7621 * @param a Alpha property background color of The label object
7623 * @warning NEVER use this. It is for hyper-special cases only. use styles
7624 * instead. e.g. "big", "medium", "small" - or better name them by use:
7625 * "title", "footnote", "quote" etc.
7627 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);
7629 * @brief Set the text align on the label object
7631 * @param obj The label object
7632 * @param align align mode ("left", "center", "right")
7634 * @warning NEVER use this. It is for hyper-special cases only. use styles
7635 * instead. e.g. "big", "medium", "small" - or better name them by use:
7636 * "title", "footnote", "quote" etc.
7638 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7640 * @brief Set background color of the label
7642 * @param obj The label object
7643 * @param r Red property background color of The label object
7644 * @param g Green property background color of The label object
7645 * @param b Blue property background color of The label object
7646 * @param a Alpha property background alpha of The label object
7648 * @warning NEVER use this. It is for hyper-special cases only. use styles
7649 * instead. e.g. "big", "medium", "small" - or better name them by use:
7650 * "title", "footnote", "quote" etc.
7652 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);
7654 * @brief Set the ellipsis behavior of the label
7656 * @param obj The label object
7657 * @param ellipsis To ellipsis text or not
7659 * If set to true and the text doesn't fit in the label an ellipsis("...")
7660 * will be shown at the end of the widget.
7662 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7663 * choosen wrap method was ELM_WRAP_WORD.
7665 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7666 EINA_DEPRECATED EAPI void elm_label_wrap_mode_set(Evas_Object *obj, Eina_Bool wrapmode) EINA_ARG_NONNULL(1);
7668 * @brief Set the text slide of the label
7670 * @param obj The label object
7671 * @param slide To start slide or stop
7673 * If set to true, the text of the label will slide/scroll through the length of
7676 * @warning This only works with the themes "slide_short", "slide_long" and
7679 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7681 * @brief Get the text slide mode of the label
7683 * @param obj The label object
7684 * @return slide slide mode value
7686 * @see elm_label_slide_set()
7688 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7690 * @brief Set the slide duration(speed) of the label
7692 * @param obj The label object
7693 * @return The duration in seconds in moving text from slide begin position
7694 * to slide end position
7696 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7698 * @brief Get the slide duration(speed) of the label
7700 * @param obj The label object
7701 * @return The duration time in moving text from slide begin position to slide end position
7703 * @see elm_label_slide_duration_set()
7705 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7711 * @defgroup Frame Frame
7713 * @image html img/widget/frame/preview-00.png
7714 * @image latex img/widget/frame/preview-00.eps
7716 * @brief Frame is a widget that holds some content and has a title.
7718 * The default look is a frame with a title, but Frame supports multple
7726 * @li outdent_bottom
7728 * Of all this styles only default shows the title. Frame emits no signals.
7730 * Default contents parts of the frame widget that you can use for are:
7731 * @li "default" - A content of the frame
7733 * Default text parts of the frame widget that you can use for are:
7734 * @li "elm.text" - Label of the frame
7736 * For a detailed example see the @ref tutorial_frame.
7741 * @brief Add a new frame to the parent
7743 * @param parent The parent object
7744 * @return The new object or NULL if it cannot be created
7746 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7748 * @brief Set the frame label
7750 * @param obj The frame object
7751 * @param label The label of this frame object
7753 * @deprecated use elm_object_text_set() instead.
7755 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7757 * @brief Get the frame label
7759 * @param obj The frame object
7761 * @return The label of this frame objet or NULL if unable to get frame
7763 * @deprecated use elm_object_text_get() instead.
7765 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7767 * @brief Set the content of the frame widget
7769 * Once the content object is set, a previously set one will be deleted.
7770 * If you want to keep that old content object, use the
7771 * elm_frame_content_unset() function.
7773 * @param obj The frame object
7774 * @param content The content will be filled in this frame object
7776 * @deprecated use elm_object_content_set() instead.
7778 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7780 * @brief Get the content of the frame widget
7782 * Return the content object which is set for this widget
7784 * @param obj The frame object
7785 * @return The content that is being used
7787 * @deprecated use elm_object_content_get() instead.
7789 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7791 * @brief Unset the content of the frame widget
7793 * Unparent and return the content object which was set for this widget
7795 * @param obj The frame object
7796 * @return The content that was being used
7798 * @deprecated use elm_object_content_unset() instead.
7800 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7806 * @defgroup Table Table
7808 * A container widget to arrange other widgets in a table where items can
7809 * also span multiple columns or rows - even overlap (and then be raised or
7810 * lowered accordingly to adjust stacking if they do overlap).
7812 * For a Table widget the row/column count is not fixed.
7813 * The table widget adjusts itself when subobjects are added to it dynamically.
7815 * The followin are examples of how to use a table:
7816 * @li @ref tutorial_table_01
7817 * @li @ref tutorial_table_02
7822 * @brief Add a new table to the parent
7824 * @param parent The parent object
7825 * @return The new object or NULL if it cannot be created
7827 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7829 * @brief Set the homogeneous layout in the table
7831 * @param obj The layout object
7832 * @param homogeneous A boolean to set if the layout is homogeneous in the
7833 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7835 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7837 * @brief Get the current table homogeneous mode.
7839 * @param obj The table object
7840 * @return A boolean to indicating if the layout is homogeneous in the table
7841 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7843 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7845 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7847 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7849 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7851 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7853 * @brief Set padding between cells.
7855 * @param obj The layout object.
7856 * @param horizontal set the horizontal padding.
7857 * @param vertical set the vertical padding.
7859 * Default value is 0.
7861 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7863 * @brief Get padding between cells.
7865 * @param obj The layout object.
7866 * @param horizontal set the horizontal padding.
7867 * @param vertical set the vertical padding.
7869 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7871 * @brief Add a subobject on the table with the coordinates passed
7873 * @param obj The table object
7874 * @param subobj The subobject to be added to the table
7875 * @param x Row number
7876 * @param y Column number
7880 * @note All positioning inside the table is relative to rows and columns, so
7881 * a value of 0 for x and y, means the top left cell of the table, and a
7882 * value of 1 for w and h means @p subobj only takes that 1 cell.
7884 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7886 * @brief Remove child from table.
7888 * @param obj The table object
7889 * @param subobj The subobject
7891 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7893 * @brief Faster way to remove all child objects from a table object.
7895 * @param obj The table object
7896 * @param clear If true, will delete children, else just remove from table.
7898 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7900 * @brief Set the packing location of an existing child of the table
7902 * @param subobj The subobject to be modified in the table
7903 * @param x Row number
7904 * @param y Column number
7908 * Modifies the position of an object already in the table.
7910 * @note All positioning inside the table is relative to rows and columns, so
7911 * a value of 0 for x and y, means the top left cell of the table, and a
7912 * value of 1 for w and h means @p subobj only takes that 1 cell.
7914 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7916 * @brief Get the packing location of an existing child of the table
7918 * @param subobj The subobject to be modified in the table
7919 * @param x Row number
7920 * @param y Column number
7924 * @see elm_table_pack_set()
7926 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7932 * @defgroup Gengrid Gengrid (Generic grid)
7934 * This widget aims to position objects in a grid layout while
7935 * actually creating and rendering only the visible ones, using the
7936 * same idea as the @ref Genlist "genlist": the user defines a @b
7937 * class for each item, specifying functions that will be called at
7938 * object creation, deletion, etc. When those items are selected by
7939 * the user, a callback function is issued. Users may interact with
7940 * a gengrid via the mouse (by clicking on items to select them and
7941 * clicking on the grid's viewport and swiping to pan the whole
7942 * view) or via the keyboard, navigating through item with the
7945 * @section Gengrid_Layouts Gengrid layouts
7947 * Gengrid may layout its items in one of two possible layouts:
7951 * When in "horizontal mode", items will be placed in @b columns,
7952 * from top to bottom and, when the space for a column is filled,
7953 * another one is started on the right, thus expanding the grid
7954 * horizontally, making for horizontal scrolling. When in "vertical
7955 * mode" , though, items will be placed in @b rows, from left to
7956 * right and, when the space for a row is filled, another one is
7957 * started below, thus expanding the grid vertically (and making
7958 * for vertical scrolling).
7960 * @section Gengrid_Items Gengrid items
7962 * An item in a gengrid can have 0 or more text labels (they can be
7963 * regular text or textblock Evas objects - that's up to the style
7964 * to determine), 0 or more icons (which are simply objects
7965 * swallowed into the gengrid item's theming Edje object) and 0 or
7966 * more <b>boolean states</b>, which have the behavior left to the
7967 * user to define. The Edje part names for each of these properties
7968 * will be looked up, in the theme file for the gengrid, under the
7969 * Edje (string) data items named @c "labels", @c "icons" and @c
7970 * "states", respectively. For each of those properties, if more
7971 * than one part is provided, they must have names listed separated
7972 * by spaces in the data fields. For the default gengrid item
7973 * theme, we have @b one label part (@c "elm.text"), @b two icon
7974 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7977 * A gengrid item may be at one of several styles. Elementary
7978 * provides one by default - "default", but this can be extended by
7979 * system or application custom themes/overlays/extensions (see
7980 * @ref Theme "themes" for more details).
7982 * @section Gengrid_Item_Class Gengrid item classes
7984 * In order to have the ability to add and delete items on the fly,
7985 * gengrid implements a class (callback) system where the
7986 * application provides a structure with information about that
7987 * type of item (gengrid may contain multiple different items with
7988 * different classes, states and styles). Gengrid will call the
7989 * functions in this struct (methods) when an item is "realized"
7990 * (i.e., created dynamically, while the user is scrolling the
7991 * grid). All objects will simply be deleted when no longer needed
7992 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7993 * contains the following members:
7994 * - @c item_style - This is a constant string and simply defines
7995 * the name of the item style. It @b must be specified and the
7996 * default should be @c "default".
7997 * - @c func.label_get - This function is called when an item
7998 * object is actually created. The @c data parameter will point to
7999 * the same data passed to elm_gengrid_item_append() and related
8000 * item creation functions. The @c obj parameter is the gengrid
8001 * object itself, while the @c part one is the name string of one
8002 * of the existing text parts in the Edje group implementing the
8003 * item's theme. This function @b must return a strdup'()ed string,
8004 * as the caller will free() it when done. See
8005 * #Elm_Gengrid_Item_Label_Get_Cb.
8006 * - @c func.content_get - This function is called when an item object
8007 * is actually created. The @c data parameter will point to the
8008 * same data passed to elm_gengrid_item_append() and related item
8009 * creation functions. The @c obj parameter is the gengrid object
8010 * itself, while the @c part one is the name string of one of the
8011 * existing (content) swallow parts in the Edje group implementing the
8012 * item's theme. It must return @c NULL, when no content is desired,
8013 * or a valid object handle, otherwise. The object will be deleted
8014 * by the gengrid on its deletion or when the item is "unrealized".
8015 * See #Elm_Gengrid_Item_Content_Get_Cb.
8016 * - @c func.state_get - This function is called when an item
8017 * object is actually created. The @c data parameter will point to
8018 * the same data passed to elm_gengrid_item_append() and related
8019 * item creation functions. The @c obj parameter is the gengrid
8020 * object itself, while the @c part one is the name string of one
8021 * of the state parts in the Edje group implementing the item's
8022 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8023 * true/on. Gengrids will emit a signal to its theming Edje object
8024 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8025 * "source" arguments, respectively, when the state is true (the
8026 * default is false), where @c XXX is the name of the (state) part.
8027 * See #Elm_Gengrid_Item_State_Get_Cb.
8028 * - @c func.del - This is called when elm_gengrid_item_del() is
8029 * called on an item or elm_gengrid_clear() is called on the
8030 * gengrid. This is intended for use when gengrid items are
8031 * deleted, so any data attached to the item (e.g. its data
8032 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8034 * @section Gengrid_Usage_Hints Usage hints
8036 * If the user wants to have multiple items selected at the same
8037 * time, elm_gengrid_multi_select_set() will permit it. If the
8038 * gengrid is single-selection only (the default), then
8039 * elm_gengrid_select_item_get() will return the selected item or
8040 * @c NULL, if none is selected. If the gengrid is under
8041 * multi-selection, then elm_gengrid_selected_items_get() will
8042 * return a list (that is only valid as long as no items are
8043 * modified (added, deleted, selected or unselected) of child items
8046 * If an item changes (internal (boolean) state, label or content
8047 * changes), then use elm_gengrid_item_update() to have gengrid
8048 * update the item with the new state. A gengrid will re-"realize"
8049 * the item, thus calling the functions in the
8050 * #Elm_Gengrid_Item_Class set for that item.
8052 * To programmatically (un)select an item, use
8053 * elm_gengrid_item_selected_set(). To get its selected state use
8054 * elm_gengrid_item_selected_get(). To make an item disabled
8055 * (unable to be selected and appear differently) use
8056 * elm_gengrid_item_disabled_set() to set this and
8057 * elm_gengrid_item_disabled_get() to get the disabled state.
8059 * Grid cells will only have their selection smart callbacks called
8060 * when firstly getting selected. Any further clicks will do
8061 * nothing, unless you enable the "always select mode", with
8062 * elm_gengrid_always_select_mode_set(), thus making every click to
8063 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8064 * turn off the ability to select items entirely in the widget and
8065 * they will neither appear selected nor call the selection smart
8068 * Remember that you can create new styles and add your own theme
8069 * augmentation per application with elm_theme_extension_add(). If
8070 * you absolutely must have a specific style that overrides any
8071 * theme the user or system sets up you can use
8072 * elm_theme_overlay_add() to add such a file.
8074 * @section Gengrid_Smart_Events Gengrid smart events
8076 * Smart events that you can add callbacks for are:
8077 * - @c "activated" - The user has double-clicked or pressed
8078 * (enter|return|spacebar) on an item. The @c event_info parameter
8079 * is the gengrid item that was activated.
8080 * - @c "clicked,double" - The user has double-clicked an item.
8081 * The @c event_info parameter is the gengrid item that was double-clicked.
8082 * - @c "longpressed" - This is called when the item is pressed for a certain
8083 * amount of time. By default it's 1 second.
8084 * - @c "selected" - The user has made an item selected. The
8085 * @c event_info parameter is the gengrid item that was selected.
8086 * - @c "unselected" - The user has made an item unselected. The
8087 * @c event_info parameter is the gengrid item that was unselected.
8088 * - @c "realized" - This is called when the item in the gengrid
8089 * has its implementing Evas object instantiated, de facto. @c
8090 * event_info is the gengrid item that was created. The object
8091 * may be deleted at any time, so it is highly advised to the
8092 * caller @b not to use the object pointer returned from
8093 * elm_gengrid_item_object_get(), because it may point to freed
8095 * - @c "unrealized" - This is called when the implementing Evas
8096 * object for this item is deleted. @c event_info is the gengrid
8097 * item that was deleted.
8098 * - @c "changed" - Called when an item is added, removed, resized
8099 * or moved and when the gengrid is resized or gets "horizontal"
8101 * - @c "scroll,anim,start" - This is called when scrolling animation has
8103 * - @c "scroll,anim,stop" - This is called when scrolling animation has
8105 * - @c "drag,start,up" - Called when the item in the gengrid has
8106 * been dragged (not scrolled) up.
8107 * - @c "drag,start,down" - Called when the item in the gengrid has
8108 * been dragged (not scrolled) down.
8109 * - @c "drag,start,left" - Called when the item in the gengrid has
8110 * been dragged (not scrolled) left.
8111 * - @c "drag,start,right" - Called when the item in the gengrid has
8112 * been dragged (not scrolled) right.
8113 * - @c "drag,stop" - Called when the item in the gengrid has
8114 * stopped being dragged.
8115 * - @c "drag" - Called when the item in the gengrid is being
8117 * - @c "scroll" - called when the content has been scrolled
8119 * - @c "scroll,drag,start" - called when dragging the content has
8121 * - @c "scroll,drag,stop" - called when dragging the content has
8123 * - @c "edge,top" - This is called when the gengrid is scrolled until
8125 * - @c "edge,bottom" - This is called when the gengrid is scrolled
8126 * until the bottom edge.
8127 * - @c "edge,left" - This is called when the gengrid is scrolled
8128 * until the left edge.
8129 * - @c "edge,right" - This is called when the gengrid is scrolled
8130 * until the right edge.
8132 * List of gengrid examples:
8133 * @li @ref gengrid_example
8137 * @addtogroup Gengrid
8141 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8142 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8143 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8144 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
8145 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. */
8146 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. */
8147 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
8149 /* temporary compatibility code */
8150 typedef Elm_Gengrid_Item_Label_Get_Cb GridItemLabelGetFunc EINA_DEPRECATED;
8151 typedef Elm_Gengrid_Item_Content_Get_Cb GridItemIconGetFunc EINA_DEPRECATED;
8152 typedef Elm_Gengrid_Item_State_Get_Cb GridItemStateGetFunc EINA_DEPRECATED;
8153 typedef Elm_Gengrid_Item_Del_Cb GridItemDelFunc EINA_DEPRECATED;
8156 * @struct _Elm_Gengrid_Item_Class
8158 * Gengrid item class definition. See @ref Gengrid_Item_Class for
8161 struct _Elm_Gengrid_Item_Class
8163 const char *item_style;
8164 struct _Elm_Gengrid_Item_Class_Func
8166 Elm_Gengrid_Item_Label_Get_Cb label_get;
8167 union { /* temporary compatibility code */
8168 Elm_Gengrid_Item_Content_Get_Cb icon_get EINA_DEPRECATED;
8169 Elm_Gengrid_Item_Content_Get_Cb content_get;
8171 Elm_Gengrid_Item_State_Get_Cb state_get;
8172 Elm_Gengrid_Item_Del_Cb del;
8174 }; /**< #Elm_Gengrid_Item_Class member definitions */
8176 * Add a new gengrid widget to the given parent Elementary
8177 * (container) object
8179 * @param parent The parent object
8180 * @return a new gengrid widget handle or @c NULL, on errors
8182 * This function inserts a new gengrid widget on the canvas.
8184 * @see elm_gengrid_item_size_set()
8185 * @see elm_gengrid_group_item_size_set()
8186 * @see elm_gengrid_horizontal_set()
8187 * @see elm_gengrid_item_append()
8188 * @see elm_gengrid_item_del()
8189 * @see elm_gengrid_clear()
8193 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8196 * Set the size for the items of a given gengrid widget
8198 * @param obj The gengrid object.
8199 * @param w The items' width.
8200 * @param h The items' height;
8202 * A gengrid, after creation, has still no information on the size
8203 * to give to each of its cells. So, you most probably will end up
8204 * with squares one @ref Fingers "finger" wide, the default
8205 * size. Use this function to force a custom size for you items,
8206 * making them as big as you wish.
8208 * @see elm_gengrid_item_size_get()
8212 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8215 * Get the size set for the items of a given gengrid widget
8217 * @param obj The gengrid object.
8218 * @param w Pointer to a variable where to store the items' width.
8219 * @param h Pointer to a variable where to store the items' height.
8221 * @note Use @c NULL pointers on the size values you're not
8222 * interested in: they'll be ignored by the function.
8224 * @see elm_gengrid_item_size_get() for more details
8228 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8231 * Set the items grid's alignment within a given gengrid widget
8233 * @param obj The gengrid object.
8234 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8235 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8237 * This sets the alignment of the whole grid of items of a gengrid
8238 * within its given viewport. By default, those values are both
8239 * 0.5, meaning that the gengrid will have its items grid placed
8240 * exactly in the middle of its viewport.
8242 * @note If given alignment values are out of the cited ranges,
8243 * they'll be changed to the nearest boundary values on the valid
8246 * @see elm_gengrid_align_get()
8250 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8253 * Get the items grid's alignment values within a given gengrid
8256 * @param obj The gengrid object.
8257 * @param align_x Pointer to a variable where to store the
8258 * horizontal alignment.
8259 * @param align_y Pointer to a variable where to store the vertical
8262 * @note Use @c NULL pointers on the alignment values you're not
8263 * interested in: they'll be ignored by the function.
8265 * @see elm_gengrid_align_set() for more details
8269 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8272 * Set whether a given gengrid widget is or not able have items
8275 * @param obj The gengrid object
8276 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8277 * @c EINA_FALSE to turn it off
8279 * If a gengrid is set to allow reordering, a click held for more
8280 * than 0.5 over a given item will highlight it specially,
8281 * signalling the gengrid has entered the reordering state. From
8282 * that time on, the user will be able to, while still holding the
8283 * mouse button down, move the item freely in the gengrid's
8284 * viewport, replacing to said item to the locations it goes to.
8285 * The replacements will be animated and, whenever the user
8286 * releases the mouse button, the item being replaced gets a new
8287 * definitive place in the grid.
8289 * @see elm_gengrid_reorder_mode_get()
8293 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8296 * Get whether a given gengrid widget is or not able have items
8299 * @param obj The gengrid object
8300 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8303 * @see elm_gengrid_reorder_mode_set() for more details
8307 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8310 * Append a new item in a given gengrid widget.
8312 * @param obj The gengrid object.
8313 * @param gic The item class for the item.
8314 * @param data The item data.
8315 * @param func Convenience function called when the item is
8317 * @param func_data Data to be passed to @p func.
8318 * @return A handle to the item added or @c NULL, on errors.
8320 * This adds an item to the beginning of the gengrid.
8322 * @see elm_gengrid_item_prepend()
8323 * @see elm_gengrid_item_insert_before()
8324 * @see elm_gengrid_item_insert_after()
8325 * @see elm_gengrid_item_del()
8329 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);
8332 * Prepend a new item in a given gengrid widget.
8334 * @param obj The gengrid object.
8335 * @param gic The item class for the item.
8336 * @param data The item data.
8337 * @param func Convenience function called when the item is
8339 * @param func_data Data to be passed to @p func.
8340 * @return A handle to the item added or @c NULL, on errors.
8342 * This adds an item to the end of the gengrid.
8344 * @see elm_gengrid_item_append()
8345 * @see elm_gengrid_item_insert_before()
8346 * @see elm_gengrid_item_insert_after()
8347 * @see elm_gengrid_item_del()
8351 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);
8354 * Insert an item before another in a gengrid widget
8356 * @param obj The gengrid object.
8357 * @param gic The item class for the item.
8358 * @param data The item data.
8359 * @param relative The item to place this new one before.
8360 * @param func Convenience function called when the item is
8362 * @param func_data Data to be passed to @p func.
8363 * @return A handle to the item added or @c NULL, on errors.
8365 * This inserts an item before another in the gengrid.
8367 * @see elm_gengrid_item_append()
8368 * @see elm_gengrid_item_prepend()
8369 * @see elm_gengrid_item_insert_after()
8370 * @see elm_gengrid_item_del()
8374 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);
8377 * Insert an item after another in a gengrid widget
8379 * @param obj The gengrid object.
8380 * @param gic The item class for the item.
8381 * @param data The item data.
8382 * @param relative The item to place this new one after.
8383 * @param func Convenience function called when the item is
8385 * @param func_data Data to be passed to @p func.
8386 * @return A handle to the item added or @c NULL, on errors.
8388 * This inserts an item after another in the gengrid.
8390 * @see elm_gengrid_item_append()
8391 * @see elm_gengrid_item_prepend()
8392 * @see elm_gengrid_item_insert_after()
8393 * @see elm_gengrid_item_del()
8397 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);
8400 * Insert an item in a gengrid widget using a user-defined sort function.
8402 * @param obj The gengrid object.
8403 * @param gic The item class for the item.
8404 * @param data The item data.
8405 * @param comp User defined comparison function that defines the sort order based on
8406 * Elm_Gen_Item and its data param.
8407 * @param func Convenience function called when the item is selected.
8408 * @param func_data Data to be passed to @p func.
8409 * @return A handle to the item added or @c NULL, on errors.
8411 * This inserts an item in the gengrid based on user defined comparison function.
8413 * @see elm_gengrid_item_append()
8414 * @see elm_gengrid_item_prepend()
8415 * @see elm_gengrid_item_insert_after()
8416 * @see elm_gengrid_item_del()
8417 * @see elm_gengrid_item_direct_sorted_insert()
8421 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);
8424 * Insert an item in a gengrid widget using a user-defined sort function.
8426 * @param obj The gengrid object.
8427 * @param gic The item class for the item.
8428 * @param data The item data.
8429 * @param comp User defined comparison function that defines the sort order based on
8431 * @param func Convenience function called when the item is selected.
8432 * @param func_data Data to be passed to @p func.
8433 * @return A handle to the item added or @c NULL, on errors.
8435 * This inserts an item in the gengrid based on user defined comparison function.
8437 * @see elm_gengrid_item_append()
8438 * @see elm_gengrid_item_prepend()
8439 * @see elm_gengrid_item_insert_after()
8440 * @see elm_gengrid_item_del()
8441 * @see elm_gengrid_item_sorted_insert()
8445 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);
8448 * Set whether items on a given gengrid widget are to get their
8449 * selection callbacks issued for @b every subsequent selection
8450 * click on them or just for the first click.
8452 * @param obj The gengrid object
8453 * @param always_select @c EINA_TRUE to make items "always
8454 * selected", @c EINA_FALSE, otherwise
8456 * By default, grid items will only call their selection callback
8457 * function when firstly getting selected, any subsequent further
8458 * clicks will do nothing. With this call, you make those
8459 * subsequent clicks also to issue the selection callbacks.
8461 * @note <b>Double clicks</b> will @b always be reported on items.
8463 * @see elm_gengrid_always_select_mode_get()
8467 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8470 * Get whether items on a given gengrid widget have their selection
8471 * callbacks issued for @b every subsequent selection click on them
8472 * or just for the first click.
8474 * @param obj The gengrid object.
8475 * @return @c EINA_TRUE if the gengrid items are "always selected",
8476 * @c EINA_FALSE, otherwise
8478 * @see elm_gengrid_always_select_mode_set() for more details
8482 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8485 * Set whether items on a given gengrid widget can be selected or not.
8487 * @param obj The gengrid object
8488 * @param no_select @c EINA_TRUE to make items selectable,
8489 * @c EINA_FALSE otherwise
8491 * This will make items in @p obj selectable or not. In the latter
8492 * case, any user interaction on the gengrid items will neither make
8493 * them appear selected nor them call their selection callback
8496 * @see elm_gengrid_no_select_mode_get()
8500 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8503 * Get whether items on a given gengrid widget can be selected or
8506 * @param obj The gengrid object
8507 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8510 * @see elm_gengrid_no_select_mode_set() for more details
8514 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8517 * Enable or disable multi-selection in a given gengrid widget
8519 * @param obj The gengrid object.
8520 * @param multi @c EINA_TRUE, to enable multi-selection,
8521 * @c EINA_FALSE to disable it.
8523 * Multi-selection is the ability to have @b more than one
8524 * item selected, on a given gengrid, simultaneously. When it is
8525 * enabled, a sequence of clicks on different items will make them
8526 * all selected, progressively. A click on an already selected item
8527 * will unselect it. If interacting via the keyboard,
8528 * multi-selection is enabled while holding the "Shift" key.
8530 * @note By default, multi-selection is @b disabled on gengrids
8532 * @see elm_gengrid_multi_select_get()
8536 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8539 * Get whether multi-selection is enabled or disabled for a given
8542 * @param obj The gengrid object.
8543 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8544 * EINA_FALSE otherwise
8546 * @see elm_gengrid_multi_select_set() for more details
8550 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8553 * Enable or disable bouncing effect for a given gengrid widget
8555 * @param obj The gengrid object
8556 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8557 * @c EINA_FALSE to disable it
8558 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8559 * @c EINA_FALSE to disable it
8561 * The bouncing effect occurs whenever one reaches the gengrid's
8562 * edge's while panning it -- it will scroll past its limits a
8563 * little bit and return to the edge again, in a animated for,
8566 * @note By default, gengrids have bouncing enabled on both axis
8568 * @see elm_gengrid_bounce_get()
8572 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8575 * Get whether bouncing effects are enabled or disabled, for a
8576 * given gengrid widget, on each axis
8578 * @param obj The gengrid object
8579 * @param h_bounce Pointer to a variable where to store the
8580 * horizontal bouncing flag.
8581 * @param v_bounce Pointer to a variable where to store the
8582 * vertical bouncing flag.
8584 * @see elm_gengrid_bounce_set() for more details
8588 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8591 * Set a given gengrid widget's scrolling page size, relative to
8592 * its viewport size.
8594 * @param obj The gengrid object
8595 * @param h_pagerel The horizontal page (relative) size
8596 * @param v_pagerel The vertical page (relative) size
8598 * The gengrid's scroller is capable of binding scrolling by the
8599 * user to "pages". It means that, while scrolling and, specially
8600 * after releasing the mouse button, the grid will @b snap to the
8601 * nearest displaying page's area. When page sizes are set, the
8602 * grid's continuous content area is split into (equal) page sized
8605 * This function sets the size of a page <b>relatively to the
8606 * viewport dimensions</b> of the gengrid, for each axis. A value
8607 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8608 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8609 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8610 * 1.0. Values beyond those will make it behave behave
8611 * inconsistently. If you only want one axis to snap to pages, use
8612 * the value @c 0.0 for the other one.
8614 * There is a function setting page size values in @b absolute
8615 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8616 * is mutually exclusive to this one.
8618 * @see elm_gengrid_page_relative_get()
8622 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8625 * Get a given gengrid widget's scrolling page size, relative to
8626 * its viewport size.
8628 * @param obj The gengrid object
8629 * @param h_pagerel Pointer to a variable where to store the
8630 * horizontal page (relative) size
8631 * @param v_pagerel Pointer to a variable where to store the
8632 * vertical page (relative) size
8634 * @see elm_gengrid_page_relative_set() for more details
8638 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8641 * Set a given gengrid widget's scrolling page size
8643 * @param obj The gengrid object
8644 * @param h_pagerel The horizontal page size, in pixels
8645 * @param v_pagerel The vertical page size, in pixels
8647 * The gengrid's scroller is capable of binding scrolling by the
8648 * user to "pages". It means that, while scrolling and, specially
8649 * after releasing the mouse button, the grid will @b snap to the
8650 * nearest displaying page's area. When page sizes are set, the
8651 * grid's continuous content area is split into (equal) page sized
8654 * This function sets the size of a page of the gengrid, in pixels,
8655 * for each axis. Sane usable values are, between @c 0 and the
8656 * dimensions of @p obj, for each axis. Values beyond those will
8657 * make it behave behave inconsistently. If you only want one axis
8658 * to snap to pages, use the value @c 0 for the other one.
8660 * There is a function setting page size values in @b relative
8661 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8662 * use is mutually exclusive to this one.
8666 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8669 * Set the direction in which a given gengrid widget will expand while
8670 * placing its items.
8672 * @param obj The gengrid object.
8673 * @param setting @c EINA_TRUE to make the gengrid expand
8674 * horizontally, @c EINA_FALSE to expand vertically.
8676 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8677 * in @b columns, from top to bottom and, when the space for a
8678 * column is filled, another one is started on the right, thus
8679 * expanding the grid horizontally. When in "vertical mode"
8680 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8681 * to right and, when the space for a row is filled, another one is
8682 * started below, thus expanding the grid vertically.
8684 * @see elm_gengrid_horizontal_get()
8688 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8691 * Get for what direction a given gengrid widget will expand while
8692 * placing its items.
8694 * @param obj The gengrid object.
8695 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8696 * @c EINA_FALSE if it's set to expand vertically.
8698 * @see elm_gengrid_horizontal_set() for more detais
8702 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8705 * Get the first item in a given gengrid widget
8707 * @param obj The gengrid object
8708 * @return The first item's handle or @c NULL, if there are no
8709 * items in @p obj (and on errors)
8711 * This returns the first item in the @p obj's internal list of
8714 * @see elm_gengrid_last_item_get()
8718 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8721 * Get the last item in a given gengrid widget
8723 * @param obj The gengrid object
8724 * @return The last item's handle or @c NULL, if there are no
8725 * items in @p obj (and on errors)
8727 * This returns the last item in the @p obj's internal list of
8730 * @see elm_gengrid_first_item_get()
8734 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8737 * Get the @b next item in a gengrid widget's internal list of items,
8738 * given a handle to one of those items.
8740 * @param item The gengrid item to fetch next from
8741 * @return The item after @p item, or @c NULL if there's none (and
8744 * This returns the item placed after the @p item, on the container
8747 * @see elm_gengrid_item_prev_get()
8751 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8754 * Get the @b previous item in a gengrid widget's internal list of items,
8755 * given a handle to one of those items.
8757 * @param item The gengrid item to fetch previous from
8758 * @return The item before @p item, or @c NULL if there's none (and
8761 * This returns the item placed before the @p item, on the container
8764 * @see elm_gengrid_item_next_get()
8768 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8771 * Get the gengrid object's handle which contains a given gengrid
8774 * @param item The item to fetch the container from
8775 * @return The gengrid (parent) object
8777 * This returns the gengrid object itself that an item belongs to.
8781 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8784 * Remove a gengrid item from its parent, deleting it.
8786 * @param item The item to be removed.
8787 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8789 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8794 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8797 * Update the contents of a given gengrid item
8799 * @param item The gengrid item
8801 * This updates an item by calling all the item class functions
8802 * again to get the contents, labels and states. Use this when the
8803 * original item data has changed and you want the changes to be
8808 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8811 * Get the Gengrid Item class for the given Gengrid Item.
8813 * @param item The gengrid item
8815 * This returns the Gengrid_Item_Class for the given item. It can be used to examine
8816 * the function pointers and item_style.
8820 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8823 * Get the Gengrid Item class for the given Gengrid Item.
8825 * This sets the Gengrid_Item_Class for the given item. It can be used to examine
8826 * the function pointers and item_style.
8828 * @param item The gengrid item
8829 * @param gic The gengrid item class describing the function pointers and the item style.
8833 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8836 * Return the data associated to a given gengrid item
8838 * @param item The gengrid item.
8839 * @return the data associated with this item.
8841 * This returns the @c data value passed on the
8842 * elm_gengrid_item_append() and related item addition calls.
8844 * @see elm_gengrid_item_append()
8845 * @see elm_gengrid_item_data_set()
8849 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8852 * Set the data associated with a given gengrid item
8854 * @param item The gengrid item
8855 * @param data The data pointer to set on it
8857 * This @b overrides the @c data value passed on the
8858 * elm_gengrid_item_append() and related item addition calls. This
8859 * function @b won't call elm_gengrid_item_update() automatically,
8860 * so you'd issue it afterwards if you want to have the item
8861 * updated to reflect the new data.
8863 * @see elm_gengrid_item_data_get()
8864 * @see elm_gengrid_item_update()
8868 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8871 * Get a given gengrid item's position, relative to the whole
8872 * gengrid's grid area.
8874 * @param item The Gengrid item.
8875 * @param x Pointer to variable to store the item's <b>row number</b>.
8876 * @param y Pointer to variable to store the item's <b>column number</b>.
8878 * This returns the "logical" position of the item within the
8879 * gengrid. For example, @c (0, 1) would stand for first row,
8884 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8887 * Set whether a given gengrid item is selected or not
8889 * @param item The gengrid item
8890 * @param selected Use @c EINA_TRUE, to make it selected, @c
8891 * EINA_FALSE to make it unselected
8893 * This sets the selected state of an item. If multi-selection is
8894 * not enabled on the containing gengrid and @p selected is @c
8895 * EINA_TRUE, any other previously selected items will get
8896 * unselected in favor of this new one.
8898 * @see elm_gengrid_item_selected_get()
8902 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8905 * Get whether a given gengrid item is selected or not
8907 * @param item The gengrid item
8908 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8910 * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
8912 * @see elm_gengrid_item_selected_set() for more details
8916 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8919 * Get the real Evas object created to implement the view of a
8920 * given gengrid item
8922 * @param item The gengrid item.
8923 * @return the Evas object implementing this item's view.
8925 * This returns the actual Evas object used to implement the
8926 * specified gengrid item's view. This may be @c NULL, as it may
8927 * not have been created or may have been deleted, at any time, by
8928 * the gengrid. <b>Do not modify this object</b> (move, resize,
8929 * show, hide, etc.), as the gengrid is controlling it. This
8930 * function is for querying, emitting custom signals or hooking
8931 * lower level callbacks for events on that object. Do not delete
8932 * this object under any circumstances.
8934 * @see elm_gengrid_item_data_get()
8938 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8941 * Show the portion of a gengrid's internal grid containing a given
8942 * item, @b immediately.
8944 * @param item The item to display
8946 * This causes gengrid to @b redraw its viewport's contents to the
8947 * region contining the given @p item item, if it is not fully
8950 * @see elm_gengrid_item_bring_in()
8954 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8957 * Animatedly bring in, to the visible area of a gengrid, a given
8960 * @param item The gengrid item to display
8962 * This causes gengrid to jump to the given @p item and show
8963 * it (by scrolling), if it is not fully visible. This will use
8964 * animation to do so and take a period of time to complete.
8966 * @see elm_gengrid_item_show()
8970 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8973 * Set whether a given gengrid item is disabled or not.
8975 * @param item The gengrid item
8976 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8977 * to enable it back.
8979 * A disabled item cannot be selected or unselected. It will also
8980 * change its appearance, to signal the user it's disabled.
8982 * @see elm_gengrid_item_disabled_get()
8986 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8989 * Get whether a given gengrid item is disabled or not.
8991 * @param item The gengrid item
8992 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8995 * @see elm_gengrid_item_disabled_set() for more details
8999 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9002 * Set the text to be shown in a given gengrid item's tooltips.
9004 * @param item The gengrid item
9005 * @param text The text to set in the content
9007 * This call will setup the text to be used as tooltip to that item
9008 * (analogous to elm_object_tooltip_text_set(), but being item
9009 * tooltips with higher precedence than object tooltips). It can
9010 * have only one tooltip at a time, so any previous tooltip data
9015 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9018 * Set the content to be shown in a given gengrid item's tooltip
9020 * @param item The gengrid item.
9021 * @param func The function returning the tooltip contents.
9022 * @param data What to provide to @a func as callback data/context.
9023 * @param del_cb Called when data is not needed anymore, either when
9024 * another callback replaces @p func, the tooltip is unset with
9025 * elm_gengrid_item_tooltip_unset() or the owner @p item
9026 * dies. This callback receives as its first parameter the
9027 * given @p data, being @c event_info the item handle.
9029 * This call will setup the tooltip's contents to @p item
9030 * (analogous to elm_object_tooltip_content_cb_set(), but being
9031 * item tooltips with higher precedence than object tooltips). It
9032 * can have only one tooltip at a time, so any previous tooltip
9033 * content will get removed. @p func (with @p data) will be called
9034 * every time Elementary needs to show the tooltip and it should
9035 * return a valid Evas object, which will be fully managed by the
9036 * tooltip system, getting deleted when the tooltip is gone.
9040 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);
9043 * Unset a tooltip from a given gengrid item
9045 * @param item gengrid item to remove a previously set tooltip from.
9047 * This call removes any tooltip set on @p item. The callback
9048 * provided as @c del_cb to
9049 * elm_gengrid_item_tooltip_content_cb_set() will be called to
9050 * notify it is not used anymore (and have resources cleaned, if
9053 * @see elm_gengrid_item_tooltip_content_cb_set()
9057 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9060 * Set a different @b style for a given gengrid item's tooltip.
9062 * @param item gengrid item with tooltip set
9063 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9064 * "default", @c "transparent", etc)
9066 * Tooltips can have <b>alternate styles</b> to be displayed on,
9067 * which are defined by the theme set on Elementary. This function
9068 * works analogously as elm_object_tooltip_style_set(), but here
9069 * applied only to gengrid item objects. The default style for
9070 * tooltips is @c "default".
9072 * @note before you set a style you should define a tooltip with
9073 * elm_gengrid_item_tooltip_content_cb_set() or
9074 * elm_gengrid_item_tooltip_text_set()
9076 * @see elm_gengrid_item_tooltip_style_get()
9080 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9083 * Get the style set a given gengrid item's tooltip.
9085 * @param item gengrid item with tooltip already set on.
9086 * @return style the theme style in use, which defaults to
9087 * "default". If the object does not have a tooltip set,
9088 * then @c NULL is returned.
9090 * @see elm_gengrid_item_tooltip_style_set() for more details
9094 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9096 * Set the type of mouse pointer/cursor decoration to be shown,
9097 * when the mouse pointer is over the given gengrid widget item
9099 * @param item gengrid item to customize cursor on
9100 * @param cursor the cursor type's name
9102 * This function works analogously as elm_object_cursor_set(), but
9103 * here the cursor's changing area is restricted to the item's
9104 * area, and not the whole widget's. Note that that item cursors
9105 * have precedence over widget cursors, so that a mouse over @p
9106 * item will always show cursor @p type.
9108 * If this function is called twice for an object, a previously set
9109 * cursor will be unset on the second call.
9111 * @see elm_object_cursor_set()
9112 * @see elm_gengrid_item_cursor_get()
9113 * @see elm_gengrid_item_cursor_unset()
9117 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9120 * Get the type of mouse pointer/cursor decoration set to be shown,
9121 * when the mouse pointer is over the given gengrid widget item
9123 * @param item gengrid item with custom cursor set
9124 * @return the cursor type's name or @c NULL, if no custom cursors
9125 * were set to @p item (and on errors)
9127 * @see elm_object_cursor_get()
9128 * @see elm_gengrid_item_cursor_set() for more details
9129 * @see elm_gengrid_item_cursor_unset()
9133 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9136 * Unset any custom mouse pointer/cursor decoration set to be
9137 * shown, when the mouse pointer is over the given gengrid widget
9138 * item, thus making it show the @b default cursor again.
9140 * @param item a gengrid item
9142 * Use this call to undo any custom settings on this item's cursor
9143 * decoration, bringing it back to defaults (no custom style set).
9145 * @see elm_object_cursor_unset()
9146 * @see elm_gengrid_item_cursor_set() for more details
9150 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9153 * Set a different @b style for a given custom cursor set for a
9156 * @param item gengrid item with custom cursor set
9157 * @param style the <b>theme style</b> to use (e.g. @c "default",
9158 * @c "transparent", etc)
9160 * This function only makes sense when one is using custom mouse
9161 * cursor decorations <b>defined in a theme file</b> , which can
9162 * have, given a cursor name/type, <b>alternate styles</b> on
9163 * it. It works analogously as elm_object_cursor_style_set(), but
9164 * here applied only to gengrid item objects.
9166 * @warning Before you set a cursor style you should have defined a
9167 * custom cursor previously on the item, with
9168 * elm_gengrid_item_cursor_set()
9170 * @see elm_gengrid_item_cursor_engine_only_set()
9171 * @see elm_gengrid_item_cursor_style_get()
9175 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9178 * Get the current @b style set for a given gengrid item's custom
9181 * @param item gengrid item with custom cursor set.
9182 * @return style the cursor style in use. If the object does not
9183 * have a cursor set, then @c NULL is returned.
9185 * @see elm_gengrid_item_cursor_style_set() for more details
9189 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9192 * Set if the (custom) cursor for a given gengrid item should be
9193 * searched in its theme, also, or should only rely on the
9196 * @param item item with custom (custom) cursor already set on
9197 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9198 * only on those provided by the rendering engine, @c EINA_FALSE to
9199 * have them searched on the widget's theme, as well.
9201 * @note This call is of use only if you've set a custom cursor
9202 * for gengrid items, with elm_gengrid_item_cursor_set().
9204 * @note By default, cursors will only be looked for between those
9205 * provided by the rendering engine.
9209 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9212 * Get if the (custom) cursor for a given gengrid item is being
9213 * searched in its theme, also, or is only relying on the rendering
9216 * @param item a gengrid item
9217 * @return @c EINA_TRUE, if cursors are being looked for only on
9218 * those provided by the rendering engine, @c EINA_FALSE if they
9219 * are being searched on the widget's theme, as well.
9221 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9225 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9228 * Remove all items from a given gengrid widget
9230 * @param obj The gengrid object.
9232 * This removes (and deletes) all items in @p obj, leaving it
9235 * @see elm_gengrid_item_del(), to remove just one item.
9239 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9242 * Get the selected item in a given gengrid widget
9244 * @param obj The gengrid object.
9245 * @return The selected item's handleor @c NULL, if none is
9246 * selected at the moment (and on errors)
9248 * This returns the selected item in @p obj. If multi selection is
9249 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9250 * the first item in the list is selected, which might not be very
9251 * useful. For that case, see elm_gengrid_selected_items_get().
9255 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9258 * Get <b>a list</b> of selected items in a given gengrid
9260 * @param obj The gengrid object.
9261 * @return The list of selected items or @c NULL, if none is
9262 * selected at the moment (and on errors)
9264 * This returns a list of the selected items, in the order that
9265 * they appear in the grid. This list is only valid as long as no
9266 * more items are selected or unselected (or unselected implictly
9267 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9270 * @see elm_gengrid_selected_item_get()
9274 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9281 * @defgroup Clock Clock
9283 * @image html img/widget/clock/preview-00.png
9284 * @image latex img/widget/clock/preview-00.eps
9286 * This is a @b digital clock widget. In its default theme, it has a
9287 * vintage "flipping numbers clock" appearance, which will animate
9288 * sheets of individual algarisms individually as time goes by.
9290 * A newly created clock will fetch system's time (already
9291 * considering local time adjustments) to start with, and will tick
9292 * accondingly. It may or may not show seconds.
9294 * Clocks have an @b edition mode. When in it, the sheets will
9295 * display extra arrow indications on the top and bottom and the
9296 * user may click on them to raise or lower the time values. After
9297 * it's told to exit edition mode, it will keep ticking with that
9298 * new time set (it keeps the difference from local time).
9300 * Also, when under edition mode, user clicks on the cited arrows
9301 * which are @b held for some time will make the clock to flip the
9302 * sheet, thus editing the time, continuosly and automatically for
9303 * the user. The interval between sheet flips will keep growing in
9304 * time, so that it helps the user to reach a time which is distant
9307 * The time display is, by default, in military mode (24h), but an
9308 * am/pm indicator may be optionally shown, too, when it will
9311 * Smart callbacks one can register to:
9312 * - "changed" - the clock's user changed the time
9314 * Here is an example on its usage:
9315 * @li @ref clock_example
9324 * Identifiers for which clock digits should be editable, when a
9325 * clock widget is in edition mode. Values may be ORed together to
9326 * make a mask, naturally.
9328 * @see elm_clock_edit_set()
9329 * @see elm_clock_digit_edit_set()
9331 typedef enum _Elm_Clock_Digedit
9333 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9334 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9335 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9336 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9337 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9338 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9339 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9340 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9341 } Elm_Clock_Digedit;
9344 * Add a new clock widget to the given parent Elementary
9345 * (container) object
9347 * @param parent The parent object
9348 * @return a new clock widget handle or @c NULL, on errors
9350 * This function inserts a new clock widget on the canvas.
9354 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9357 * Set a clock widget's time, programmatically
9359 * @param obj The clock widget object
9360 * @param hrs The hours to set
9361 * @param min The minutes to set
9362 * @param sec The secondes to set
9364 * This function updates the time that is showed by the clock
9367 * Values @b must be set within the following ranges:
9368 * - 0 - 23, for hours
9369 * - 0 - 59, for minutes
9370 * - 0 - 59, for seconds,
9372 * even if the clock is not in "military" mode.
9374 * @warning The behavior for values set out of those ranges is @b
9379 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9382 * Get a clock widget's time values
9384 * @param obj The clock object
9385 * @param[out] hrs Pointer to the variable to get the hours value
9386 * @param[out] min Pointer to the variable to get the minutes value
9387 * @param[out] sec Pointer to the variable to get the seconds value
9389 * This function gets the time set for @p obj, returning
9390 * it on the variables passed as the arguments to function
9392 * @note Use @c NULL pointers on the time values you're not
9393 * interested in: they'll be ignored by the function.
9397 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9400 * Set whether a given clock widget is under <b>edition mode</b> or
9401 * under (default) displaying-only mode.
9403 * @param obj The clock object
9404 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9405 * put it back to "displaying only" mode
9407 * This function makes a clock's time to be editable or not <b>by
9408 * user interaction</b>. When in edition mode, clocks @b stop
9409 * ticking, until one brings them back to canonical mode. The
9410 * elm_clock_digit_edit_set() function will influence which digits
9411 * of the clock will be editable. By default, all of them will be
9412 * (#ELM_CLOCK_NONE).
9414 * @note am/pm sheets, if being shown, will @b always be editable
9415 * under edition mode.
9417 * @see elm_clock_edit_get()
9421 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9424 * Retrieve whether a given clock widget is under <b>edition
9425 * mode</b> or under (default) displaying-only mode.
9427 * @param obj The clock object
9428 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9431 * This function retrieves whether the clock's time can be edited
9432 * or not by user interaction.
9434 * @see elm_clock_edit_set() for more details
9438 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9441 * Set what digits of the given clock widget should be editable
9442 * when in edition mode.
9444 * @param obj The clock object
9445 * @param digedit Bit mask indicating the digits to be editable
9446 * (values in #Elm_Clock_Digedit).
9448 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9449 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9452 * @see elm_clock_digit_edit_get()
9456 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9459 * Retrieve what digits of the given clock widget should be
9460 * editable when in edition mode.
9462 * @param obj The clock object
9463 * @return Bit mask indicating the digits to be editable
9464 * (values in #Elm_Clock_Digedit).
9466 * @see elm_clock_digit_edit_set() for more details
9470 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9473 * Set if the given clock widget must show hours in military or
9476 * @param obj The clock object
9477 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9480 * This function sets if the clock must show hours in military or
9481 * am/pm mode. In some countries like Brazil the military mode
9482 * (00-24h-format) is used, in opposition to the USA, where the
9483 * am/pm mode is more commonly used.
9485 * @see elm_clock_show_am_pm_get()
9489 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9492 * Get if the given clock widget shows hours in military or am/pm
9495 * @param obj The clock object
9496 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9499 * This function gets if the clock shows hours in military or am/pm
9502 * @see elm_clock_show_am_pm_set() for more details
9506 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9509 * Set if the given clock widget must show time with seconds or not
9511 * @param obj The clock object
9512 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9514 * This function sets if the given clock must show or not elapsed
9515 * seconds. By default, they are @b not shown.
9517 * @see elm_clock_show_seconds_get()
9521 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9524 * Get whether the given clock widget is showing time with seconds
9527 * @param obj The clock object
9528 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9530 * This function gets whether @p obj is showing or not the elapsed
9533 * @see elm_clock_show_seconds_set()
9537 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9540 * Set the interval on time updates for an user mouse button hold
9541 * on clock widgets' time edition.
9543 * @param obj The clock object
9544 * @param interval The (first) interval value in seconds
9546 * This interval value is @b decreased while the user holds the
9547 * mouse pointer either incrementing or decrementing a given the
9548 * clock digit's value.
9550 * This helps the user to get to a given time distant from the
9551 * current one easier/faster, as it will start to flip quicker and
9552 * quicker on mouse button holds.
9554 * The calculation for the next flip interval value, starting from
9555 * the one set with this call, is the previous interval divided by
9556 * 1.05, so it decreases a little bit.
9558 * The default starting interval value for automatic flips is
9561 * @see elm_clock_interval_get()
9565 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9568 * Get the interval on time updates for an user mouse button hold
9569 * on clock widgets' time edition.
9571 * @param obj The clock object
9572 * @return The (first) interval value, in seconds, set on it
9574 * @see elm_clock_interval_set() for more details
9578 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9585 * @defgroup Layout Layout
9587 * @image html img/widget/layout/preview-00.png
9588 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9590 * @image html img/layout-predefined.png
9591 * @image latex img/layout-predefined.eps width=\textwidth
9593 * This is a container widget that takes a standard Edje design file and
9594 * wraps it very thinly in a widget.
9596 * An Edje design (theme) file has a very wide range of possibilities to
9597 * describe the behavior of elements added to the Layout. Check out the Edje
9598 * documentation and the EDC reference to get more information about what can
9599 * be done with Edje.
9601 * Just like @ref List, @ref Box, and other container widgets, any
9602 * object added to the Layout will become its child, meaning that it will be
9603 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9605 * The Layout widget can contain as many Contents, Boxes or Tables as
9606 * described in its theme file. For instance, objects can be added to
9607 * different Tables by specifying the respective Table part names. The same
9608 * is valid for Content and Box.
9610 * The objects added as child of the Layout will behave as described in the
9611 * part description where they were added. There are 3 possible types of
9612 * parts where a child can be added:
9614 * @section secContent Content (SWALLOW part)
9616 * Only one object can be added to the @c SWALLOW part (but you still can
9617 * have many @c SWALLOW parts and one object on each of them). Use the @c
9618 * elm_object_content_set/get/unset functions to set, retrieve and unset
9619 * objects as content of the @c SWALLOW. After being set to this part, the
9620 * object size, position, visibility, clipping and other description
9621 * properties will be totally controled by the description of the given part
9622 * (inside the Edje theme file).
9624 * One can use @c evas_object_size_hint_* functions on the child to have some
9625 * kind of control over its behavior, but the resulting behavior will still
9626 * depend heavily on the @c SWALLOW part description.
9628 * The Edje theme also can change the part description, based on signals or
9629 * scripts running inside the theme. This change can also be animated. All of
9630 * this will affect the child object set as content accordingly. The object
9631 * size will be changed if the part size is changed, it will animate move if
9632 * the part is moving, and so on.
9634 * The following picture demonstrates a Layout widget with a child object
9635 * added to its @c SWALLOW:
9637 * @image html layout_swallow.png
9638 * @image latex layout_swallow.eps width=\textwidth
9640 * @section secBox Box (BOX part)
9642 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9643 * allows one to add objects to the box and have them distributed along its
9644 * area, accordingly to the specified @a layout property (now by @a layout we
9645 * mean the chosen layouting design of the Box, not the Layout widget
9648 * A similar effect for having a box with its position, size and other things
9649 * controled by the Layout theme would be to create an Elementary @ref Box
9650 * widget and add it as a Content in the @c SWALLOW part.
9652 * The main difference of using the Layout Box is that its behavior, the box
9653 * properties like layouting format, padding, align, etc. will be all
9654 * controled by the theme. This means, for example, that a signal could be
9655 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9656 * handled the signal by changing the box padding, or align, or both. Using
9657 * the Elementary @ref Box widget is not necessarily harder or easier, it
9658 * just depends on the circunstances and requirements.
9660 * The Layout Box can be used through the @c elm_layout_box_* set of
9663 * The following picture demonstrates a Layout widget with many child objects
9664 * added to its @c BOX part:
9666 * @image html layout_box.png
9667 * @image latex layout_box.eps width=\textwidth
9669 * @section secTable Table (TABLE part)
9671 * Just like the @ref secBox, the Layout Table is very similar to the
9672 * Elementary @ref Table widget. It allows one to add objects to the Table
9673 * specifying the row and column where the object should be added, and any
9674 * column or row span if necessary.
9676 * Again, we could have this design by adding a @ref Table widget to the @c
9677 * SWALLOW part using elm_object_part_content_set(). The same difference happens
9678 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9679 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9681 * The Layout Table can be used through the @c elm_layout_table_* set of
9684 * The following picture demonstrates a Layout widget with many child objects
9685 * added to its @c TABLE part:
9687 * @image html layout_table.png
9688 * @image latex layout_table.eps width=\textwidth
9690 * @section secPredef Predefined Layouts
9692 * Another interesting thing about the Layout widget is that it offers some
9693 * predefined themes that come with the default Elementary theme. These
9694 * themes can be set by the call elm_layout_theme_set(), and provide some
9695 * basic functionality depending on the theme used.
9697 * Most of them already send some signals, some already provide a toolbar or
9698 * back and next buttons.
9700 * These are available predefined theme layouts. All of them have class = @c
9701 * layout, group = @c application, and style = one of the following options:
9703 * @li @c toolbar-content - application with toolbar and main content area
9704 * @li @c toolbar-content-back - application with toolbar and main content
9705 * area with a back button and title area
9706 * @li @c toolbar-content-back-next - application with toolbar and main
9707 * content area with a back and next buttons and title area
9708 * @li @c content-back - application with a main content area with a back
9709 * button and title area
9710 * @li @c content-back-next - application with a main content area with a
9711 * back and next buttons and title area
9712 * @li @c toolbar-vbox - application with toolbar and main content area as a
9714 * @li @c toolbar-table - application with toolbar and main content area as a
9717 * @section secExamples Examples
9719 * Some examples of the Layout widget can be found here:
9720 * @li @ref layout_example_01
9721 * @li @ref layout_example_02
9722 * @li @ref layout_example_03
9723 * @li @ref layout_example_edc
9728 * Add a new layout to the parent
9730 * @param parent The parent object
9731 * @return The new object or NULL if it cannot be created
9733 * @see elm_layout_file_set()
9734 * @see elm_layout_theme_set()
9738 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9740 * Set the file that will be used as layout
9742 * @param obj The layout object
9743 * @param file The path to file (edj) that will be used as layout
9744 * @param group The group that the layout belongs in edje file
9746 * @return (1 = success, 0 = error)
9750 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9752 * Set the edje group from the elementary theme that will be used as layout
9754 * @param obj The layout object
9755 * @param clas the clas of the group
9756 * @param group the group
9757 * @param style the style to used
9759 * @return (1 = success, 0 = error)
9763 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9765 * Set the layout content.
9767 * @param obj The layout object
9768 * @param swallow The swallow part name in the edje file
9769 * @param content The child that will be added in this layout object
9771 * Once the content object is set, a previously set one will be deleted.
9772 * If you want to keep that old content object, use the
9773 * elm_object_part_content_unset() function.
9775 * @note In an Edje theme, the part used as a content container is called @c
9776 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9777 * expected to be a part name just like the second parameter of
9778 * elm_layout_box_append().
9780 * @see elm_layout_box_append()
9781 * @see elm_object_content_part_get()
9782 * @see elm_object_content_part_unset()
9787 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9789 * Get the child object in the given content part.
9791 * @param obj The layout object
9792 * @param swallow The SWALLOW part to get its content
9794 * @return The swallowed object or NULL if none or an error occurred
9796 * @see elm_object_content_part_set()
9800 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9802 * Unset the layout content.
9804 * @param obj The layout object
9805 * @param swallow The swallow part name in the edje file
9806 * @return The content that was being used
9808 * Unparent and return the content object which was set for this part.
9810 * @see elm_object_content_part_set()
9814 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9816 * Set the text of the given part
9818 * @param obj The layout object
9819 * @param part The TEXT part where to set the text
9820 * @param text The text to set
9823 * @deprecated use elm_object_part_text_set() instead.
9825 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9827 * Get the text set in the given part
9829 * @param obj The layout object
9830 * @param part The TEXT part to retrieve the text off
9832 * @return The text set in @p part
9835 * @deprecated use elm_object_part_text_get() instead.
9837 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9839 * Append child to layout box part.
9841 * @param obj the layout object
9842 * @param part the box part to which the object will be appended.
9843 * @param child the child object to append to box.
9845 * Once the object is appended, it will become child of the layout. Its
9846 * lifetime will be bound to the layout, whenever the layout dies the child
9847 * will be deleted automatically. One should use elm_layout_box_remove() to
9848 * make this layout forget about the object.
9850 * @see elm_layout_box_prepend()
9851 * @see elm_layout_box_insert_before()
9852 * @see elm_layout_box_insert_at()
9853 * @see elm_layout_box_remove()
9857 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9859 * Prepend child to layout box part.
9861 * @param obj the layout object
9862 * @param part the box part to prepend.
9863 * @param child the child object to prepend to box.
9865 * Once the object is prepended, it will become child of the layout. Its
9866 * lifetime will be bound to the layout, whenever the layout dies the child
9867 * will be deleted automatically. One should use elm_layout_box_remove() to
9868 * make this layout forget about the object.
9870 * @see elm_layout_box_append()
9871 * @see elm_layout_box_insert_before()
9872 * @see elm_layout_box_insert_at()
9873 * @see elm_layout_box_remove()
9877 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9879 * Insert child to layout box part before a reference object.
9881 * @param obj the layout object
9882 * @param part the box part to insert.
9883 * @param child the child object to insert into box.
9884 * @param reference another reference object to insert before in box.
9886 * Once the object is inserted, it will become child of the layout. Its
9887 * lifetime will be bound to the layout, whenever the layout dies the child
9888 * will be deleted automatically. One should use elm_layout_box_remove() to
9889 * make this layout forget about the object.
9891 * @see elm_layout_box_append()
9892 * @see elm_layout_box_prepend()
9893 * @see elm_layout_box_insert_before()
9894 * @see elm_layout_box_remove()
9898 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9900 * Insert child to layout box part at a given position.
9902 * @param obj the layout object
9903 * @param part the box part to insert.
9904 * @param child the child object to insert into box.
9905 * @param pos the numeric position >=0 to insert the child.
9907 * Once the object is inserted, it will become child of the layout. Its
9908 * lifetime will be bound to the layout, whenever the layout dies the child
9909 * will be deleted automatically. One should use elm_layout_box_remove() to
9910 * make this layout forget about the object.
9912 * @see elm_layout_box_append()
9913 * @see elm_layout_box_prepend()
9914 * @see elm_layout_box_insert_before()
9915 * @see elm_layout_box_remove()
9919 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9921 * Remove a child of the given part box.
9923 * @param obj The layout object
9924 * @param part The box part name to remove child.
9925 * @param child The object to remove from box.
9926 * @return The object that was being used, or NULL if not found.
9928 * The object will be removed from the box part and its lifetime will
9929 * not be handled by the layout anymore. This is equivalent to
9930 * elm_object_part_content_unset() for box.
9932 * @see elm_layout_box_append()
9933 * @see elm_layout_box_remove_all()
9937 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9939 * Remove all child of the given part box.
9941 * @param obj The layout object
9942 * @param part The box part name to remove child.
9943 * @param clear If EINA_TRUE, then all objects will be deleted as
9944 * well, otherwise they will just be removed and will be
9945 * dangling on the canvas.
9947 * The objects will be removed from the box part and their lifetime will
9948 * not be handled by the layout anymore. This is equivalent to
9949 * elm_layout_box_remove() for all box children.
9951 * @see elm_layout_box_append()
9952 * @see elm_layout_box_remove()
9956 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9958 * Insert child to layout table part.
9960 * @param obj the layout object
9961 * @param part the box part to pack child.
9962 * @param child_obj the child object to pack into table.
9963 * @param col the column to which the child should be added. (>= 0)
9964 * @param row the row to which the child should be added. (>= 0)
9965 * @param colspan how many columns should be used to store this object. (>=
9967 * @param rowspan how many rows should be used to store this object. (>= 1)
9969 * Once the object is inserted, it will become child of the table. Its
9970 * lifetime will be bound to the layout, and whenever the layout dies the
9971 * child will be deleted automatically. One should use
9972 * elm_layout_table_remove() to make this layout forget about the object.
9974 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9975 * more space than a single cell. For instance, the following code:
9977 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9980 * Would result in an object being added like the following picture:
9982 * @image html layout_colspan.png
9983 * @image latex layout_colspan.eps width=\textwidth
9985 * @see elm_layout_table_unpack()
9986 * @see elm_layout_table_clear()
9990 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);
9992 * Unpack (remove) a child of the given part table.
9994 * @param obj The layout object
9995 * @param part The table part name to remove child.
9996 * @param child_obj The object to remove from table.
9997 * @return The object that was being used, or NULL if not found.
9999 * The object will be unpacked from the table part and its lifetime
10000 * will not be handled by the layout anymore. This is equivalent to
10001 * elm_object_part_content_unset() for table.
10003 * @see elm_layout_table_pack()
10004 * @see elm_layout_table_clear()
10008 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10010 * Remove all child of the given part table.
10012 * @param obj The layout object
10013 * @param part The table part name to remove child.
10014 * @param clear If EINA_TRUE, then all objects will be deleted as
10015 * well, otherwise they will just be removed and will be
10016 * dangling on the canvas.
10018 * The objects will be removed from the table part and their lifetime will
10019 * not be handled by the layout anymore. This is equivalent to
10020 * elm_layout_table_unpack() for all table children.
10022 * @see elm_layout_table_pack()
10023 * @see elm_layout_table_unpack()
10027 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10029 * Get the edje layout
10031 * @param obj The layout object
10033 * @return A Evas_Object with the edje layout settings loaded
10034 * with function elm_layout_file_set
10036 * This returns the edje object. It is not expected to be used to then
10037 * swallow objects via edje_object_part_swallow() for example. Use
10038 * elm_object_part_content_set() instead so child object handling and sizing is
10041 * @note This function should only be used if you really need to call some
10042 * low level Edje function on this edje object. All the common stuff (setting
10043 * text, emitting signals, hooking callbacks to signals, etc.) can be done
10044 * with proper elementary functions.
10046 * @see elm_object_signal_callback_add()
10047 * @see elm_object_signal_emit()
10048 * @see elm_object_part_text_set()
10049 * @see elm_object_part_content_set()
10050 * @see elm_layout_box_append()
10051 * @see elm_layout_table_pack()
10052 * @see elm_layout_data_get()
10056 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10058 * Get the edje data from the given layout
10060 * @param obj The layout object
10061 * @param key The data key
10063 * @return The edje data string
10065 * This function fetches data specified inside the edje theme of this layout.
10066 * This function return NULL if data is not found.
10068 * In EDC this comes from a data block within the group block that @p
10069 * obj was loaded from. E.g.
10076 * item: "key1" "value1";
10077 * item: "key2" "value2";
10085 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10089 * @param obj The layout object
10091 * Manually forces a sizing re-evaluation. This is useful when the minimum
10092 * size required by the edje theme of this layout has changed. The change on
10093 * the minimum size required by the edje theme is not immediately reported to
10094 * the elementary layout, so one needs to call this function in order to tell
10095 * the widget (layout) that it needs to reevaluate its own size.
10097 * The minimum size of the theme is calculated based on minimum size of
10098 * parts, the size of elements inside containers like box and table, etc. All
10099 * of this can change due to state changes, and that's when this function
10100 * should be called.
10102 * Also note that a standard signal of "size,eval" "elm" emitted from the
10103 * edje object will cause this to happen too.
10107 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10110 * Sets a specific cursor for an edje part.
10112 * @param obj The layout object.
10113 * @param part_name a part from loaded edje group.
10114 * @param cursor cursor name to use, see Elementary_Cursor.h
10116 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10117 * part not exists or it has "mouse_events: 0".
10121 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10124 * Get the cursor to be shown when mouse is over an edje part
10126 * @param obj The layout object.
10127 * @param part_name a part from loaded edje group.
10128 * @return the cursor name.
10132 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10135 * Unsets a cursor previously set with elm_layout_part_cursor_set().
10137 * @param obj The layout object.
10138 * @param part_name a part from loaded edje group, that had a cursor set
10139 * with elm_layout_part_cursor_set().
10143 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10146 * Sets a specific cursor style for an edje part.
10148 * @param obj The layout object.
10149 * @param part_name a part from loaded edje group.
10150 * @param style the theme style to use (default, transparent, ...)
10152 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10153 * part not exists or it did not had a cursor set.
10157 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10160 * Gets a specific cursor style for an edje part.
10162 * @param obj The layout object.
10163 * @param part_name a part from loaded edje group.
10165 * @return the theme style in use, defaults to "default". If the
10166 * object does not have a cursor set, then NULL is returned.
10170 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10173 * Sets if the cursor set should be searched on the theme or should use
10174 * the provided by the engine, only.
10176 * @note before you set if should look on theme you should define a
10177 * cursor with elm_layout_part_cursor_set(). By default it will only
10178 * look for cursors provided by the engine.
10180 * @param obj The layout object.
10181 * @param part_name a part from loaded edje group.
10182 * @param engine_only if cursors should be just provided by the engine
10183 * or should also search on widget's theme as well
10185 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10186 * part not exists or it did not had a cursor set.
10190 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);
10193 * Gets a specific cursor engine_only for an edje part.
10195 * @param obj The layout object.
10196 * @param part_name a part from loaded edje group.
10198 * @return whenever the cursor is just provided by engine or also from theme.
10202 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10205 * @def elm_layout_icon_set
10206 * Convienience macro to set the icon object in a layout that follows the
10207 * Elementary naming convention for its parts.
10211 #define elm_layout_icon_set(_ly, _obj) \
10214 elm_object_content_part_set((_ly), "elm.swallow.icon", (_obj)); \
10215 if ((_obj)) sig = "elm,state,icon,visible"; \
10216 else sig = "elm,state,icon,hidden"; \
10217 elm_object_signal_emit((_ly), sig, "elm"); \
10221 * @def elm_layout_icon_get
10222 * Convienience macro to get the icon object from a layout that follows the
10223 * Elementary naming convention for its parts.
10227 #define elm_layout_icon_get(_ly) \
10228 elm_object_content_part_get((_ly), "elm.swallow.icon")
10231 * @def elm_layout_end_set
10232 * Convienience macro to set the end object in a layout that follows the
10233 * Elementary naming convention for its parts.
10237 #define elm_layout_end_set(_ly, _obj) \
10240 elm_object_content_part_set((_ly), "elm.swallow.end", (_obj)); \
10241 if ((_obj)) sig = "elm,state,end,visible"; \
10242 else sig = "elm,state,end,hidden"; \
10243 elm_object_signal_emit((_ly), sig, "elm"); \
10247 * @def elm_layout_end_get
10248 * Convienience macro to get the end object in a layout that follows the
10249 * Elementary naming convention for its parts.
10253 #define elm_layout_end_get(_ly) \
10254 elm_object_content_part_get((_ly), "elm.swallow.end")
10257 * @def elm_layout_label_set
10258 * Convienience macro to set the label in a layout that follows the
10259 * Elementary naming convention for its parts.
10262 * @deprecated use elm_object_text_set() instead.
10264 #define elm_layout_label_set(_ly, _txt) \
10265 elm_layout_text_set((_ly), "elm.text", (_txt))
10268 * @def elm_layout_label_get
10269 * Convenience macro to get the label in a layout that follows the
10270 * Elementary naming convention for its parts.
10273 * @deprecated use elm_object_text_set() instead.
10275 #define elm_layout_label_get(_ly) \
10276 elm_layout_text_get((_ly), "elm.text")
10278 /* smart callbacks called:
10279 * "theme,changed" - when elm theme is changed.
10283 * @defgroup Notify Notify
10285 * @image html img/widget/notify/preview-00.png
10286 * @image latex img/widget/notify/preview-00.eps
10288 * Display a container in a particular region of the parent(top, bottom,
10289 * etc). A timeout can be set to automatically hide the notify. This is so
10290 * that, after an evas_object_show() on a notify object, if a timeout was set
10291 * on it, it will @b automatically get hidden after that time.
10293 * Signals that you can add callbacks for are:
10294 * @li "timeout" - when timeout happens on notify and it's hidden
10295 * @li "block,clicked" - when a click outside of the notify happens
10297 * Default contents parts of the notify widget that you can use for are:
10298 * @li "elm.swallow.content" - A content of the notify
10300 * @ref tutorial_notify show usage of the API.
10305 * @brief Possible orient values for notify.
10307 * This values should be used in conjunction to elm_notify_orient_set() to
10308 * set the position in which the notify should appear(relative to its parent)
10309 * and in conjunction with elm_notify_orient_get() to know where the notify
10312 typedef enum _Elm_Notify_Orient
10314 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10315 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10316 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10317 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10318 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10319 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10320 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10321 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10322 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10323 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10324 } Elm_Notify_Orient;
10326 * @brief Add a new notify to the parent
10328 * @param parent The parent object
10329 * @return The new object or NULL if it cannot be created
10331 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10333 * @brief Set the content of the notify widget
10335 * @param obj The notify object
10336 * @param content The content will be filled in this notify object
10338 * Once the content object is set, a previously set one will be deleted. If
10339 * you want to keep that old content object, use the
10340 * elm_notify_content_unset() function.
10342 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10344 * @brief Unset the content of the notify widget
10346 * @param obj The notify object
10347 * @return The content that was being used
10349 * Unparent and return the content object which was set for this widget
10351 * @see elm_notify_content_set()
10353 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10355 * @brief Return the content of the notify widget
10357 * @param obj The notify object
10358 * @return The content that is being used
10360 * @see elm_notify_content_set()
10362 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10364 * @brief Set the notify parent
10366 * @param obj The notify object
10367 * @param content The new parent
10369 * Once the parent object is set, a previously set one will be disconnected
10372 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10374 * @brief Get the notify parent
10376 * @param obj The notify object
10377 * @return The parent
10379 * @see elm_notify_parent_set()
10381 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10383 * @brief Set the orientation
10385 * @param obj The notify object
10386 * @param orient The new orientation
10388 * Sets the position in which the notify will appear in its parent.
10390 * @see @ref Elm_Notify_Orient for possible values.
10392 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10394 * @brief Return the orientation
10395 * @param obj The notify object
10396 * @return The orientation of the notification
10398 * @see elm_notify_orient_set()
10399 * @see Elm_Notify_Orient
10401 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10403 * @brief Set the time interval after which the notify window is going to be
10406 * @param obj The notify object
10407 * @param time The timeout in seconds
10409 * This function sets a timeout and starts the timer controlling when the
10410 * notify is hidden. Since calling evas_object_show() on a notify restarts
10411 * the timer controlling when the notify is hidden, setting this before the
10412 * notify is shown will in effect mean starting the timer when the notify is
10415 * @note Set a value <= 0.0 to disable a running timer.
10417 * @note If the value > 0.0 and the notify is previously visible, the
10418 * timer will be started with this value, canceling any running timer.
10420 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10422 * @brief Return the timeout value (in seconds)
10423 * @param obj the notify object
10425 * @see elm_notify_timeout_set()
10427 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10429 * @brief Sets whether events should be passed to by a click outside
10432 * @param obj The notify object
10433 * @param repeats EINA_TRUE Events are repeats, else no
10435 * When true if the user clicks outside the window the events will be caught
10436 * by the others widgets, else the events are blocked.
10438 * @note The default value is EINA_TRUE.
10440 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10442 * @brief Return true if events are repeat below the notify object
10443 * @param obj the notify object
10445 * @see elm_notify_repeat_events_set()
10447 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10453 * @defgroup Hover Hover
10455 * @image html img/widget/hover/preview-00.png
10456 * @image latex img/widget/hover/preview-00.eps
10458 * A Hover object will hover over its @p parent object at the @p target
10459 * location. Anything in the background will be given a darker coloring to
10460 * indicate that the hover object is on top (at the default theme). When the
10461 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10462 * clicked that @b doesn't cause the hover to be dismissed.
10464 * A Hover object has two parents. One parent that owns it during creation
10465 * and the other parent being the one over which the hover object spans.
10468 * @note The hover object will take up the entire space of @p target
10471 * Elementary has the following styles for the hover widget:
10475 * @li hoversel_vertical
10477 * The following are the available position for content:
10489 * Signals that you can add callbacks for are:
10490 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10491 * @li "smart,changed" - a content object placed under the "smart"
10492 * policy was replaced to a new slot direction.
10494 * See @ref tutorial_hover for more information.
10498 typedef enum _Elm_Hover_Axis
10500 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10501 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10502 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10503 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10506 * @brief Adds a hover object to @p parent
10508 * @param parent The parent object
10509 * @return The hover object or NULL if one could not be created
10511 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10513 * @brief Sets the target object for the hover.
10515 * @param obj The hover object
10516 * @param target The object to center the hover onto. The hover
10518 * This function will cause the hover to be centered on the target object.
10520 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10522 * @brief Gets the target object for the hover.
10524 * @param obj The hover object
10525 * @param parent The object to locate the hover over.
10527 * @see elm_hover_target_set()
10529 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10531 * @brief Sets the parent object for the hover.
10533 * @param obj The hover object
10534 * @param parent The object to locate the hover over.
10536 * This function will cause the hover to take up the entire space that the
10537 * parent object fills.
10539 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10541 * @brief Gets the parent object for the hover.
10543 * @param obj The hover object
10544 * @return The parent object to locate the hover over.
10546 * @see elm_hover_parent_set()
10548 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10550 * @brief Sets the content of the hover object and the direction in which it
10553 * @param obj The hover object
10554 * @param swallow The direction that the object will be displayed
10555 * at. Accepted values are "left", "top-left", "top", "top-right",
10556 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10558 * @param content The content to place at @p swallow
10560 * Once the content object is set for a given direction, a previously
10561 * set one (on the same direction) will be deleted. If you want to
10562 * keep that old content object, use the elm_hover_content_unset()
10565 * All directions may have contents at the same time, except for
10566 * "smart". This is a special placement hint and its use case
10567 * independs of the calculations coming from
10568 * elm_hover_best_content_location_get(). Its use is for cases when
10569 * one desires only one hover content, but with a dinamic special
10570 * placement within the hover area. The content's geometry, whenever
10571 * it changes, will be used to decide on a best location not
10572 * extrapolating the hover's parent object view to show it in (still
10573 * being the hover's target determinant of its medium part -- move and
10574 * resize it to simulate finger sizes, for example). If one of the
10575 * directions other than "smart" are used, a previously content set
10576 * using it will be deleted, and vice-versa.
10578 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10580 * @brief Get the content of the hover object, in a given direction.
10582 * Return the content object which was set for this widget in the
10583 * @p swallow direction.
10585 * @param obj The hover object
10586 * @param swallow The direction that the object was display at.
10587 * @return The content that was being used
10589 * @see elm_hover_content_set()
10591 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10593 * @brief Unset the content of the hover object, in a given direction.
10595 * Unparent and return the content object set at @p swallow direction.
10597 * @param obj The hover object
10598 * @param swallow The direction that the object was display at.
10599 * @return The content that was being used.
10601 * @see elm_hover_content_set()
10603 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10605 * @brief Returns the best swallow location for content in the hover.
10607 * @param obj The hover object
10608 * @param pref_axis The preferred orientation axis for the hover object to use
10609 * @return The edje location to place content into the hover or @c
10612 * Best is defined here as the location at which there is the most available
10615 * @p pref_axis may be one of
10616 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10617 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10618 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10619 * - @c ELM_HOVER_AXIS_BOTH -- both
10621 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10622 * nescessarily be along the horizontal axis("left" or "right"). If
10623 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10624 * be along the vertical axis("top" or "bottom"). Chossing
10625 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10626 * returned position may be in either axis.
10628 * @see elm_hover_content_set()
10630 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10637 * @defgroup Entry Entry
10639 * @image html img/widget/entry/preview-00.png
10640 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10641 * @image html img/widget/entry/preview-01.png
10642 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10643 * @image html img/widget/entry/preview-02.png
10644 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10645 * @image html img/widget/entry/preview-03.png
10646 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10648 * An entry is a convenience widget which shows a box that the user can
10649 * enter text into. Entries by default don't scroll, so they grow to
10650 * accomodate the entire text, resizing the parent window as needed. This
10651 * can be changed with the elm_entry_scrollable_set() function.
10653 * They can also be single line or multi line (the default) and when set
10654 * to multi line mode they support text wrapping in any of the modes
10655 * indicated by #Elm_Wrap_Type.
10657 * Other features include password mode, filtering of inserted text with
10658 * elm_entry_text_filter_append() and related functions, inline "items" and
10659 * formatted markup text.
10661 * @section entry-markup Formatted text
10663 * The markup tags supported by the Entry are defined by the theme, but
10664 * even when writing new themes or extensions it's a good idea to stick to
10665 * a sane default, to maintain coherency and avoid application breakages.
10666 * Currently defined by the default theme are the following tags:
10667 * @li \<br\>: Inserts a line break.
10668 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10670 * @li \<tab\>: Inserts a tab.
10671 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10673 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10674 * @li \<link\>...\</link\>: Underlines the enclosed text.
10675 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10677 * @section entry-special Special markups
10679 * Besides those used to format text, entries support two special markup
10680 * tags used to insert clickable portions of text or items inlined within
10683 * @subsection entry-anchors Anchors
10685 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10686 * \</a\> tags and an event will be generated when this text is clicked,
10690 * This text is outside <a href=anc-01>but this one is an anchor</a>
10693 * The @c href attribute in the opening tag gives the name that will be
10694 * used to identify the anchor and it can be any valid utf8 string.
10696 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10697 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10698 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10699 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10702 * @subsection entry-items Items
10704 * Inlined in the text, any other @c Evas_Object can be inserted by using
10705 * \<item\> tags this way:
10708 * <item size=16x16 vsize=full href=emoticon/haha></item>
10711 * Just like with anchors, the @c href identifies each item, but these need,
10712 * in addition, to indicate their size, which is done using any one of
10713 * @c size, @c absize or @c relsize attributes. These attributes take their
10714 * value in the WxH format, where W is the width and H the height of the
10717 * @li absize: Absolute pixel size for the item. Whatever value is set will
10718 * be the item's size regardless of any scale value the object may have
10719 * been set to. The final line height will be adjusted to fit larger items.
10720 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10722 * @li relsize: Size is adjusted for the item to fit within the current
10725 * Besides their size, items are specificed a @c vsize value that affects
10726 * how their final size and position are calculated. The possible values
10728 * @li ascent: Item will be placed within the line's baseline and its
10729 * ascent. That is, the height between the line where all characters are
10730 * positioned and the highest point in the line. For @c size and @c absize
10731 * items, the descent value will be added to the total line height to make
10732 * them fit. @c relsize items will be adjusted to fit within this space.
10733 * @li full: Items will be placed between the descent and ascent, or the
10734 * lowest point in the line and its highest.
10736 * The next image shows different configurations of items and how they
10737 * are the previously mentioned options affect their sizes. In all cases,
10738 * the green line indicates the ascent, blue for the baseline and red for
10741 * @image html entry_item.png
10742 * @image latex entry_item.eps width=\textwidth
10744 * And another one to show how size differs from absize. In the first one,
10745 * the scale value is set to 1.0, while the second one is using one of 2.0.
10747 * @image html entry_item_scale.png
10748 * @image latex entry_item_scale.eps width=\textwidth
10750 * After the size for an item is calculated, the entry will request an
10751 * object to place in its space. For this, the functions set with
10752 * elm_entry_item_provider_append() and related functions will be called
10753 * in order until one of them returns a @c non-NULL value. If no providers
10754 * are available, or all of them return @c NULL, then the entry falls back
10755 * to one of the internal defaults, provided the name matches with one of
10758 * All of the following are currently supported:
10761 * - emoticon/angry-shout
10762 * - emoticon/crazy-laugh
10763 * - emoticon/evil-laugh
10765 * - emoticon/goggle-smile
10766 * - emoticon/grumpy
10767 * - emoticon/grumpy-smile
10768 * - emoticon/guilty
10769 * - emoticon/guilty-smile
10771 * - emoticon/half-smile
10772 * - emoticon/happy-panting
10774 * - emoticon/indifferent
10776 * - emoticon/knowing-grin
10778 * - emoticon/little-bit-sorry
10779 * - emoticon/love-lots
10781 * - emoticon/minimal-smile
10782 * - emoticon/not-happy
10783 * - emoticon/not-impressed
10785 * - emoticon/opensmile
10788 * - emoticon/squint-laugh
10789 * - emoticon/surprised
10790 * - emoticon/suspicious
10791 * - emoticon/tongue-dangling
10792 * - emoticon/tongue-poke
10794 * - emoticon/unhappy
10795 * - emoticon/very-sorry
10798 * - emoticon/worried
10801 * Alternatively, an item may reference an image by its path, using
10802 * the URI form @c file:///path/to/an/image.png and the entry will then
10803 * use that image for the item.
10805 * @section entry-files Loading and saving files
10807 * Entries have convinience functions to load text from a file and save
10808 * changes back to it after a short delay. The automatic saving is enabled
10809 * by default, but can be disabled with elm_entry_autosave_set() and files
10810 * can be loaded directly as plain text or have any markup in them
10811 * recognized. See elm_entry_file_set() for more details.
10813 * @section entry-signals Emitted signals
10815 * This widget emits the following signals:
10817 * @li "changed": The text within the entry was changed.
10818 * @li "changed,user": The text within the entry was changed because of user interaction.
10819 * @li "activated": The enter key was pressed on a single line entry.
10820 * @li "press": A mouse button has been pressed on the entry.
10821 * @li "longpressed": A mouse button has been pressed and held for a couple
10823 * @li "clicked": The entry has been clicked (mouse press and release).
10824 * @li "clicked,double": The entry has been double clicked.
10825 * @li "clicked,triple": The entry has been triple clicked.
10826 * @li "focused": The entry has received focus.
10827 * @li "unfocused": The entry has lost focus.
10828 * @li "selection,paste": A paste of the clipboard contents was requested.
10829 * @li "selection,copy": A copy of the selected text into the clipboard was
10831 * @li "selection,cut": A cut of the selected text into the clipboard was
10833 * @li "selection,start": A selection has begun and no previous selection
10835 * @li "selection,changed": The current selection has changed.
10836 * @li "selection,cleared": The current selection has been cleared.
10837 * @li "cursor,changed": The cursor has changed position.
10838 * @li "anchor,clicked": An anchor has been clicked. The event_info
10839 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10840 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10841 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10842 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10843 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10844 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10845 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10846 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10847 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10848 * @li "preedit,changed": The preedit string has changed.
10849 * @li "language,changed": Program language changed.
10851 * @section entry-examples
10853 * An overview of the Entry API can be seen in @ref entry_example_01
10858 * @typedef Elm_Entry_Anchor_Info
10860 * The info sent in the callback for the "anchor,clicked" signals emitted
10863 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10865 * @struct _Elm_Entry_Anchor_Info
10867 * The info sent in the callback for the "anchor,clicked" signals emitted
10870 struct _Elm_Entry_Anchor_Info
10872 const char *name; /**< The name of the anchor, as stated in its href */
10873 int button; /**< The mouse button used to click on it */
10874 Evas_Coord x, /**< Anchor geometry, relative to canvas */
10875 y, /**< Anchor geometry, relative to canvas */
10876 w, /**< Anchor geometry, relative to canvas */
10877 h; /**< Anchor geometry, relative to canvas */
10880 * @typedef Elm_Entry_Filter_Cb
10881 * This callback type is used by entry filters to modify text.
10882 * @param data The data specified as the last param when adding the filter
10883 * @param entry The entry object
10884 * @param text A pointer to the location of the text being filtered. This data can be modified,
10885 * but any additional allocations must be managed by the user.
10886 * @see elm_entry_text_filter_append
10887 * @see elm_entry_text_filter_prepend
10889 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10892 * This adds an entry to @p parent object.
10894 * By default, entries are:
10898 * @li autosave is enabled
10900 * @param parent The parent object
10901 * @return The new object or NULL if it cannot be created
10903 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10905 * Sets the entry to single line mode.
10907 * In single line mode, entries don't ever wrap when the text reaches the
10908 * edge, and instead they keep growing horizontally. Pressing the @c Enter
10909 * key will generate an @c "activate" event instead of adding a new line.
10911 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10912 * and pressing enter will break the text into a different line
10913 * without generating any events.
10915 * @param obj The entry object
10916 * @param single_line If true, the text in the entry
10917 * will be on a single line.
10919 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10921 * Gets whether the entry is set to be single line.
10923 * @param obj The entry object
10924 * @return single_line If true, the text in the entry is set to display
10925 * on a single line.
10927 * @see elm_entry_single_line_set()
10929 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10931 * Sets the entry to password mode.
10933 * In password mode, entries are implicitly single line and the display of
10934 * any text in them is replaced with asterisks (*).
10936 * @param obj The entry object
10937 * @param password If true, password mode is enabled.
10939 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10941 * Gets whether the entry is set to password mode.
10943 * @param obj The entry object
10944 * @return If true, the entry is set to display all characters
10945 * as asterisks (*).
10947 * @see elm_entry_password_set()
10949 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10951 * This sets the text displayed within the entry to @p entry.
10953 * @param obj The entry object
10954 * @param entry The text to be displayed
10956 * @deprecated Use elm_object_text_set() instead.
10957 * @note Using this function bypasses text filters
10959 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10961 * This returns the text currently shown in object @p entry.
10962 * See also elm_entry_entry_set().
10964 * @param obj The entry object
10965 * @return The currently displayed text or NULL on failure
10967 * @deprecated Use elm_object_text_get() instead.
10969 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10971 * Appends @p entry to the text of the entry.
10973 * Adds the text in @p entry to the end of any text already present in the
10976 * The appended text is subject to any filters set for the widget.
10978 * @param obj The entry object
10979 * @param entry The text to be displayed
10981 * @see elm_entry_text_filter_append()
10983 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10985 * Gets whether the entry is empty.
10987 * Empty means no text at all. If there are any markup tags, like an item
10988 * tag for which no provider finds anything, and no text is displayed, this
10989 * function still returns EINA_FALSE.
10991 * @param obj The entry object
10992 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10994 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10996 * Gets any selected text within the entry.
10998 * If there's any selected text in the entry, this function returns it as
10999 * a string in markup format. NULL is returned if no selection exists or
11000 * if an error occurred.
11002 * The returned value points to an internal string and should not be freed
11003 * or modified in any way. If the @p entry object is deleted or its
11004 * contents are changed, the returned pointer should be considered invalid.
11006 * @param obj The entry object
11007 * @return The selected text within the entry or NULL on failure
11009 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11011 * Inserts the given text into the entry at the current cursor position.
11013 * This inserts text at the cursor position as if it was typed
11014 * by the user (note that this also allows markup which a user
11015 * can't just "type" as it would be converted to escaped text, so this
11016 * call can be used to insert things like emoticon items or bold push/pop
11017 * tags, other font and color change tags etc.)
11019 * If any selection exists, it will be replaced by the inserted text.
11021 * The inserted text is subject to any filters set for the widget.
11023 * @param obj The entry object
11024 * @param entry The text to insert
11026 * @see elm_entry_text_filter_append()
11028 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11030 * Set the line wrap type to use on multi-line entries.
11032 * Sets the wrap type used by the entry to any of the specified in
11033 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11034 * line (without inserting a line break or paragraph separator) when it
11035 * reaches the far edge of the widget.
11037 * Note that this only makes sense for multi-line entries. A widget set
11038 * to be single line will never wrap.
11040 * @param obj The entry object
11041 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11043 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11044 EINA_DEPRECATED EAPI void elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
11046 * Gets the wrap mode the entry was set to use.
11048 * @param obj The entry object
11049 * @return Wrap type
11051 * @see also elm_entry_line_wrap_set()
11053 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11055 * Sets if the entry is to be editable or not.
11057 * By default, entries are editable and when focused, any text input by the
11058 * user will be inserted at the current cursor position. But calling this
11059 * function with @p editable as EINA_FALSE will prevent the user from
11060 * inputting text into the entry.
11062 * The only way to change the text of a non-editable entry is to use
11063 * elm_object_text_set(), elm_entry_entry_insert() and other related
11066 * @param obj The entry object
11067 * @param editable If EINA_TRUE, user input will be inserted in the entry,
11068 * if not, the entry is read-only and no user input is allowed.
11070 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11072 * Gets whether the entry is editable or not.
11074 * @param obj The entry object
11075 * @return If true, the entry is editable by the user.
11076 * If false, it is not editable by the user
11078 * @see elm_entry_editable_set()
11080 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11082 * This drops any existing text selection within the entry.
11084 * @param obj The entry object
11086 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11088 * This selects all text within the entry.
11090 * @param obj The entry object
11092 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11094 * This moves the cursor one place to the right within the entry.
11096 * @param obj The entry object
11097 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11099 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11101 * This moves the cursor one place to the left within the entry.
11103 * @param obj The entry object
11104 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11106 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11108 * This moves the cursor one line up within the entry.
11110 * @param obj The entry object
11111 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11113 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11115 * This moves the cursor one line down within the entry.
11117 * @param obj The entry object
11118 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11120 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11122 * This moves the cursor to the beginning of the entry.
11124 * @param obj The entry object
11126 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11128 * This moves the cursor to the end of the entry.
11130 * @param obj The entry object
11132 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11134 * This moves the cursor to the beginning of the current line.
11136 * @param obj The entry object
11138 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11140 * This moves the cursor to the end of the current line.
11142 * @param obj The entry object
11144 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11146 * This begins a selection within the entry as though
11147 * the user were holding down the mouse button to make a selection.
11149 * @param obj The entry object
11151 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11153 * This ends a selection within the entry as though
11154 * the user had just released the mouse button while making a selection.
11156 * @param obj The entry object
11158 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11160 * Gets whether a format node exists at the current cursor position.
11162 * A format node is anything that defines how the text is rendered. It can
11163 * be a visible format node, such as a line break or a paragraph separator,
11164 * or an invisible one, such as bold begin or end tag.
11165 * This function returns whether any format node exists at the current
11168 * @param obj The entry object
11169 * @return EINA_TRUE if the current cursor position contains a format node,
11170 * EINA_FALSE otherwise.
11172 * @see elm_entry_cursor_is_visible_format_get()
11174 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11176 * Gets if the current cursor position holds a visible format node.
11178 * @param obj The entry object
11179 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11180 * if it's an invisible one or no format exists.
11182 * @see elm_entry_cursor_is_format_get()
11184 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11186 * Gets the character pointed by the cursor at its current position.
11188 * This function returns a string with the utf8 character stored at the
11189 * current cursor position.
11190 * Only the text is returned, any format that may exist will not be part
11191 * of the return value.
11193 * @param obj The entry object
11194 * @return The text pointed by the cursors.
11196 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11198 * This function returns the geometry of the cursor.
11200 * It's useful if you want to draw something on the cursor (or where it is),
11201 * or for example in the case of scrolled entry where you want to show the
11204 * @param obj The entry object
11205 * @param x returned geometry
11206 * @param y returned geometry
11207 * @param w returned geometry
11208 * @param h returned geometry
11209 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11211 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);
11213 * Sets the cursor position in the entry to the given value
11215 * The value in @p pos is the index of the character position within the
11216 * contents of the string as returned by elm_entry_cursor_pos_get().
11218 * @param obj The entry object
11219 * @param pos The position of the cursor
11221 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11223 * Retrieves the current position of the cursor in the entry
11225 * @param obj The entry object
11226 * @return The cursor position
11228 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11230 * This executes a "cut" action on the selected text in the entry.
11232 * @param obj The entry object
11234 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11236 * This executes a "copy" action on the selected text in the entry.
11238 * @param obj The entry object
11240 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11242 * This executes a "paste" action in the entry.
11244 * @param obj The entry object
11246 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11248 * This clears and frees the items in a entry's contextual (longpress)
11251 * @param obj The entry object
11253 * @see elm_entry_context_menu_item_add()
11255 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11257 * This adds an item to the entry's contextual menu.
11259 * A longpress on an entry will make the contextual menu show up, if this
11260 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11261 * By default, this menu provides a few options like enabling selection mode,
11262 * which is useful on embedded devices that need to be explicit about it,
11263 * and when a selection exists it also shows the copy and cut actions.
11265 * With this function, developers can add other options to this menu to
11266 * perform any action they deem necessary.
11268 * @param obj The entry object
11269 * @param label The item's text label
11270 * @param icon_file The item's icon file
11271 * @param icon_type The item's icon type
11272 * @param func The callback to execute when the item is clicked
11273 * @param data The data to associate with the item for related functions
11275 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);
11277 * This disables the entry's contextual (longpress) menu.
11279 * @param obj The entry object
11280 * @param disabled If true, the menu is disabled
11282 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11284 * This returns whether the entry's contextual (longpress) menu is
11287 * @param obj The entry object
11288 * @return If true, the menu is disabled
11290 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11292 * This appends a custom item provider to the list for that entry
11294 * This appends the given callback. The list is walked from beginning to end
11295 * with each function called given the item href string in the text. If the
11296 * function returns an object handle other than NULL (it should create an
11297 * object to do this), then this object is used to replace that item. If
11298 * not the next provider is called until one provides an item object, or the
11299 * default provider in entry does.
11301 * @param obj The entry object
11302 * @param func The function called to provide the item object
11303 * @param data The data passed to @p func
11305 * @see @ref entry-items
11307 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);
11309 * This prepends a custom item provider to the list for that entry
11311 * This prepends the given callback. See elm_entry_item_provider_append() for
11314 * @param obj The entry object
11315 * @param func The function called to provide the item object
11316 * @param data The data passed to @p func
11318 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);
11320 * This removes a custom item provider to the list for that entry
11322 * This removes the given callback. See elm_entry_item_provider_append() for
11325 * @param obj The entry object
11326 * @param func The function called to provide the item object
11327 * @param data The data passed to @p func
11329 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);
11331 * Append a filter function for text inserted in the entry
11333 * Append the given callback to the list. This functions will be called
11334 * whenever any text is inserted into the entry, with the text to be inserted
11335 * as a parameter. The callback function is free to alter the text in any way
11336 * it wants, but it must remember to free the given pointer and update it.
11337 * If the new text is to be discarded, the function can free it and set its
11338 * text parameter to NULL. This will also prevent any following filters from
11341 * @param obj The entry object
11342 * @param func The function to use as text filter
11343 * @param data User data to pass to @p func
11345 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11347 * Prepend a filter function for text insdrted in the entry
11349 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11350 * for more information
11352 * @param obj The entry object
11353 * @param func The function to use as text filter
11354 * @param data User data to pass to @p func
11356 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11358 * Remove a filter from the list
11360 * Removes the given callback from the filter list. See
11361 * elm_entry_text_filter_append() for more information.
11363 * @param obj The entry object
11364 * @param func The filter function to remove
11365 * @param data The user data passed when adding the function
11367 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11369 * This converts a markup (HTML-like) string into UTF-8.
11371 * The returned string is a malloc'ed buffer and it should be freed when
11372 * not needed anymore.
11374 * @param s The string (in markup) to be converted
11375 * @return The converted string (in UTF-8). It should be freed.
11377 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11379 * This converts a UTF-8 string into markup (HTML-like).
11381 * The returned string is a malloc'ed buffer and it should be freed when
11382 * not needed anymore.
11384 * @param s The string (in UTF-8) to be converted
11385 * @return The converted string (in markup). It should be freed.
11387 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11389 * This sets the file (and implicitly loads it) for the text to display and
11390 * then edit. All changes are written back to the file after a short delay if
11391 * the entry object is set to autosave (which is the default).
11393 * If the entry had any other file set previously, any changes made to it
11394 * will be saved if the autosave feature is enabled, otherwise, the file
11395 * will be silently discarded and any non-saved changes will be lost.
11397 * @param obj The entry object
11398 * @param file The path to the file to load and save
11399 * @param format The file format
11401 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11403 * Gets the file being edited by the entry.
11405 * This function can be used to retrieve any file set on the entry for
11406 * edition, along with the format used to load and save it.
11408 * @param obj The entry object
11409 * @param file The path to the file to load and save
11410 * @param format The file format
11412 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11414 * This function writes any changes made to the file set with
11415 * elm_entry_file_set()
11417 * @param obj The entry object
11419 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11421 * This sets the entry object to 'autosave' the loaded text file or not.
11423 * @param obj The entry object
11424 * @param autosave Autosave the loaded file or not
11426 * @see elm_entry_file_set()
11428 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11430 * This gets the entry object's 'autosave' status.
11432 * @param obj The entry object
11433 * @return Autosave the loaded file or not
11435 * @see elm_entry_file_set()
11437 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11439 * Control pasting of text and images for the widget.
11441 * Normally the entry allows both text and images to be pasted. By setting
11442 * textonly to be true, this prevents images from being pasted.
11444 * Note this only changes the behaviour of text.
11446 * @param obj The entry object
11447 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11448 * text+image+other.
11450 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11452 * Getting elm_entry text paste/drop mode.
11454 * In textonly mode, only text may be pasted or dropped into the widget.
11456 * @param obj The entry object
11457 * @return If the widget only accepts text from pastes.
11459 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11461 * Enable or disable scrolling in entry
11463 * Normally the entry is not scrollable unless you enable it with this call.
11465 * @param obj The entry object
11466 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11468 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11470 * Get the scrollable state of the entry
11472 * Normally the entry is not scrollable. This gets the scrollable state
11473 * of the entry. See elm_entry_scrollable_set() for more information.
11475 * @param obj The entry object
11476 * @return The scrollable state
11478 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11480 * This sets a widget to be displayed to the left of a scrolled entry.
11482 * @param obj The scrolled entry object
11483 * @param icon The widget to display on the left side of the scrolled
11486 * @note A previously set widget will be destroyed.
11487 * @note If the object being set does not have minimum size hints set,
11488 * it won't get properly displayed.
11490 * @see elm_entry_end_set()
11492 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11494 * Gets the leftmost widget of the scrolled entry. This object is
11495 * owned by the scrolled entry and should not be modified.
11497 * @param obj The scrolled entry object
11498 * @return the left widget inside the scroller
11500 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11502 * Unset the leftmost widget of the scrolled entry, unparenting and
11505 * @param obj The scrolled entry object
11506 * @return the previously set icon sub-object of this entry, on
11509 * @see elm_entry_icon_set()
11511 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11513 * Sets the visibility of the left-side widget of the scrolled entry,
11514 * set by elm_entry_icon_set().
11516 * @param obj The scrolled entry object
11517 * @param setting EINA_TRUE if the object should be displayed,
11518 * EINA_FALSE if not.
11520 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11522 * This sets a widget to be displayed to the end of a scrolled entry.
11524 * @param obj The scrolled entry object
11525 * @param end The widget to display on the right side of the scrolled
11528 * @note A previously set widget will be destroyed.
11529 * @note If the object being set does not have minimum size hints set,
11530 * it won't get properly displayed.
11532 * @see elm_entry_icon_set
11534 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11536 * Gets the endmost widget of the scrolled entry. This object is owned
11537 * by the scrolled entry and should not be modified.
11539 * @param obj The scrolled entry object
11540 * @return the right widget inside the scroller
11542 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11544 * Unset the endmost widget of the scrolled entry, unparenting and
11547 * @param obj The scrolled entry object
11548 * @return the previously set icon sub-object of this entry, on
11551 * @see elm_entry_icon_set()
11553 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11555 * Sets the visibility of the end widget of the scrolled entry, set by
11556 * elm_entry_end_set().
11558 * @param obj The scrolled entry object
11559 * @param setting EINA_TRUE if the object should be displayed,
11560 * EINA_FALSE if not.
11562 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11564 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11567 * Setting an entry to single-line mode with elm_entry_single_line_set()
11568 * will automatically disable the display of scrollbars when the entry
11569 * moves inside its scroller.
11571 * @param obj The scrolled entry object
11572 * @param h The horizontal scrollbar policy to apply
11573 * @param v The vertical scrollbar policy to apply
11575 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11577 * This enables/disables bouncing within the entry.
11579 * This function sets whether the entry will bounce when scrolling reaches
11580 * the end of the contained entry.
11582 * @param obj The scrolled entry object
11583 * @param h The horizontal bounce state
11584 * @param v The vertical bounce state
11586 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11588 * Get the bounce mode
11590 * @param obj The Entry object
11591 * @param h_bounce Allow bounce horizontally
11592 * @param v_bounce Allow bounce vertically
11594 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11596 /* pre-made filters for entries */
11598 * @typedef Elm_Entry_Filter_Limit_Size
11600 * Data for the elm_entry_filter_limit_size() entry filter.
11602 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11604 * @struct _Elm_Entry_Filter_Limit_Size
11606 * Data for the elm_entry_filter_limit_size() entry filter.
11608 struct _Elm_Entry_Filter_Limit_Size
11610 int max_char_count; /**< The maximum number of characters allowed. */
11611 int max_byte_count; /**< The maximum number of bytes allowed*/
11614 * Filter inserted text based on user defined character and byte limits
11616 * Add this filter to an entry to limit the characters that it will accept
11617 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11618 * The funtion works on the UTF-8 representation of the string, converting
11619 * it from the set markup, thus not accounting for any format in it.
11621 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11622 * it as data when setting the filter. In it, it's possible to set limits
11623 * by character count or bytes (any of them is disabled if 0), and both can
11624 * be set at the same time. In that case, it first checks for characters,
11627 * The function will cut the inserted text in order to allow only the first
11628 * number of characters that are still allowed. The cut is made in
11629 * characters, even when limiting by bytes, in order to always contain
11630 * valid ones and avoid half unicode characters making it in.
11632 * This filter, like any others, does not apply when setting the entry text
11633 * directly with elm_object_text_set() (or the deprecated
11634 * elm_entry_entry_set()).
11636 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11638 * @typedef Elm_Entry_Filter_Accept_Set
11640 * Data for the elm_entry_filter_accept_set() entry filter.
11642 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11644 * @struct _Elm_Entry_Filter_Accept_Set
11646 * Data for the elm_entry_filter_accept_set() entry filter.
11648 struct _Elm_Entry_Filter_Accept_Set
11650 const char *accepted; /**< Set of characters accepted in the entry. */
11651 const char *rejected; /**< Set of characters rejected from the entry. */
11654 * Filter inserted text based on accepted or rejected sets of characters
11656 * Add this filter to an entry to restrict the set of accepted characters
11657 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11658 * This structure contains both accepted and rejected sets, but they are
11659 * mutually exclusive.
11661 * The @c accepted set takes preference, so if it is set, the filter will
11662 * only work based on the accepted characters, ignoring anything in the
11663 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11665 * In both cases, the function filters by matching utf8 characters to the
11666 * raw markup text, so it can be used to remove formatting tags.
11668 * This filter, like any others, does not apply when setting the entry text
11669 * directly with elm_object_text_set() (or the deprecated
11670 * elm_entry_entry_set()).
11672 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11674 * Set the input panel layout of the entry
11676 * @param obj The entry object
11677 * @param layout layout type
11679 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11681 * Get the input panel layout of the entry
11683 * @param obj The entry object
11684 * @return layout type
11686 * @see elm_entry_input_panel_layout_set
11688 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11690 * Set the autocapitalization type on the immodule.
11692 * @param obj The entry object
11693 * @param autocapital_type The type of autocapitalization
11695 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
11697 * Retrieve the autocapitalization type on the immodule.
11699 * @param obj The entry object
11700 * @return autocapitalization type
11702 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11704 * Sets the attribute to show the input panel automatically.
11706 * @param obj The entry object
11707 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
11709 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
11711 * Retrieve the attribute to show the input panel automatically.
11713 * @param obj The entry object
11714 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
11716 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11718 EAPI void elm_entry_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11719 EAPI void elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
11720 EAPI void elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
11721 EAPI void elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
11722 EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
11723 EAPI void elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
11724 EAPI void elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
11726 EINA_DEPRECATED EAPI void elm_entry_wrap_width_set(Evas_Object *obj, Evas_Coord w);
11727 EINA_DEPRECATED EAPI Evas_Coord elm_entry_wrap_width_get(const Evas_Object *obj);
11728 EINA_DEPRECATED EAPI void elm_entry_fontsize_set(Evas_Object *obj, int fontsize);
11729 EINA_DEPRECATED EAPI void elm_entry_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11730 EINA_DEPRECATED EAPI void elm_entry_text_align_set(Evas_Object *obj, const char *alignmode);
11736 /* composite widgets - these basically put together basic widgets above
11737 * in convenient packages that do more than basic stuff */
11741 * @defgroup Anchorview Anchorview
11743 * @image html img/widget/anchorview/preview-00.png
11744 * @image latex img/widget/anchorview/preview-00.eps
11746 * Anchorview is for displaying text that contains markup with anchors
11747 * like <c>\<a href=1234\>something\</\></c> in it.
11749 * Besides being styled differently, the anchorview widget provides the
11750 * necessary functionality so that clicking on these anchors brings up a
11751 * popup with user defined content such as "call", "add to contacts" or
11752 * "open web page". This popup is provided using the @ref Hover widget.
11754 * This widget is very similar to @ref Anchorblock, so refer to that
11755 * widget for an example. The only difference Anchorview has is that the
11756 * widget is already provided with scrolling functionality, so if the
11757 * text set to it is too large to fit in the given space, it will scroll,
11758 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11759 * text can be displayed.
11761 * This widget emits the following signals:
11762 * @li "anchor,clicked": will be called when an anchor is clicked. The
11763 * @p event_info parameter on the callback will be a pointer of type
11764 * ::Elm_Entry_Anchorview_Info.
11766 * See @ref Anchorblock for an example on how to use both of them.
11775 * @typedef Elm_Entry_Anchorview_Info
11777 * The info sent in the callback for "anchor,clicked" signals emitted by
11778 * the Anchorview widget.
11780 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11782 * @struct _Elm_Entry_Anchorview_Info
11784 * The info sent in the callback for "anchor,clicked" signals emitted by
11785 * the Anchorview widget.
11787 struct _Elm_Entry_Anchorview_Info
11789 const char *name; /**< Name of the anchor, as indicated in its href
11791 int button; /**< The mouse button used to click on it */
11792 Evas_Object *hover; /**< The hover object to use for the popup */
11794 Evas_Coord x, y, w, h;
11795 } anchor, /**< Geometry selection of text used as anchor */
11796 hover_parent; /**< Geometry of the object used as parent by the
11798 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11799 for content on the left side of
11800 the hover. Before calling the
11801 callback, the widget will make the
11802 necessary calculations to check
11803 which sides are fit to be set with
11804 content, based on the position the
11805 hover is activated and its distance
11806 to the edges of its parent object
11808 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11809 the right side of the hover.
11810 See @ref hover_left */
11811 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11812 of the hover. See @ref hover_left */
11813 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11814 below the hover. See @ref
11818 * Add a new Anchorview object
11820 * @param parent The parent object
11821 * @return The new object or NULL if it cannot be created
11823 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11825 * Set the text to show in the anchorview
11827 * Sets the text of the anchorview to @p text. This text can include markup
11828 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11829 * text that will be specially styled and react to click events, ended with
11830 * either of \</a\> or \</\>. When clicked, the anchor will emit an
11831 * "anchor,clicked" signal that you can attach a callback to with
11832 * evas_object_smart_callback_add(). The name of the anchor given in the
11833 * event info struct will be the one set in the href attribute, in this
11834 * case, anchorname.
11836 * Other markup can be used to style the text in different ways, but it's
11837 * up to the style defined in the theme which tags do what.
11838 * @deprecated use elm_object_text_set() instead.
11840 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11842 * Get the markup text set for the anchorview
11844 * Retrieves the text set on the anchorview, with markup tags included.
11846 * @param obj The anchorview object
11847 * @return The markup text set or @c NULL if nothing was set or an error
11849 * @deprecated use elm_object_text_set() instead.
11851 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11853 * Set the parent of the hover popup
11855 * Sets the parent object to use by the hover created by the anchorview
11856 * when an anchor is clicked. See @ref Hover for more details on this.
11857 * If no parent is set, the same anchorview object will be used.
11859 * @param obj The anchorview object
11860 * @param parent The object to use as parent for the hover
11862 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11864 * Get the parent of the hover popup
11866 * Get the object used as parent for the hover created by the anchorview
11867 * widget. See @ref Hover for more details on this.
11869 * @param obj The anchorview object
11870 * @return The object used as parent for the hover, NULL if none is set.
11872 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11874 * Set the style that the hover should use
11876 * When creating the popup hover, anchorview will request that it's
11877 * themed according to @p style.
11879 * @param obj The anchorview object
11880 * @param style The style to use for the underlying hover
11882 * @see elm_object_style_set()
11884 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11886 * Get the style that the hover should use
11888 * Get the style the hover created by anchorview will use.
11890 * @param obj The anchorview object
11891 * @return The style to use by the hover. NULL means the default is used.
11893 * @see elm_object_style_set()
11895 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11897 * Ends the hover popup in the anchorview
11899 * When an anchor is clicked, the anchorview widget will create a hover
11900 * object to use as a popup with user provided content. This function
11901 * terminates this popup, returning the anchorview to its normal state.
11903 * @param obj The anchorview object
11905 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11907 * Set bouncing behaviour when the scrolled content reaches an edge
11909 * Tell the internal scroller object whether it should bounce or not
11910 * when it reaches the respective edges for each axis.
11912 * @param obj The anchorview object
11913 * @param h_bounce Whether to bounce or not in the horizontal axis
11914 * @param v_bounce Whether to bounce or not in the vertical axis
11916 * @see elm_scroller_bounce_set()
11918 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11920 * Get the set bouncing behaviour of the internal scroller
11922 * Get whether the internal scroller should bounce when the edge of each
11923 * axis is reached scrolling.
11925 * @param obj The anchorview object
11926 * @param h_bounce Pointer where to store the bounce state of the horizontal
11928 * @param v_bounce Pointer where to store the bounce state of the vertical
11931 * @see elm_scroller_bounce_get()
11933 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11935 * Appends a custom item provider to the given anchorview
11937 * Appends the given function to the list of items providers. This list is
11938 * called, one function at a time, with the given @p data pointer, the
11939 * anchorview object and, in the @p item parameter, the item name as
11940 * referenced in its href string. Following functions in the list will be
11941 * called in order until one of them returns something different to NULL,
11942 * which should be an Evas_Object which will be used in place of the item
11945 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11946 * href=item/name\>\</item\>
11948 * @param obj The anchorview object
11949 * @param func The function to add to the list of providers
11950 * @param data User data that will be passed to the callback function
11952 * @see elm_entry_item_provider_append()
11954 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);
11956 * Prepend a custom item provider to the given anchorview
11958 * Like elm_anchorview_item_provider_append(), but it adds the function
11959 * @p func to the beginning of the list, instead of the end.
11961 * @param obj The anchorview object
11962 * @param func The function to add to the list of providers
11963 * @param data User data that will be passed to the callback function
11965 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);
11967 * Remove a custom item provider from the list of the given anchorview
11969 * Removes the function and data pairing that matches @p func and @p data.
11970 * That is, unless the same function and same user data are given, the
11971 * function will not be removed from the list. This allows us to add the
11972 * same callback several times, with different @p data pointers and be
11973 * able to remove them later without conflicts.
11975 * @param obj The anchorview object
11976 * @param func The function to remove from the list
11977 * @param data The data matching the function to remove from the list
11979 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);
11986 * @defgroup Anchorblock Anchorblock
11988 * @image html img/widget/anchorblock/preview-00.png
11989 * @image latex img/widget/anchorblock/preview-00.eps
11991 * Anchorblock is for displaying text that contains markup with anchors
11992 * like <c>\<a href=1234\>something\</\></c> in it.
11994 * Besides being styled differently, the anchorblock widget provides the
11995 * necessary functionality so that clicking on these anchors brings up a
11996 * popup with user defined content such as "call", "add to contacts" or
11997 * "open web page". This popup is provided using the @ref Hover widget.
11999 * This widget emits the following signals:
12000 * @li "anchor,clicked": will be called when an anchor is clicked. The
12001 * @p event_info parameter on the callback will be a pointer of type
12002 * ::Elm_Entry_Anchorblock_Info.
12008 * Since examples are usually better than plain words, we might as well
12009 * try @ref tutorial_anchorblock_example "one".
12012 * @addtogroup Anchorblock
12016 * @typedef Elm_Entry_Anchorblock_Info
12018 * The info sent in the callback for "anchor,clicked" signals emitted by
12019 * the Anchorblock widget.
12021 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12023 * @struct _Elm_Entry_Anchorblock_Info
12025 * The info sent in the callback for "anchor,clicked" signals emitted by
12026 * the Anchorblock widget.
12028 struct _Elm_Entry_Anchorblock_Info
12030 const char *name; /**< Name of the anchor, as indicated in its href
12032 int button; /**< The mouse button used to click on it */
12033 Evas_Object *hover; /**< The hover object to use for the popup */
12035 Evas_Coord x, y, w, h;
12036 } anchor, /**< Geometry selection of text used as anchor */
12037 hover_parent; /**< Geometry of the object used as parent by the
12039 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12040 for content on the left side of
12041 the hover. Before calling the
12042 callback, the widget will make the
12043 necessary calculations to check
12044 which sides are fit to be set with
12045 content, based on the position the
12046 hover is activated and its distance
12047 to the edges of its parent object
12049 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12050 the right side of the hover.
12051 See @ref hover_left */
12052 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12053 of the hover. See @ref hover_left */
12054 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12055 below the hover. See @ref
12059 * Add a new Anchorblock object
12061 * @param parent The parent object
12062 * @return The new object or NULL if it cannot be created
12064 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12066 * Set the text to show in the anchorblock
12068 * Sets the text of the anchorblock to @p text. This text can include markup
12069 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12070 * of text that will be specially styled and react to click events, ended
12071 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12072 * "anchor,clicked" signal that you can attach a callback to with
12073 * evas_object_smart_callback_add(). The name of the anchor given in the
12074 * event info struct will be the one set in the href attribute, in this
12075 * case, anchorname.
12077 * Other markup can be used to style the text in different ways, but it's
12078 * up to the style defined in the theme which tags do what.
12079 * @deprecated use elm_object_text_set() instead.
12081 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12083 * Get the markup text set for the anchorblock
12085 * Retrieves the text set on the anchorblock, with markup tags included.
12087 * @param obj The anchorblock object
12088 * @return The markup text set or @c NULL if nothing was set or an error
12090 * @deprecated use elm_object_text_set() instead.
12092 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12094 * Set the parent of the hover popup
12096 * Sets the parent object to use by the hover created by the anchorblock
12097 * when an anchor is clicked. See @ref Hover for more details on this.
12099 * @param obj The anchorblock object
12100 * @param parent The object to use as parent for the hover
12102 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12104 * Get the parent of the hover popup
12106 * Get the object used as parent for the hover created by the anchorblock
12107 * widget. See @ref Hover for more details on this.
12108 * If no parent is set, the same anchorblock object will be used.
12110 * @param obj The anchorblock object
12111 * @return The object used as parent for the hover, NULL if none is set.
12113 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12115 * Set the style that the hover should use
12117 * When creating the popup hover, anchorblock will request that it's
12118 * themed according to @p style.
12120 * @param obj The anchorblock object
12121 * @param style The style to use for the underlying hover
12123 * @see elm_object_style_set()
12125 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12127 * Get the style that the hover should use
12129 * Get the style, the hover created by anchorblock will use.
12131 * @param obj The anchorblock object
12132 * @return The style to use by the hover. NULL means the default is used.
12134 * @see elm_object_style_set()
12136 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12138 * Ends the hover popup in the anchorblock
12140 * When an anchor is clicked, the anchorblock widget will create a hover
12141 * object to use as a popup with user provided content. This function
12142 * terminates this popup, returning the anchorblock to its normal state.
12144 * @param obj The anchorblock object
12146 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12148 * Appends a custom item provider to the given anchorblock
12150 * Appends the given function to the list of items providers. This list is
12151 * called, one function at a time, with the given @p data pointer, the
12152 * anchorblock object and, in the @p item parameter, the item name as
12153 * referenced in its href string. Following functions in the list will be
12154 * called in order until one of them returns something different to NULL,
12155 * which should be an Evas_Object which will be used in place of the item
12158 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12159 * href=item/name\>\</item\>
12161 * @param obj The anchorblock object
12162 * @param func The function to add to the list of providers
12163 * @param data User data that will be passed to the callback function
12165 * @see elm_entry_item_provider_append()
12167 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);
12169 * Prepend a custom item provider to the given anchorblock
12171 * Like elm_anchorblock_item_provider_append(), but it adds the function
12172 * @p func to the beginning of the list, instead of the end.
12174 * @param obj The anchorblock object
12175 * @param func The function to add to the list of providers
12176 * @param data User data that will be passed to the callback function
12178 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);
12180 * Remove a custom item provider from the list of the given anchorblock
12182 * Removes the function and data pairing that matches @p func and @p data.
12183 * That is, unless the same function and same user data are given, the
12184 * function will not be removed from the list. This allows us to add the
12185 * same callback several times, with different @p data pointers and be
12186 * able to remove them later without conflicts.
12188 * @param obj The anchorblock object
12189 * @param func The function to remove from the list
12190 * @param data The data matching the function to remove from the list
12192 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);
12198 * @defgroup Bubble Bubble
12200 * @image html img/widget/bubble/preview-00.png
12201 * @image latex img/widget/bubble/preview-00.eps
12202 * @image html img/widget/bubble/preview-01.png
12203 * @image latex img/widget/bubble/preview-01.eps
12204 * @image html img/widget/bubble/preview-02.png
12205 * @image latex img/widget/bubble/preview-02.eps
12207 * @brief The Bubble is a widget to show text similar to how speech is
12208 * represented in comics.
12210 * The bubble widget contains 5 important visual elements:
12211 * @li The frame is a rectangle with rounded edjes and an "arrow".
12212 * @li The @p icon is an image to which the frame's arrow points to.
12213 * @li The @p label is a text which appears to the right of the icon if the
12214 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12216 * @li The @p info is a text which appears to the right of the label. Info's
12217 * font is of a ligther color than label.
12218 * @li The @p content is an evas object that is shown inside the frame.
12220 * The position of the arrow, icon, label and info depends on which corner is
12221 * selected. The four available corners are:
12222 * @li "top_left" - Default
12224 * @li "bottom_left"
12225 * @li "bottom_right"
12227 * Signals that you can add callbacks for are:
12228 * @li "clicked" - This is called when a user has clicked the bubble.
12230 * For an example of using a buble see @ref bubble_01_example_page "this".
12235 #define ELM_BUBBLE_CONTENT_ICON "elm.swallow.icon"
12238 * Add a new bubble to the parent
12240 * @param parent The parent object
12241 * @return The new object or NULL if it cannot be created
12243 * This function adds a text bubble to the given parent evas object.
12245 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12247 * Set the label of the bubble
12249 * @param obj The bubble object
12250 * @param label The string to set in the label
12252 * This function sets the title of the bubble. Where this appears depends on
12253 * the selected corner.
12254 * @deprecated use elm_object_text_set() instead.
12256 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12258 * Get the label of the bubble
12260 * @param obj The bubble object
12261 * @return The string of set in the label
12263 * This function gets the title of the bubble.
12264 * @deprecated use elm_object_text_get() instead.
12266 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12268 * Set the info of the bubble
12270 * @param obj The bubble object
12271 * @param info The given info about the bubble
12273 * This function sets the info of the bubble. Where this appears depends on
12274 * the selected corner.
12275 * @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
12277 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12279 * Get the info of the bubble
12281 * @param obj The bubble object
12283 * @return The "info" string of the bubble
12285 * This function gets the info text.
12286 * @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
12288 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12290 * Set the content to be shown in the bubble
12292 * Once the content object is set, a previously set one will be deleted.
12293 * If you want to keep the old content object, use the
12294 * elm_bubble_content_unset() function.
12296 * @param obj The bubble object
12297 * @param content The given content of the bubble
12299 * This function sets the content shown on the middle of the bubble.
12301 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12303 * Get the content shown in the bubble
12305 * Return the content object which is set for this widget.
12307 * @param obj The bubble object
12308 * @return The content that is being used
12310 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12312 * Unset the content shown in the bubble
12314 * Unparent and return the content object which was set for this widget.
12316 * @param obj The bubble object
12317 * @return The content that was being used
12319 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12321 * Set the icon of the bubble
12323 * Once the icon object is set, a previously set one will be deleted.
12324 * If you want to keep the old content object, use the
12325 * elm_icon_content_unset() function.
12327 * @param obj The bubble object
12328 * @param icon The given icon for the bubble
12330 * @deprecated use elm_object_part_content_set() instead
12333 EINA_DEPRECATED EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12335 * Get the icon of the bubble
12337 * @param obj The bubble object
12338 * @return The icon for the bubble
12340 * This function gets the icon shown on the top left of bubble.
12342 * @deprecated use elm_object_part_content_get() instead
12345 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12347 * Unset the icon of the bubble
12349 * Unparent and return the icon object which was set for this widget.
12351 * @param obj The bubble object
12352 * @return The icon that was being used
12354 * @deprecated use elm_object_part_content_unset() instead
12357 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12359 * Set the corner of the bubble
12361 * @param obj The bubble object.
12362 * @param corner The given corner for the bubble.
12364 * This function sets the corner of the bubble. The corner will be used to
12365 * determine where the arrow in the frame points to and where label, icon and
12368 * Possible values for corner are:
12369 * @li "top_left" - Default
12371 * @li "bottom_left"
12372 * @li "bottom_right"
12374 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12376 * Get the corner of the bubble
12378 * @param obj The bubble object.
12379 * @return The given corner for the bubble.
12381 * This function gets the selected corner of the bubble.
12383 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12385 EINA_DEPRECATED EAPI void elm_bubble_sweep_layout_set(Evas_Object *obj, Evas_Object *sweep) EINA_ARG_NONNULL(1);
12386 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_sweep_layout_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12393 * @defgroup Photo Photo
12395 * For displaying the photo of a person (contact). Simple, yet
12396 * with a very specific purpose.
12398 * Signals that you can add callbacks for are:
12400 * "clicked" - This is called when a user has clicked the photo
12401 * "drag,start" - Someone started dragging the image out of the object
12402 * "drag,end" - Dragged item was dropped (somewhere)
12408 * Add a new photo to the parent
12410 * @param parent The parent object
12411 * @return The new object or NULL if it cannot be created
12415 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12418 * Set the file that will be used as photo
12420 * @param obj The photo object
12421 * @param file The path to file that will be used as photo
12423 * @return (1 = success, 0 = error)
12427 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12430 * Set the file that will be used as thumbnail in the photo.
12432 * @param obj The photo object.
12433 * @param file The path to file that will be used as thumb.
12434 * @param group The key used in case of an EET file.
12438 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12441 * Set the size that will be used on the photo
12443 * @param obj The photo object
12444 * @param size The size that the photo will be
12448 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12451 * Set if the photo should be completely visible or not.
12453 * @param obj The photo object
12454 * @param fill if true the photo will be completely visible
12458 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12461 * Set editability of the photo.
12463 * An editable photo can be dragged to or from, and can be cut or
12464 * pasted too. Note that pasting an image or dropping an item on
12465 * the image will delete the existing content.
12467 * @param obj The photo object.
12468 * @param set To set of clear editablity.
12470 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12476 /* gesture layer */
12478 * @defgroup Elm_Gesture_Layer Gesture Layer
12479 * Gesture Layer Usage:
12481 * Use Gesture Layer to detect gestures.
12482 * The advantage is that you don't have to implement
12483 * gesture detection, just set callbacks of gesture state.
12484 * By using gesture layer we make standard interface.
12486 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12487 * with a parent object parameter.
12488 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12489 * call. Usually with same object as target (2nd parameter).
12491 * Now you need to tell gesture layer what gestures you follow.
12492 * This is done with @ref elm_gesture_layer_cb_set call.
12493 * By setting the callback you actually saying to gesture layer:
12494 * I would like to know when the gesture @ref Elm_Gesture_Types
12495 * switches to state @ref Elm_Gesture_State.
12497 * Next, you need to implement the actual action that follows the input
12498 * in your callback.
12500 * Note that if you like to stop being reported about a gesture, just set
12501 * all callbacks referring this gesture to NULL.
12502 * (again with @ref elm_gesture_layer_cb_set)
12504 * The information reported by gesture layer to your callback is depending
12505 * on @ref Elm_Gesture_Types:
12506 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12507 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12508 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12510 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12511 * @ref ELM_GESTURE_MOMENTUM.
12513 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12514 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12515 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12516 * Note that we consider a flick as a line-gesture that should be completed
12517 * in flick-time-limit as defined in @ref Config.
12519 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12521 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12524 * Gesture Layer Tweaks:
12526 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12527 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12529 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12530 * so gesture starts when user touches (a *DOWN event) touch-surface
12531 * and ends when no fingers touches surface (a *UP event).
12535 * @enum _Elm_Gesture_Types
12536 * Enum of supported gesture types.
12537 * @ingroup Elm_Gesture_Layer
12539 enum _Elm_Gesture_Types
12541 ELM_GESTURE_FIRST = 0,
12543 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12544 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12545 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12546 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12548 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12550 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12551 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12553 ELM_GESTURE_ZOOM, /**< Zoom */
12554 ELM_GESTURE_ROTATE, /**< Rotate */
12560 * @typedef Elm_Gesture_Types
12561 * gesture types enum
12562 * @ingroup Elm_Gesture_Layer
12564 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12567 * @enum _Elm_Gesture_State
12568 * Enum of gesture states.
12569 * @ingroup Elm_Gesture_Layer
12571 enum _Elm_Gesture_State
12573 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12574 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12575 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12576 ELM_GESTURE_STATE_END, /**< Gesture completed */
12577 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12581 * @typedef Elm_Gesture_State
12582 * gesture states enum
12583 * @ingroup Elm_Gesture_Layer
12585 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12588 * @struct _Elm_Gesture_Taps_Info
12589 * Struct holds taps info for user
12590 * @ingroup Elm_Gesture_Layer
12592 struct _Elm_Gesture_Taps_Info
12594 Evas_Coord x, y; /**< Holds center point between fingers */
12595 unsigned int n; /**< Number of fingers tapped */
12596 unsigned int timestamp; /**< event timestamp */
12600 * @typedef Elm_Gesture_Taps_Info
12601 * holds taps info for user
12602 * @ingroup Elm_Gesture_Layer
12604 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12607 * @struct _Elm_Gesture_Momentum_Info
12608 * Struct holds momentum info for user
12609 * x1 and y1 are not necessarily in sync
12610 * x1 holds x value of x direction starting point
12611 * and same holds for y1.
12612 * This is noticeable when doing V-shape movement
12613 * @ingroup Elm_Gesture_Layer
12615 struct _Elm_Gesture_Momentum_Info
12616 { /* Report line ends, timestamps, and momentum computed */
12617 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12618 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12619 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12620 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12622 unsigned int tx; /**< Timestamp of start of final x-swipe */
12623 unsigned int ty; /**< Timestamp of start of final y-swipe */
12625 Evas_Coord mx; /**< Momentum on X */
12626 Evas_Coord my; /**< Momentum on Y */
12628 unsigned int n; /**< Number of fingers */
12632 * @typedef Elm_Gesture_Momentum_Info
12633 * holds momentum info for user
12634 * @ingroup Elm_Gesture_Layer
12636 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12639 * @struct _Elm_Gesture_Line_Info
12640 * Struct holds line info for user
12641 * @ingroup Elm_Gesture_Layer
12643 struct _Elm_Gesture_Line_Info
12644 { /* Report line ends, timestamps, and momentum computed */
12645 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12646 double angle; /**< Angle (direction) of lines */
12650 * @typedef Elm_Gesture_Line_Info
12651 * Holds line info for user
12652 * @ingroup Elm_Gesture_Layer
12654 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12657 * @struct _Elm_Gesture_Zoom_Info
12658 * Struct holds zoom info for user
12659 * @ingroup Elm_Gesture_Layer
12661 struct _Elm_Gesture_Zoom_Info
12663 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12664 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12665 double zoom; /**< Zoom value: 1.0 means no zoom */
12666 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12670 * @typedef Elm_Gesture_Zoom_Info
12671 * Holds zoom info for user
12672 * @ingroup Elm_Gesture_Layer
12674 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12677 * @struct _Elm_Gesture_Rotate_Info
12678 * Struct holds rotation info for user
12679 * @ingroup Elm_Gesture_Layer
12681 struct _Elm_Gesture_Rotate_Info
12683 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12684 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12685 double base_angle; /**< Holds start-angle */
12686 double angle; /**< Rotation value: 0.0 means no rotation */
12687 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12691 * @typedef Elm_Gesture_Rotate_Info
12692 * Holds rotation info for user
12693 * @ingroup Elm_Gesture_Layer
12695 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12698 * @typedef Elm_Gesture_Event_Cb
12699 * User callback used to stream gesture info from gesture layer
12700 * @param data user data
12701 * @param event_info gesture report info
12702 * Returns a flag field to be applied on the causing event.
12703 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12704 * upon the event, in an irreversible way.
12706 * @ingroup Elm_Gesture_Layer
12708 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12711 * Use function to set callbacks to be notified about
12712 * change of state of gesture.
12713 * When a user registers a callback with this function
12714 * this means this gesture has to be tested.
12716 * When ALL callbacks for a gesture are set to NULL
12717 * it means user isn't interested in gesture-state
12718 * and it will not be tested.
12720 * @param obj Pointer to gesture-layer.
12721 * @param idx The gesture you would like to track its state.
12722 * @param cb callback function pointer.
12723 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12724 * @param data user info to be sent to callback (usually, Smart Data)
12726 * @ingroup Elm_Gesture_Layer
12728 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);
12731 * Call this function to get repeat-events settings.
12733 * @param obj Pointer to gesture-layer.
12735 * @return repeat events settings.
12736 * @see elm_gesture_layer_hold_events_set()
12737 * @ingroup Elm_Gesture_Layer
12739 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12742 * This function called in order to make gesture-layer repeat events.
12743 * Set this of you like to get the raw events only if gestures were not detected.
12744 * Clear this if you like gesture layer to fwd events as testing gestures.
12746 * @param obj Pointer to gesture-layer.
12747 * @param r Repeat: TRUE/FALSE
12749 * @ingroup Elm_Gesture_Layer
12751 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12754 * This function sets step-value for zoom action.
12755 * Set step to any positive value.
12756 * Cancel step setting by setting to 0.0
12758 * @param obj Pointer to gesture-layer.
12759 * @param s new zoom step value.
12761 * @ingroup Elm_Gesture_Layer
12763 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12766 * This function sets step-value for rotate action.
12767 * Set step to any positive value.
12768 * Cancel step setting by setting to 0.0
12770 * @param obj Pointer to gesture-layer.
12771 * @param s new roatate step value.
12773 * @ingroup Elm_Gesture_Layer
12775 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12778 * This function called to attach gesture-layer to an Evas_Object.
12779 * @param obj Pointer to gesture-layer.
12780 * @param t Pointer to underlying object (AKA Target)
12782 * @return TRUE, FALSE on success, failure.
12784 * @ingroup Elm_Gesture_Layer
12786 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12789 * Call this function to construct a new gesture-layer object.
12790 * This does not activate the gesture layer. You have to
12791 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12793 * @param parent the parent object.
12795 * @return Pointer to new gesture-layer object.
12797 * @ingroup Elm_Gesture_Layer
12799 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12802 * @defgroup Thumb Thumb
12804 * @image html img/widget/thumb/preview-00.png
12805 * @image latex img/widget/thumb/preview-00.eps
12807 * A thumb object is used for displaying the thumbnail of an image or video.
12808 * You must have compiled Elementary with Ethumb_Client support and the DBus
12809 * service must be present and auto-activated in order to have thumbnails to
12812 * Once the thumbnail object becomes visible, it will check if there is a
12813 * previously generated thumbnail image for the file set on it. If not, it
12814 * will start generating this thumbnail.
12816 * Different config settings will cause different thumbnails to be generated
12817 * even on the same file.
12819 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12820 * Ethumb documentation to change this path, and to see other configuration
12823 * Signals that you can add callbacks for are:
12825 * - "clicked" - This is called when a user has clicked the thumb without dragging
12827 * - "clicked,double" - This is called when a user has double-clicked the thumb.
12828 * - "press" - This is called when a user has pressed down the thumb.
12829 * - "generate,start" - The thumbnail generation started.
12830 * - "generate,stop" - The generation process stopped.
12831 * - "generate,error" - The generation failed.
12832 * - "load,error" - The thumbnail image loading failed.
12834 * available styles:
12838 * An example of use of thumbnail:
12840 * - @ref thumb_example_01
12844 * @addtogroup Thumb
12849 * @enum _Elm_Thumb_Animation_Setting
12850 * @typedef Elm_Thumb_Animation_Setting
12852 * Used to set if a video thumbnail is animating or not.
12856 typedef enum _Elm_Thumb_Animation_Setting
12858 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12859 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
12860 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
12861 ELM_THUMB_ANIMATION_LAST
12862 } Elm_Thumb_Animation_Setting;
12865 * Add a new thumb object to the parent.
12867 * @param parent The parent object.
12868 * @return The new object or NULL if it cannot be created.
12870 * @see elm_thumb_file_set()
12871 * @see elm_thumb_ethumb_client_get()
12875 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12877 * Reload thumbnail if it was generated before.
12879 * @param obj The thumb object to reload
12881 * This is useful if the ethumb client configuration changed, like its
12882 * size, aspect or any other property one set in the handle returned
12883 * by elm_thumb_ethumb_client_get().
12885 * If the options didn't change, the thumbnail won't be generated again, but
12886 * the old one will still be used.
12888 * @see elm_thumb_file_set()
12892 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12894 * Set the file that will be used as thumbnail.
12896 * @param obj The thumb object.
12897 * @param file The path to file that will be used as thumb.
12898 * @param key The key used in case of an EET file.
12900 * The file can be an image or a video (in that case, acceptable extensions are:
12901 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12902 * function elm_thumb_animate().
12904 * @see elm_thumb_file_get()
12905 * @see elm_thumb_reload()
12906 * @see elm_thumb_animate()
12910 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12912 * Get the image or video path and key used to generate the thumbnail.
12914 * @param obj The thumb object.
12915 * @param file Pointer to filename.
12916 * @param key Pointer to key.
12918 * @see elm_thumb_file_set()
12919 * @see elm_thumb_path_get()
12923 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12925 * Get the path and key to the image or video generated by ethumb.
12927 * One just need to make sure that the thumbnail was generated before getting
12928 * its path; otherwise, the path will be NULL. One way to do that is by asking
12929 * for the path when/after the "generate,stop" smart callback is called.
12931 * @param obj The thumb object.
12932 * @param file Pointer to thumb path.
12933 * @param key Pointer to thumb key.
12935 * @see elm_thumb_file_get()
12939 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12941 * Set the animation state for the thumb object. If its content is an animated
12942 * video, you may start/stop the animation or tell it to play continuously and
12945 * @param obj The thumb object.
12946 * @param setting The animation setting.
12948 * @see elm_thumb_file_set()
12952 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12954 * Get the animation state for the thumb object.
12956 * @param obj The thumb object.
12957 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12960 * @see elm_thumb_animate_set()
12964 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12966 * Get the ethumb_client handle so custom configuration can be made.
12968 * @return Ethumb_Client instance or NULL.
12970 * This must be called before the objects are created to be sure no object is
12971 * visible and no generation started.
12973 * Example of usage:
12976 * #include <Elementary.h>
12977 * #ifndef ELM_LIB_QUICKLAUNCH
12979 * elm_main(int argc, char **argv)
12981 * Ethumb_Client *client;
12983 * elm_need_ethumb();
12987 * client = elm_thumb_ethumb_client_get();
12990 * ERR("could not get ethumb_client");
12993 * ethumb_client_size_set(client, 100, 100);
12994 * ethumb_client_crop_align_set(client, 0.5, 0.5);
12997 * // Create elm_thumb objects here
13007 * @note There's only one client handle for Ethumb, so once a configuration
13008 * change is done to it, any other request for thumbnails (for any thumbnail
13009 * object) will use that configuration. Thus, this configuration is global.
13013 EAPI void *elm_thumb_ethumb_client_get(void);
13015 * Get the ethumb_client connection state.
13017 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13020 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
13022 * Make the thumbnail 'editable'.
13024 * @param obj Thumb object.
13025 * @param set Turn on or off editability. Default is @c EINA_FALSE.
13027 * This means the thumbnail is a valid drag target for drag and drop, and can be
13028 * cut or pasted too.
13030 * @see elm_thumb_editable_get()
13034 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13035 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13037 * Make the thumbnail 'editable'.
13039 * @param obj Thumb object.
13040 * @return Editability.
13042 * This means the thumbnail is a valid drag target for drag and drop, and can be
13043 * cut or pasted too.
13045 * @see elm_thumb_editable_set()
13049 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13056 * @defgroup Web Web
13058 * @image html img/widget/web/preview-00.png
13059 * @image latex img/widget/web/preview-00.eps
13061 * A web object is used for displaying web pages (HTML/CSS/JS)
13062 * using WebKit-EFL. You must have compiled Elementary with
13065 * Signals that you can add callbacks for are:
13066 * @li "download,request": A file download has been requested. Event info is
13067 * a pointer to a Elm_Web_Download
13068 * @li "editorclient,contents,changed": Editor client's contents changed
13069 * @li "editorclient,selection,changed": Editor client's selection changed
13070 * @li "frame,created": A new frame was created. Event info is an
13071 * Evas_Object which can be handled with WebKit's ewk_frame API
13072 * @li "icon,received": An icon was received by the main frame
13073 * @li "inputmethod,changed": Input method changed. Event info is an
13074 * Eina_Bool indicating whether it's enabled or not
13075 * @li "js,windowobject,clear": JS window object has been cleared
13076 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13077 * is a char *link[2], where the first string contains the URL the link
13078 * points to, and the second one the title of the link
13079 * @li "link,hover,out": Mouse cursor left the link
13080 * @li "load,document,finished": Loading of a document finished. Event info
13081 * is the frame that finished loading
13082 * @li "load,error": Load failed. Event info is a pointer to
13083 * Elm_Web_Frame_Load_Error
13084 * @li "load,finished": Load finished. Event info is NULL on success, on
13085 * error it's a pointer to Elm_Web_Frame_Load_Error
13086 * @li "load,newwindow,show": A new window was created and is ready to be
13088 * @li "load,progress": Overall load progress. Event info is a pointer to
13089 * a double containing a value between 0.0 and 1.0
13090 * @li "load,provisional": Started provisional load
13091 * @li "load,started": Loading of a document started
13092 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13093 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13094 * the menubar is visible, or EINA_FALSE in case it's not
13095 * @li "menubar,visible,set": Informs menubar visibility. Event info is
13096 * an Eina_Bool indicating the visibility
13097 * @li "popup,created": A dropdown widget was activated, requesting its
13098 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13099 * @li "popup,willdelete": The web object is ready to destroy the popup
13100 * object created. Event info is a pointer to Elm_Web_Menu
13101 * @li "ready": Page is fully loaded
13102 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13103 * info is a pointer to Eina_Bool where the visibility state should be set
13104 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13105 * is an Eina_Bool with the visibility state set
13106 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13107 * a string with the new text
13108 * @li "statusbar,visible,get": Queries visibility of the status bar.
13109 * Event info is a pointer to Eina_Bool where the visibility state should be
13111 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13112 * an Eina_Bool with the visibility value
13113 * @li "title,changed": Title of the main frame changed. Event info is a
13114 * string with the new title
13115 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13116 * is a pointer to Eina_Bool where the visibility state should be set
13117 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13118 * info is an Eina_Bool with the visibility state
13119 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13120 * a string with the text to show
13121 * @li "uri,changed": URI of the main frame changed. Event info is a string
13123 * @li "view,resized": The web object internal's view changed sized
13124 * @li "windows,close,request": A JavaScript request to close the current
13125 * window was requested
13126 * @li "zoom,animated,end": Animated zoom finished
13128 * available styles:
13131 * An example of use of web:
13133 * - @ref web_example_01 TBD
13142 * Structure used to report load errors.
13144 * Load errors are reported as signal by elm_web. All the strings are
13145 * temporary references and should @b not be used after the signal
13146 * callback returns. If it's required, make copies with strdup() or
13147 * eina_stringshare_add() (they are not even guaranteed to be
13148 * stringshared, so must use eina_stringshare_add() and not
13149 * eina_stringshare_ref()).
13151 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13153 * Structure used to report load errors.
13155 * Load errors are reported as signal by elm_web. All the strings are
13156 * temporary references and should @b not be used after the signal
13157 * callback returns. If it's required, make copies with strdup() or
13158 * eina_stringshare_add() (they are not even guaranteed to be
13159 * stringshared, so must use eina_stringshare_add() and not
13160 * eina_stringshare_ref()).
13162 struct _Elm_Web_Frame_Load_Error
13164 int code; /**< Numeric error code */
13165 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13166 const char *domain; /**< Error domain name */
13167 const char *description; /**< Error description (already localized) */
13168 const char *failing_url; /**< The URL that failed to load */
13169 Evas_Object *frame; /**< Frame object that produced the error */
13173 * The possibles types that the items in a menu can be
13175 typedef enum _Elm_Web_Menu_Item_Type
13177 ELM_WEB_MENU_SEPARATOR,
13178 ELM_WEB_MENU_GROUP,
13179 ELM_WEB_MENU_OPTION
13180 } Elm_Web_Menu_Item_Type;
13183 * Structure describing the items in a menu
13185 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13187 * Structure describing the items in a menu
13189 struct _Elm_Web_Menu_Item
13191 const char *text; /**< The text for the item */
13192 Elm_Web_Menu_Item_Type type; /**< The type of the item */
13196 * Structure describing the menu of a popup
13198 * This structure will be passed as the @c event_info for the "popup,create"
13199 * signal, which is emitted when a dropdown menu is opened. Users wanting
13200 * to handle these popups by themselves should listen to this signal and
13201 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13202 * property as @c EINA_FALSE means that the user will not handle the popup
13203 * and the default implementation will be used.
13205 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13206 * will be emitted to notify the user that it can destroy any objects and
13207 * free all data related to it.
13209 * @see elm_web_popup_selected_set()
13210 * @see elm_web_popup_destroy()
13212 typedef struct _Elm_Web_Menu Elm_Web_Menu;
13214 * Structure describing the menu of a popup
13216 * This structure will be passed as the @c event_info for the "popup,create"
13217 * signal, which is emitted when a dropdown menu is opened. Users wanting
13218 * to handle these popups by themselves should listen to this signal and
13219 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13220 * property as @c EINA_FALSE means that the user will not handle the popup
13221 * and the default implementation will be used.
13223 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13224 * will be emitted to notify the user that it can destroy any objects and
13225 * free all data related to it.
13227 * @see elm_web_popup_selected_set()
13228 * @see elm_web_popup_destroy()
13230 struct _Elm_Web_Menu
13232 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13233 int x; /**< The X position of the popup, relative to the elm_web object */
13234 int y; /**< The Y position of the popup, relative to the elm_web object */
13235 int width; /**< Width of the popup menu */
13236 int height; /**< Height of the popup menu */
13238 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. */
13241 typedef struct _Elm_Web_Download Elm_Web_Download;
13242 struct _Elm_Web_Download
13248 * Types of zoom available.
13250 typedef enum _Elm_Web_Zoom_Mode
13252 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13253 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13254 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13255 ELM_WEB_ZOOM_MODE_LAST
13256 } Elm_Web_Zoom_Mode;
13258 * Opaque handler containing the features (such as statusbar, menubar, etc)
13259 * that are to be set on a newly requested window.
13261 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13263 * Callback type for the create_window hook.
13265 * The function parameters are:
13266 * @li @p data User data pointer set when setting the hook function
13267 * @li @p obj The elm_web object requesting the new window
13268 * @li @p js Set to @c EINA_TRUE if the request was originated from
13269 * JavaScript. @c EINA_FALSE otherwise.
13270 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13271 * the features requested for the new window.
13273 * The returned value of the function should be the @c elm_web widget where
13274 * the request will be loaded. That is, if a new window or tab is created,
13275 * the elm_web widget in it should be returned, and @b NOT the window
13277 * Returning @c NULL should cancel the request.
13279 * @see elm_web_window_create_hook_set()
13281 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13283 * Callback type for the JS alert hook.
13285 * The function parameters are:
13286 * @li @p data User data pointer set when setting the hook function
13287 * @li @p obj The elm_web object requesting the new window
13288 * @li @p message The message to show in the alert dialog
13290 * The function should return the object representing the alert dialog.
13291 * Elm_Web will run a second main loop to handle the dialog and normal
13292 * flow of the application will be restored when the object is deleted, so
13293 * the user should handle the popup properly in order to delete the object
13294 * when the action is finished.
13295 * If the function returns @c NULL the popup will be ignored.
13297 * @see elm_web_dialog_alert_hook_set()
13299 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13301 * Callback type for the JS confirm hook.
13303 * The function parameters are:
13304 * @li @p data User data pointer set when setting the hook function
13305 * @li @p obj The elm_web object requesting the new window
13306 * @li @p message The message to show in the confirm dialog
13307 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13308 * the user selected @c Ok, @c EINA_FALSE otherwise.
13310 * The function should return the object representing the confirm dialog.
13311 * Elm_Web will run a second main loop to handle the dialog and normal
13312 * flow of the application will be restored when the object is deleted, so
13313 * the user should handle the popup properly in order to delete the object
13314 * when the action is finished.
13315 * If the function returns @c NULL the popup will be ignored.
13317 * @see elm_web_dialog_confirm_hook_set()
13319 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13321 * Callback type for the JS prompt hook.
13323 * The function parameters are:
13324 * @li @p data User data pointer set when setting the hook function
13325 * @li @p obj The elm_web object requesting the new window
13326 * @li @p message The message to show in the prompt dialog
13327 * @li @p def_value The default value to present the user in the entry
13328 * @li @p value Pointer where to store the value given by the user. Must
13329 * be a malloc'ed string or @c NULL if the user cancelled the popup.
13330 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13331 * the user selected @c Ok, @c EINA_FALSE otherwise.
13333 * The function should return the object representing the prompt dialog.
13334 * Elm_Web will run a second main loop to handle the dialog and normal
13335 * flow of the application will be restored when the object is deleted, so
13336 * the user should handle the popup properly in order to delete the object
13337 * when the action is finished.
13338 * If the function returns @c NULL the popup will be ignored.
13340 * @see elm_web_dialog_prompt_hook_set()
13342 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13344 * Callback type for the JS file selector hook.
13346 * The function parameters are:
13347 * @li @p data User data pointer set when setting the hook function
13348 * @li @p obj The elm_web object requesting the new window
13349 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13350 * @li @p accept_types Mime types accepted
13351 * @li @p selected Pointer where to store the list of malloc'ed strings
13352 * containing the path to each file selected. Must be @c NULL if the file
13353 * dialog is cancelled
13354 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13355 * the user selected @c Ok, @c EINA_FALSE otherwise.
13357 * The function should return the object representing the file selector
13359 * Elm_Web will run a second main loop to handle the dialog and normal
13360 * flow of the application will be restored when the object is deleted, so
13361 * the user should handle the popup properly in order to delete the object
13362 * when the action is finished.
13363 * If the function returns @c NULL the popup will be ignored.
13365 * @see elm_web_dialog_file selector_hook_set()
13367 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);
13369 * Callback type for the JS console message hook.
13371 * When a console message is added from JavaScript, any set function to the
13372 * console message hook will be called for the user to handle. There is no
13373 * default implementation of this hook.
13375 * The function parameters are:
13376 * @li @p data User data pointer set when setting the hook function
13377 * @li @p obj The elm_web object that originated the message
13378 * @li @p message The message sent
13379 * @li @p line_number The line number
13380 * @li @p source_id Source id
13382 * @see elm_web_console_message_hook_set()
13384 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13386 * Add a new web object to the parent.
13388 * @param parent The parent object.
13389 * @return The new object or NULL if it cannot be created.
13391 * @see elm_web_uri_set()
13392 * @see elm_web_webkit_view_get()
13394 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13397 * Get internal ewk_view object from web object.
13399 * Elementary may not provide some low level features of EWebKit,
13400 * instead of cluttering the API with proxy methods we opted to
13401 * return the internal reference. Be careful using it as it may
13402 * interfere with elm_web behavior.
13404 * @param obj The web object.
13405 * @return The internal ewk_view object or NULL if it does not
13406 * exist. (Failure to create or Elementary compiled without
13409 * @see elm_web_add()
13411 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13414 * Sets the function to call when a new window is requested
13416 * This hook will be called when a request to create a new window is
13417 * issued from the web page loaded.
13418 * There is no default implementation for this feature, so leaving this
13419 * unset or passing @c NULL in @p func will prevent new windows from
13422 * @param obj The web object where to set the hook function
13423 * @param func The hook function to be called when a window is requested
13424 * @param data User data
13426 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13428 * Sets the function to call when an alert dialog
13430 * This hook will be called when a JavaScript alert dialog is requested.
13431 * If no function is set or @c NULL is passed in @p func, the default
13432 * implementation will take place.
13434 * @param obj The web object where to set the hook function
13435 * @param func The callback function to be used
13436 * @param data User data
13438 * @see elm_web_inwin_mode_set()
13440 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13442 * Sets the function to call when an confirm dialog
13444 * This hook will be called when a JavaScript confirm dialog is requested.
13445 * If no function is set or @c NULL is passed in @p func, the default
13446 * implementation will take place.
13448 * @param obj The web object where to set the hook function
13449 * @param func The callback function to be used
13450 * @param data User data
13452 * @see elm_web_inwin_mode_set()
13454 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13456 * Sets the function to call when an prompt dialog
13458 * This hook will be called when a JavaScript prompt dialog is requested.
13459 * If no function is set or @c NULL is passed in @p func, the default
13460 * implementation will take place.
13462 * @param obj The web object where to set the hook function
13463 * @param func The callback function to be used
13464 * @param data User data
13466 * @see elm_web_inwin_mode_set()
13468 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13470 * Sets the function to call when an file selector dialog
13472 * This hook will be called when a JavaScript file selector dialog is
13474 * If no function is set or @c NULL is passed in @p func, the default
13475 * implementation will take place.
13477 * @param obj The web object where to set the hook function
13478 * @param func The callback function to be used
13479 * @param data User data
13481 * @see elm_web_inwin_mode_set()
13483 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13485 * Sets the function to call when a console message is emitted from JS
13487 * This hook will be called when a console message is emitted from
13488 * JavaScript. There is no default implementation for this feature.
13490 * @param obj The web object where to set the hook function
13491 * @param func The callback function to be used
13492 * @param data User data
13494 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13496 * Gets the status of the tab propagation
13498 * @param obj The web object to query
13499 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13501 * @see elm_web_tab_propagate_set()
13503 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
13505 * Sets whether to use tab propagation
13507 * If tab propagation is enabled, whenever the user presses the Tab key,
13508 * Elementary will handle it and switch focus to the next widget.
13509 * The default value is disabled, where WebKit will handle the Tab key to
13510 * cycle focus though its internal objects, jumping to the next widget
13511 * only when that cycle ends.
13513 * @param obj The web object
13514 * @param propagate Whether to propagate Tab keys to Elementary or not
13516 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13518 * Sets the URI for the web object
13520 * It must be a full URI, with resource included, in the form
13521 * http://www.enlightenment.org or file:///tmp/something.html
13523 * @param obj The web object
13524 * @param uri The URI to set
13525 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13527 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
13529 * Gets the current URI for the object
13531 * The returned string must not be freed and is guaranteed to be
13534 * @param obj The web object
13535 * @return A stringshared internal string with the current URI, or NULL on
13538 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
13540 * Gets the current title
13542 * The returned string must not be freed and is guaranteed to be
13545 * @param obj The web object
13546 * @return A stringshared internal string with the current title, or NULL on
13549 EAPI const char *elm_web_title_get(const Evas_Object *obj);
13551 * Sets the background color to be used by the web object
13553 * This is the color that will be used by default when the loaded page
13554 * does not set it's own. Color values are pre-multiplied.
13556 * @param obj The web object
13557 * @param r Red component
13558 * @param g Green component
13559 * @param b Blue component
13560 * @param a Alpha component
13562 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13564 * Gets the background color to be used by the web object
13566 * This is the color that will be used by default when the loaded page
13567 * does not set it's own. Color values are pre-multiplied.
13569 * @param obj The web object
13570 * @param r Red component
13571 * @param g Green component
13572 * @param b Blue component
13573 * @param a Alpha component
13575 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13577 * Gets a copy of the currently selected text
13579 * The string returned must be freed by the user when it's done with it.
13581 * @param obj The web object
13582 * @return A newly allocated string, or NULL if nothing is selected or an
13585 EAPI char *elm_view_selection_get(const Evas_Object *obj);
13587 * Tells the web object which index in the currently open popup was selected
13589 * When the user handles the popup creation from the "popup,created" signal,
13590 * it needs to tell the web object which item was selected by calling this
13591 * function with the index corresponding to the item.
13593 * @param obj The web object
13594 * @param index The index selected
13596 * @see elm_web_popup_destroy()
13598 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
13600 * Dismisses an open dropdown popup
13602 * When the popup from a dropdown widget is to be dismissed, either after
13603 * selecting an option or to cancel it, this function must be called, which
13604 * will later emit an "popup,willdelete" signal to notify the user that
13605 * any memory and objects related to this popup can be freed.
13607 * @param obj The web object
13608 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13609 * if there was no menu to destroy
13611 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
13613 * Searches the given string in a document.
13615 * @param obj The web object where to search the text
13616 * @param string String to search
13617 * @param case_sensitive If search should be case sensitive or not
13618 * @param forward If search is from cursor and on or backwards
13619 * @param wrap If search should wrap at the end
13621 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13624 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13626 * Marks matches of the given string in a document.
13628 * @param obj The web object where to search text
13629 * @param string String to match
13630 * @param case_sensitive If match should be case sensitive or not
13631 * @param highlight If matches should be highlighted
13632 * @param limit Maximum amount of matches, or zero to unlimited
13634 * @return number of matched @a string
13636 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13638 * Clears all marked matches in the document
13640 * @param obj The web object
13642 * @return EINA_TRUE on success, EINA_FALSE otherwise
13644 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
13646 * Sets whether to highlight the matched marks
13648 * If enabled, marks set with elm_web_text_matches_mark() will be
13651 * @param obj The web object
13652 * @param highlight Whether to highlight the marks or not
13654 * @return EINA_TRUE on success, EINA_FALSE otherwise
13656 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13658 * Gets whether highlighting marks is enabled
13660 * @param The web object
13662 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13665 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
13667 * Gets the overall loading progress of the page
13669 * Returns the estimated loading progress of the page, with a value between
13670 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13671 * included in the page.
13673 * @param The web object
13675 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13678 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
13680 * Stops loading the current page
13682 * Cancels the loading of the current page in the web object. This will
13683 * cause a "load,error" signal to be emitted, with the is_cancellation
13684 * flag set to EINA_TRUE.
13686 * @param obj The web object
13688 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13690 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
13692 * Requests a reload of the current document in the object
13694 * @param obj The web object
13696 * @return EINA_TRUE on success, EINA_FALSE otherwise
13698 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
13700 * Requests a reload of the current document, avoiding any existing caches
13702 * @param obj The web object
13704 * @return EINA_TRUE on success, EINA_FALSE otherwise
13706 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
13708 * Goes back one step in the browsing history
13710 * This is equivalent to calling elm_web_object_navigate(obj, -1);
13712 * @param obj The web object
13714 * @return EINA_TRUE on success, EINA_FALSE otherwise
13716 * @see elm_web_history_enable_set()
13717 * @see elm_web_back_possible()
13718 * @see elm_web_forward()
13719 * @see elm_web_navigate()
13721 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
13723 * Goes forward one step in the browsing history
13725 * This is equivalent to calling elm_web_object_navigate(obj, 1);
13727 * @param obj The web object
13729 * @return EINA_TRUE on success, EINA_FALSE otherwise
13731 * @see elm_web_history_enable_set()
13732 * @see elm_web_forward_possible()
13733 * @see elm_web_back()
13734 * @see elm_web_navigate()
13736 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
13738 * Jumps the given number of steps in the browsing history
13740 * The @p steps value can be a negative integer to back in history, or a
13741 * positive to move forward.
13743 * @param obj The web object
13744 * @param steps The number of steps to jump
13746 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13747 * history exists to jump the given number of steps
13749 * @see elm_web_history_enable_set()
13750 * @see elm_web_navigate_possible()
13751 * @see elm_web_back()
13752 * @see elm_web_forward()
13754 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
13756 * Queries whether it's possible to go back in history
13758 * @param obj The web object
13760 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13763 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
13765 * Queries whether it's possible to go forward in history
13767 * @param obj The web object
13769 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13772 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
13774 * Queries whether it's possible to jump the given number of steps
13776 * The @p steps value can be a negative integer to back in history, or a
13777 * positive to move forward.
13779 * @param obj The web object
13780 * @param steps The number of steps to check for
13782 * @return EINA_TRUE if enough history exists to perform the given jump,
13783 * EINA_FALSE otherwise
13785 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
13787 * Gets whether browsing history is enabled for the given object
13789 * @param obj The web object
13791 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
13793 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
13795 * Enables or disables the browsing history
13797 * @param obj The web object
13798 * @param enable Whether to enable or disable the browsing history
13800 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
13802 * Sets the zoom level of the web object
13804 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
13805 * values meaning zoom in and lower meaning zoom out. This function will
13806 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
13807 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
13809 * @param obj The web object
13810 * @param zoom The zoom level to set
13812 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
13814 * Gets the current zoom level set on the web object
13816 * Note that this is the zoom level set on the web object and not that
13817 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
13818 * the two zoom levels should match, but for the other two modes the
13819 * Webkit zoom is calculated internally to match the chosen mode without
13820 * changing the zoom level set for the web object.
13822 * @param obj The web object
13824 * @return The zoom level set on the object
13826 EAPI double elm_web_zoom_get(const Evas_Object *obj);
13828 * Sets the zoom mode to use
13830 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
13831 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
13833 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
13834 * with the elm_web_zoom_set() function.
13835 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
13836 * make sure the entirety of the web object's contents are shown.
13837 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
13838 * fit the contents in the web object's size, without leaving any space
13841 * @param obj The web object
13842 * @param mode The mode to set
13844 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
13846 * Gets the currently set zoom mode
13848 * @param obj The web object
13850 * @return The current zoom mode set for the object, or
13851 * ::ELM_WEB_ZOOM_MODE_LAST on error
13853 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
13855 * Shows the given region in the web object
13857 * @param obj The web object
13858 * @param x The x coordinate of the region to show
13859 * @param y The y coordinate of the region to show
13860 * @param w The width of the region to show
13861 * @param h The height of the region to show
13863 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
13865 * Brings in the region to the visible area
13867 * Like elm_web_region_show(), but it animates the scrolling of the object
13870 * @param obj The web object
13871 * @param x The x coordinate of the region to show
13872 * @param y The y coordinate of the region to show
13873 * @param w The width of the region to show
13874 * @param h The height of the region to show
13876 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
13878 * Sets the default dialogs to use an Inwin instead of a normal window
13880 * If set, then the default implementation for the JavaScript dialogs and
13881 * file selector will be opened in an Inwin. Otherwise they will use a
13882 * normal separated window.
13884 * @param obj The web object
13885 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
13887 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
13889 * Gets whether Inwin mode is set for the current object
13891 * @param obj The web object
13893 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
13895 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
13897 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
13898 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
13899 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);
13900 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
13907 * @defgroup Hoversel Hoversel
13909 * @image html img/widget/hoversel/preview-00.png
13910 * @image latex img/widget/hoversel/preview-00.eps
13912 * A hoversel is a button that pops up a list of items (automatically
13913 * choosing the direction to display) that have a label and, optionally, an
13914 * icon to select from. It is a convenience widget to avoid the need to do
13915 * all the piecing together yourself. It is intended for a small number of
13916 * items in the hoversel menu (no more than 8), though is capable of many
13919 * Signals that you can add callbacks for are:
13920 * "clicked" - the user clicked the hoversel button and popped up the sel
13921 * "selected" - an item in the hoversel list is selected. event_info is the item
13922 * "dismissed" - the hover is dismissed
13924 * See @ref tutorial_hoversel for an example.
13927 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
13929 * @brief Add a new Hoversel object
13931 * @param parent The parent object
13932 * @return The new object or NULL if it cannot be created
13934 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13936 * @brief This sets the hoversel to expand horizontally.
13938 * @param obj The hoversel object
13939 * @param horizontal If true, the hover will expand horizontally to the
13942 * @note The initial button will display horizontally regardless of this
13945 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
13947 * @brief This returns whether the hoversel is set to expand horizontally.
13949 * @param obj The hoversel object
13950 * @return If true, the hover will expand horizontally to the right.
13952 * @see elm_hoversel_horizontal_set()
13954 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13956 * @brief Set the Hover parent
13958 * @param obj The hoversel object
13959 * @param parent The parent to use
13961 * Sets the hover parent object, the area that will be darkened when the
13962 * hoversel is clicked. Should probably be the window that the hoversel is
13963 * in. See @ref Hover objects for more information.
13965 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13967 * @brief Get the Hover parent
13969 * @param obj The hoversel object
13970 * @return The used parent
13972 * Gets the hover parent object.
13974 * @see elm_hoversel_hover_parent_set()
13976 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13978 * @brief Set the hoversel button label
13980 * @param obj The hoversel object
13981 * @param label The label text.
13983 * This sets the label of the button that is always visible (before it is
13984 * clicked and expanded).
13986 * @deprecated elm_object_text_set()
13988 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13990 * @brief Get the hoversel button label
13992 * @param obj The hoversel object
13993 * @return The label text.
13995 * @deprecated elm_object_text_get()
13997 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13999 * @brief Set the icon of the hoversel button
14001 * @param obj The hoversel object
14002 * @param icon The icon object
14004 * Sets the icon of the button that is always visible (before it is clicked
14005 * and expanded). Once the icon object is set, a previously set one will be
14006 * deleted, if you want to keep that old content object, use the
14007 * elm_hoversel_icon_unset() function.
14009 * @see elm_object_content_set() for the button widget
14011 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14013 * @brief Get the icon of the hoversel button
14015 * @param obj The hoversel object
14016 * @return The icon object
14018 * Get the icon of the button that is always visible (before it is clicked
14019 * and expanded). Also see elm_object_content_get() for the button widget.
14021 * @see elm_hoversel_icon_set()
14023 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14025 * @brief Get and unparent the icon of the hoversel button
14027 * @param obj The hoversel object
14028 * @return The icon object that was being used
14030 * Unparent and return the icon of the button that is always visible
14031 * (before it is clicked and expanded).
14033 * @see elm_hoversel_icon_set()
14034 * @see elm_object_content_unset() for the button widget
14036 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14038 * @brief This triggers the hoversel popup from code, the same as if the user
14039 * had clicked the button.
14041 * @param obj The hoversel object
14043 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14045 * @brief This dismisses the hoversel popup as if the user had clicked
14046 * outside the hover.
14048 * @param obj The hoversel object
14050 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14052 * @brief Returns whether the hoversel is expanded.
14054 * @param obj The hoversel object
14055 * @return This will return EINA_TRUE if the hoversel is expanded or
14056 * EINA_FALSE if it is not expanded.
14058 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14060 * @brief This will remove all the children items from the hoversel.
14062 * @param obj The hoversel object
14064 * @warning Should @b not be called while the hoversel is active; use
14065 * elm_hoversel_expanded_get() to check first.
14067 * @see elm_hoversel_item_del_cb_set()
14068 * @see elm_hoversel_item_del()
14070 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14072 * @brief Get the list of items within the given hoversel.
14074 * @param obj The hoversel object
14075 * @return Returns a list of Elm_Hoversel_Item*
14077 * @see elm_hoversel_item_add()
14079 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14081 * @brief Add an item to the hoversel button
14083 * @param obj The hoversel object
14084 * @param label The text label to use for the item (NULL if not desired)
14085 * @param icon_file An image file path on disk to use for the icon or standard
14086 * icon name (NULL if not desired)
14087 * @param icon_type The icon type if relevant
14088 * @param func Convenience function to call when this item is selected
14089 * @param data Data to pass to item-related functions
14090 * @return A handle to the item added.
14092 * This adds an item to the hoversel to show when it is clicked. Note: if you
14093 * need to use an icon from an edje file then use
14094 * elm_hoversel_item_icon_set() right after the this function, and set
14095 * icon_file to NULL here.
14097 * For more information on what @p icon_file and @p icon_type are see the
14098 * @ref Icon "icon documentation".
14100 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);
14102 * @brief Delete an item from the hoversel
14104 * @param item The item to delete
14106 * This deletes the item from the hoversel (should not be called while the
14107 * hoversel is active; use elm_hoversel_expanded_get() to check first).
14109 * @see elm_hoversel_item_add()
14110 * @see elm_hoversel_item_del_cb_set()
14112 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14114 * @brief Set the function to be called when an item from the hoversel is
14117 * @param item The item to set the callback on
14118 * @param func The function called
14120 * That function will receive these parameters:
14121 * @li void *item_data
14122 * @li Evas_Object *the_item_object
14123 * @li Elm_Hoversel_Item *the_object_struct
14125 * @see elm_hoversel_item_add()
14127 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14129 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14130 * that will be passed to associated function callbacks.
14132 * @param item The item to get the data from
14133 * @return The data pointer set with elm_hoversel_item_add()
14135 * @see elm_hoversel_item_add()
14137 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14139 * @brief This returns the label text of the given hoversel item.
14141 * @param item The item to get the label
14142 * @return The label text of the hoversel item
14144 * @see elm_hoversel_item_add()
14146 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14148 * @brief This sets the icon for the given hoversel item.
14150 * @param item The item to set the icon
14151 * @param icon_file An image file path on disk to use for the icon or standard
14153 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14154 * to NULL if the icon is not an edje file
14155 * @param icon_type The icon type
14157 * The icon can be loaded from the standard set, from an image file, or from
14160 * @see elm_hoversel_item_add()
14162 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);
14164 * @brief Get the icon object of the hoversel item
14166 * @param item The item to get the icon from
14167 * @param icon_file The image file path on disk used for the icon or standard
14169 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14170 * if the icon is not an edje file
14171 * @param icon_type The icon type
14173 * @see elm_hoversel_item_icon_set()
14174 * @see elm_hoversel_item_add()
14176 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);
14182 * @defgroup Toolbar Toolbar
14183 * @ingroup Elementary
14185 * @image html img/widget/toolbar/preview-00.png
14186 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14188 * @image html img/toolbar.png
14189 * @image latex img/toolbar.eps width=\textwidth
14191 * A toolbar is a widget that displays a list of items inside
14192 * a box. It can be scrollable, show a menu with items that don't fit
14193 * to toolbar size or even crop them.
14195 * Only one item can be selected at a time.
14197 * Items can have multiple states, or show menus when selected by the user.
14199 * Smart callbacks one can listen to:
14200 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14201 * - "language,changed" - when the program language changes
14203 * Available styles for it:
14205 * - @c "transparent" - no background or shadow, just show the content
14207 * List of examples:
14208 * @li @ref toolbar_example_01
14209 * @li @ref toolbar_example_02
14210 * @li @ref toolbar_example_03
14214 * @addtogroup Toolbar
14219 * @enum _Elm_Toolbar_Shrink_Mode
14220 * @typedef Elm_Toolbar_Shrink_Mode
14222 * Set toolbar's items display behavior, it can be scrollabel,
14223 * show a menu with exceeding items, or simply hide them.
14225 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14228 * Values <b> don't </b> work as bitmask, only one can be choosen.
14230 * @see elm_toolbar_mode_shrink_set()
14231 * @see elm_toolbar_mode_shrink_get()
14235 typedef enum _Elm_Toolbar_Shrink_Mode
14237 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
14238 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
14239 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14240 ELM_TOOLBAR_SHRINK_MENU, /**< Inserts a button to pop up a menu with exceeding items. */
14241 ELM_TOOLBAR_SHRINK_LAST /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14242 } Elm_Toolbar_Shrink_Mode;
14244 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(). */
14246 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(). */
14249 * Add a new toolbar widget to the given parent Elementary
14250 * (container) object.
14252 * @param parent The parent object.
14253 * @return a new toolbar widget handle or @c NULL, on errors.
14255 * This function inserts a new toolbar widget on the canvas.
14259 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14262 * Set the icon size, in pixels, to be used by toolbar items.
14264 * @param obj The toolbar object
14265 * @param icon_size The icon size in pixels
14267 * @note Default value is @c 32. It reads value from elm config.
14269 * @see elm_toolbar_icon_size_get()
14273 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14276 * Get the icon size, in pixels, to be used by toolbar items.
14278 * @param obj The toolbar object.
14279 * @return The icon size in pixels.
14281 * @see elm_toolbar_icon_size_set() for details.
14285 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14288 * Sets icon lookup order, for toolbar items' icons.
14290 * @param obj The toolbar object.
14291 * @param order The icon lookup order.
14293 * Icons added before calling this function will not be affected.
14294 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14296 * @see elm_toolbar_icon_order_lookup_get()
14300 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14303 * Gets the icon lookup order.
14305 * @param obj The toolbar object.
14306 * @return The icon lookup order.
14308 * @see elm_toolbar_icon_order_lookup_set() for details.
14312 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14315 * Set whether the toolbar should always have an item selected.
14317 * @param obj The toolbar object.
14318 * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14321 * This will cause the toolbar to always have an item selected, and clicking
14322 * the selected item will not cause a selected event to be emitted. Enabling this mode
14323 * will immediately select the first toolbar item.
14325 * Always-selected is disabled by default.
14327 * @see elm_toolbar_always_select_mode_get().
14331 EAPI void elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14334 * Get whether the toolbar should always have an item selected.
14336 * @param obj The toolbar object.
14337 * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14338 * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14340 * @see elm_toolbar_always_select_mode_set() for details.
14344 EAPI Eina_Bool elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14347 * Set whether the toolbar items' should be selected by the user or not.
14349 * @param obj The toolbar object.
14350 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14353 * This will turn off the ability to select items entirely and they will
14354 * neither appear selected nor emit selected signals. The clicked
14355 * callback function will still be called.
14357 * Selection is enabled by default.
14359 * @see elm_toolbar_no_select_mode_get().
14363 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14366 * Set whether the toolbar items' should be selected by the user or not.
14368 * @param obj The toolbar object.
14369 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14370 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14372 * @see elm_toolbar_no_select_mode_set() for details.
14376 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14379 * Append item to the toolbar.
14381 * @param obj The toolbar object.
14382 * @param icon A string with icon name or the absolute path of an image file.
14383 * @param label The label of the item.
14384 * @param func The function to call when the item is clicked.
14385 * @param data The data to associate with the item for related callbacks.
14386 * @return The created item or @c NULL upon failure.
14388 * A new item will be created and appended to the toolbar, i.e., will
14389 * be set as @b last item.
14391 * Items created with this method can be deleted with
14392 * elm_toolbar_item_del().
14394 * Associated @p data can be properly freed when item is deleted if a
14395 * callback function is set with elm_toolbar_item_del_cb_set().
14397 * If a function is passed as argument, it will be called everytime this item
14398 * is selected, i.e., the user clicks over an unselected item.
14399 * If such function isn't needed, just passing
14400 * @c NULL as @p func is enough. The same should be done for @p data.
14402 * Toolbar will load icon image from fdo or current theme.
14403 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14404 * If an absolute path is provided it will load it direct from a file.
14406 * @see elm_toolbar_item_icon_set()
14407 * @see elm_toolbar_item_del()
14408 * @see elm_toolbar_item_del_cb_set()
14412 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);
14415 * Prepend item to the toolbar.
14417 * @param obj The toolbar object.
14418 * @param icon A string with icon name or the absolute path of an image file.
14419 * @param label The label of the item.
14420 * @param func The function to call when the item is clicked.
14421 * @param data The data to associate with the item for related callbacks.
14422 * @return The created item or @c NULL upon failure.
14424 * A new item will be created and prepended to the toolbar, i.e., will
14425 * be set as @b first item.
14427 * Items created with this method can be deleted with
14428 * elm_toolbar_item_del().
14430 * Associated @p data can be properly freed when item is deleted if a
14431 * callback function is set with elm_toolbar_item_del_cb_set().
14433 * If a function is passed as argument, it will be called everytime this item
14434 * is selected, i.e., the user clicks over an unselected item.
14435 * If such function isn't needed, just passing
14436 * @c NULL as @p func is enough. The same should be done for @p data.
14438 * Toolbar will load icon image from fdo or current theme.
14439 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14440 * If an absolute path is provided it will load it direct from a file.
14442 * @see elm_toolbar_item_icon_set()
14443 * @see elm_toolbar_item_del()
14444 * @see elm_toolbar_item_del_cb_set()
14448 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);
14451 * Insert a new item into the toolbar object before item @p before.
14453 * @param obj The toolbar object.
14454 * @param before The toolbar item to insert before.
14455 * @param icon A string with icon name or the absolute path of an image file.
14456 * @param label The label of the item.
14457 * @param func The function to call when the item is clicked.
14458 * @param data The data to associate with the item for related callbacks.
14459 * @return The created item or @c NULL upon failure.
14461 * A new item will be created and added to the toolbar. Its position in
14462 * this toolbar will be just before item @p before.
14464 * Items created with this method can be deleted with
14465 * elm_toolbar_item_del().
14467 * Associated @p data can be properly freed when item is deleted if a
14468 * callback function is set with elm_toolbar_item_del_cb_set().
14470 * If a function is passed as argument, it will be called everytime this item
14471 * is selected, i.e., the user clicks over an unselected item.
14472 * If such function isn't needed, just passing
14473 * @c NULL as @p func is enough. The same should be done for @p data.
14475 * Toolbar will load icon image from fdo or current theme.
14476 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14477 * If an absolute path is provided it will load it direct from a file.
14479 * @see elm_toolbar_item_icon_set()
14480 * @see elm_toolbar_item_del()
14481 * @see elm_toolbar_item_del_cb_set()
14485 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);
14488 * Insert a new item into the toolbar object after item @p after.
14490 * @param obj The toolbar object.
14491 * @param after The toolbar item to insert after.
14492 * @param icon A string with icon name or the absolute path of an image file.
14493 * @param label The label of the item.
14494 * @param func The function to call when the item is clicked.
14495 * @param data The data to associate with the item for related callbacks.
14496 * @return The created item or @c NULL upon failure.
14498 * A new item will be created and added to the toolbar. Its position in
14499 * this toolbar will be just after item @p after.
14501 * Items created with this method can be deleted with
14502 * elm_toolbar_item_del().
14504 * Associated @p data can be properly freed when item is deleted if a
14505 * callback function is set with elm_toolbar_item_del_cb_set().
14507 * If a function is passed as argument, it will be called everytime this item
14508 * is selected, i.e., the user clicks over an unselected item.
14509 * If such function isn't needed, just passing
14510 * @c NULL as @p func is enough. The same should be done for @p data.
14512 * Toolbar will load icon image from fdo or current theme.
14513 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14514 * If an absolute path is provided it will load it direct from a file.
14516 * @see elm_toolbar_item_icon_set()
14517 * @see elm_toolbar_item_del()
14518 * @see elm_toolbar_item_del_cb_set()
14522 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);
14525 * Get the first item in the given toolbar widget's list of
14528 * @param obj The toolbar object
14529 * @return The first item or @c NULL, if it has no items (and on
14532 * @see elm_toolbar_item_append()
14533 * @see elm_toolbar_last_item_get()
14537 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14540 * Get the last item in the given toolbar widget's list of
14543 * @param obj The toolbar object
14544 * @return The last item or @c NULL, if it has no items (and on
14547 * @see elm_toolbar_item_prepend()
14548 * @see elm_toolbar_first_item_get()
14552 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14555 * Get the item after @p item in toolbar.
14557 * @param item The toolbar item.
14558 * @return The item after @p item, or @c NULL if none or on failure.
14560 * @note If it is the last item, @c NULL will be returned.
14562 * @see elm_toolbar_item_append()
14566 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14569 * Get the item before @p item in toolbar.
14571 * @param item The toolbar item.
14572 * @return The item before @p item, or @c NULL if none or on failure.
14574 * @note If it is the first item, @c NULL will be returned.
14576 * @see elm_toolbar_item_prepend()
14580 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14583 * Get the toolbar object from an item.
14585 * @param item The item.
14586 * @return The toolbar object.
14588 * This returns the toolbar object itself that an item belongs to.
14592 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14595 * Set the priority of a toolbar item.
14597 * @param item The toolbar item.
14598 * @param priority The item priority. The default is zero.
14600 * This is used only when the toolbar shrink mode is set to
14601 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14602 * When space is less than required, items with low priority
14603 * will be removed from the toolbar and added to a dynamically-created menu,
14604 * while items with higher priority will remain on the toolbar,
14605 * with the same order they were added.
14607 * @see elm_toolbar_item_priority_get()
14611 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14614 * Get the priority of a toolbar item.
14616 * @param item The toolbar item.
14617 * @return The @p item priority, or @c 0 on failure.
14619 * @see elm_toolbar_item_priority_set() for details.
14623 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14626 * Get the label of item.
14628 * @param item The item of toolbar.
14629 * @return The label of item.
14631 * The return value is a pointer to the label associated to @p item when
14632 * it was created, with function elm_toolbar_item_append() or similar,
14634 * with function elm_toolbar_item_label_set. If no label
14635 * was passed as argument, it will return @c NULL.
14637 * @see elm_toolbar_item_label_set() for more details.
14638 * @see elm_toolbar_item_append()
14642 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14645 * Set the label of item.
14647 * @param item The item of toolbar.
14648 * @param text The label of item.
14650 * The label to be displayed by the item.
14651 * Label will be placed at icons bottom (if set).
14653 * If a label was passed as argument on item creation, with function
14654 * elm_toolbar_item_append() or similar, it will be already
14655 * displayed by the item.
14657 * @see elm_toolbar_item_label_get()
14658 * @see elm_toolbar_item_append()
14662 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14665 * Return the data associated with a given toolbar widget item.
14667 * @param item The toolbar widget item handle.
14668 * @return The data associated with @p item.
14670 * @see elm_toolbar_item_data_set()
14674 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14677 * Set the data associated with a given toolbar widget item.
14679 * @param item The toolbar widget item handle.
14680 * @param data The new data pointer to set to @p item.
14682 * This sets new item data on @p item.
14684 * @warning The old data pointer won't be touched by this function, so
14685 * the user had better to free that old data himself/herself.
14689 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14692 * Returns a pointer to a toolbar item by its label.
14694 * @param obj The toolbar object.
14695 * @param label The label of the item to find.
14697 * @return The pointer to the toolbar item matching @p label or @c NULL
14702 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14705 * Get whether the @p item is selected or not.
14707 * @param item The toolbar item.
14708 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14709 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14711 * @see elm_toolbar_selected_item_set() for details.
14712 * @see elm_toolbar_item_selected_get()
14716 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14719 * Set the selected state of an item.
14721 * @param item The toolbar item
14722 * @param selected The selected state
14724 * This sets the selected state of the given item @p it.
14725 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14727 * If a new item is selected the previosly selected will be unselected.
14728 * Previoulsy selected item can be get with function
14729 * elm_toolbar_selected_item_get().
14731 * Selected items will be highlighted.
14733 * @see elm_toolbar_item_selected_get()
14734 * @see elm_toolbar_selected_item_get()
14738 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14741 * Get the selected item.
14743 * @param obj The toolbar object.
14744 * @return The selected toolbar item.
14746 * The selected item can be unselected with function
14747 * elm_toolbar_item_selected_set().
14749 * The selected item always will be highlighted on toolbar.
14751 * @see elm_toolbar_selected_items_get()
14755 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14758 * Set the icon associated with @p item.
14760 * @param obj The parent of this item.
14761 * @param item The toolbar item.
14762 * @param icon A string with icon name or the absolute path of an image file.
14764 * Toolbar will load icon image from fdo or current theme.
14765 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14766 * If an absolute path is provided it will load it direct from a file.
14768 * @see elm_toolbar_icon_order_lookup_set()
14769 * @see elm_toolbar_icon_order_lookup_get()
14773 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
14776 * Get the string used to set the icon of @p item.
14778 * @param item The toolbar item.
14779 * @return The string associated with the icon object.
14781 * @see elm_toolbar_item_icon_set() for details.
14785 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14788 * Get the object of @p item.
14790 * @param item The toolbar item.
14791 * @return The object
14795 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14798 * Get the icon object of @p item.
14800 * @param item The toolbar item.
14801 * @return The icon object
14803 * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
14807 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14810 * Set the icon associated with @p item to an image in a binary buffer.
14812 * @param item The toolbar item.
14813 * @param img The binary data that will be used as an image
14814 * @param size The size of binary data @p img
14815 * @param format Optional format of @p img to pass to the image loader
14816 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
14818 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
14820 * @note The icon image set by this function can be changed by
14821 * elm_toolbar_item_icon_set().
14825 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);
14828 * Delete them item from the toolbar.
14830 * @param item The item of toolbar to be deleted.
14832 * @see elm_toolbar_item_append()
14833 * @see elm_toolbar_item_del_cb_set()
14837 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14840 * Set the function called when a toolbar item is freed.
14842 * @param item The item to set the callback on.
14843 * @param func The function called.
14845 * If there is a @p func, then it will be called prior item's memory release.
14846 * That will be called with the following arguments:
14848 * @li item's Evas object;
14851 * This way, a data associated to a toolbar item could be properly freed.
14855 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14858 * Get a value whether toolbar item is disabled or not.
14860 * @param item The item.
14861 * @return The disabled state.
14863 * @see elm_toolbar_item_disabled_set() for more details.
14867 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14870 * Sets the disabled/enabled state of a toolbar item.
14872 * @param item The item.
14873 * @param disabled The disabled state.
14875 * A disabled item cannot be selected or unselected. It will also
14876 * change its appearance (generally greyed out). This sets the
14877 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
14882 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14885 * Set or unset item as a separator.
14887 * @param item The toolbar item.
14888 * @param setting @c EINA_TRUE to set item @p item as separator or
14889 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
14891 * Items aren't set as separator by default.
14893 * If set as separator it will display separator theme, so won't display
14896 * @see elm_toolbar_item_separator_get()
14900 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
14903 * Get a value whether item is a separator or not.
14905 * @param item The toolbar item.
14906 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
14907 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
14909 * @see elm_toolbar_item_separator_set() for details.
14913 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14916 * Set the shrink state of toolbar @p obj.
14918 * @param obj The toolbar object.
14919 * @param shrink_mode Toolbar's items display behavior.
14921 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
14922 * but will enforce a minimun size so all the items will fit, won't scroll
14923 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
14924 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
14925 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
14929 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
14932 * Get the shrink mode of toolbar @p obj.
14934 * @param obj The toolbar object.
14935 * @return Toolbar's items display behavior.
14937 * @see elm_toolbar_mode_shrink_set() for details.
14941 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14944 * Enable/disable homogenous mode.
14946 * @param obj The toolbar object
14947 * @param homogeneous Assume the items within the toolbar are of the
14948 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
14950 * This will enable the homogeneous mode where items are of the same size.
14951 * @see elm_toolbar_homogeneous_get()
14955 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
14958 * Get whether the homogenous mode is enabled.
14960 * @param obj The toolbar object.
14961 * @return Assume the items within the toolbar are of the same height
14962 * and width (EINA_TRUE = on, EINA_FALSE = off).
14964 * @see elm_toolbar_homogeneous_set()
14968 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14971 * Enable/disable homogenous mode.
14973 * @param obj The toolbar object
14974 * @param homogeneous Assume the items within the toolbar are of the
14975 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
14977 * This will enable the homogeneous mode where items are of the same size.
14978 * @see elm_toolbar_homogeneous_get()
14980 * @deprecated use elm_toolbar_homogeneous_set() instead.
14984 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
14987 * Get whether the homogenous mode is enabled.
14989 * @param obj The toolbar object.
14990 * @return Assume the items within the toolbar are of the same height
14991 * and width (EINA_TRUE = on, EINA_FALSE = off).
14993 * @see elm_toolbar_homogeneous_set()
14994 * @deprecated use elm_toolbar_homogeneous_get() instead.
14998 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15001 * Set the parent object of the toolbar items' menus.
15003 * @param obj The toolbar object.
15004 * @param parent The parent of the menu objects.
15006 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15008 * For more details about setting the parent for toolbar menus, see
15009 * elm_menu_parent_set().
15011 * @see elm_menu_parent_set() for details.
15012 * @see elm_toolbar_item_menu_set() for details.
15016 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15019 * Get the parent object of the toolbar items' menus.
15021 * @param obj The toolbar object.
15022 * @return The parent of the menu objects.
15024 * @see elm_toolbar_menu_parent_set() for details.
15028 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15031 * Set the alignment of the items.
15033 * @param obj The toolbar object.
15034 * @param align The new alignment, a float between <tt> 0.0 </tt>
15035 * and <tt> 1.0 </tt>.
15037 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15038 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15041 * Centered items by default.
15043 * @see elm_toolbar_align_get()
15047 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15050 * Get the alignment of the items.
15052 * @param obj The toolbar object.
15053 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15056 * @see elm_toolbar_align_set() for details.
15060 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15063 * Set whether the toolbar item opens a menu.
15065 * @param item The toolbar item.
15066 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15068 * A toolbar item can be set to be a menu, using this function.
15070 * Once it is set to be a menu, it can be manipulated through the
15071 * menu-like function elm_toolbar_menu_parent_set() and the other
15072 * elm_menu functions, using the Evas_Object @c menu returned by
15073 * elm_toolbar_item_menu_get().
15075 * So, items to be displayed in this item's menu should be added with
15076 * elm_menu_item_add().
15078 * The following code exemplifies the most basic usage:
15080 * tb = elm_toolbar_add(win)
15081 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15082 * elm_toolbar_item_menu_set(item, EINA_TRUE);
15083 * elm_toolbar_menu_parent_set(tb, win);
15084 * menu = elm_toolbar_item_menu_get(item);
15085 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15086 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15090 * @see elm_toolbar_item_menu_get()
15094 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15097 * Get toolbar item's menu.
15099 * @param item The toolbar item.
15100 * @return Item's menu object or @c NULL on failure.
15102 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15103 * this function will set it.
15105 * @see elm_toolbar_item_menu_set() for details.
15109 EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15112 * Add a new state to @p item.
15114 * @param item The item.
15115 * @param icon A string with icon name or the absolute path of an image file.
15116 * @param label The label of the new state.
15117 * @param func The function to call when the item is clicked when this
15118 * state is selected.
15119 * @param data The data to associate with the state.
15120 * @return The toolbar item state, or @c NULL upon failure.
15122 * Toolbar will load icon image from fdo or current theme.
15123 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15124 * If an absolute path is provided it will load it direct from a file.
15126 * States created with this function can be removed with
15127 * elm_toolbar_item_state_del().
15129 * @see elm_toolbar_item_state_del()
15130 * @see elm_toolbar_item_state_sel()
15131 * @see elm_toolbar_item_state_get()
15135 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);
15138 * Delete a previoulsy added state to @p item.
15140 * @param item The toolbar item.
15141 * @param state The state to be deleted.
15142 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15144 * @see elm_toolbar_item_state_add()
15146 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15149 * Set @p state as the current state of @p it.
15151 * @param it The item.
15152 * @param state The state to use.
15153 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15155 * If @p state is @c NULL, it won't select any state and the default item's
15156 * icon and label will be used. It's the same behaviour than
15157 * elm_toolbar_item_state_unser().
15159 * @see elm_toolbar_item_state_unset()
15163 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15166 * Unset the state of @p it.
15168 * @param it The item.
15170 * The default icon and label from this item will be displayed.
15172 * @see elm_toolbar_item_state_set() for more details.
15176 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15179 * Get the current state of @p it.
15181 * @param item The item.
15182 * @return The selected state or @c NULL if none is selected or on failure.
15184 * @see elm_toolbar_item_state_set() for details.
15185 * @see elm_toolbar_item_state_unset()
15186 * @see elm_toolbar_item_state_add()
15190 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15193 * Get the state after selected state in toolbar's @p item.
15195 * @param it The toolbar item to change state.
15196 * @return The state after current state, or @c NULL on failure.
15198 * If last state is selected, this function will return first state.
15200 * @see elm_toolbar_item_state_set()
15201 * @see elm_toolbar_item_state_add()
15205 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15208 * Get the state before selected state in toolbar's @p item.
15210 * @param it The toolbar item to change state.
15211 * @return The state before current state, or @c NULL on failure.
15213 * If first state is selected, this function will return last state.
15215 * @see elm_toolbar_item_state_set()
15216 * @see elm_toolbar_item_state_add()
15220 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15223 * Set the text to be shown in a given toolbar item's tooltips.
15225 * @param item Target item.
15226 * @param text The text to set in the content.
15228 * Setup the text as tooltip to object. The item can have only one tooltip,
15229 * so any previous tooltip data - set with this function or
15230 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15232 * @see elm_object_tooltip_text_set() for more details.
15236 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15239 * Set the content to be shown in the tooltip item.
15241 * Setup the tooltip to item. The item can have only one tooltip,
15242 * so any previous tooltip data is removed. @p func(with @p data) will
15243 * be called every time that need show the tooltip and it should
15244 * return a valid Evas_Object. This object is then managed fully by
15245 * tooltip system and is deleted when the tooltip is gone.
15247 * @param item the toolbar item being attached a tooltip.
15248 * @param func the function used to create the tooltip contents.
15249 * @param data what to provide to @a func as callback data/context.
15250 * @param del_cb called when data is not needed anymore, either when
15251 * another callback replaces @a func, the tooltip is unset with
15252 * elm_toolbar_item_tooltip_unset() or the owner @a item
15253 * dies. This callback receives as the first parameter the
15254 * given @a data, and @c event_info is the item.
15256 * @see elm_object_tooltip_content_cb_set() for more details.
15260 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);
15263 * Unset tooltip from item.
15265 * @param item toolbar item to remove previously set tooltip.
15267 * Remove tooltip from item. The callback provided as del_cb to
15268 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15269 * it is not used anymore.
15271 * @see elm_object_tooltip_unset() for more details.
15272 * @see elm_toolbar_item_tooltip_content_cb_set()
15276 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15279 * Sets a different style for this item tooltip.
15281 * @note before you set a style you should define a tooltip with
15282 * elm_toolbar_item_tooltip_content_cb_set() or
15283 * elm_toolbar_item_tooltip_text_set()
15285 * @param item toolbar item with tooltip already set.
15286 * @param style the theme style to use (default, transparent, ...)
15288 * @see elm_object_tooltip_style_set() for more details.
15292 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15295 * Get the style for this item tooltip.
15297 * @param item toolbar item with tooltip already set.
15298 * @return style the theme style in use, defaults to "default". If the
15299 * object does not have a tooltip set, then NULL is returned.
15301 * @see elm_object_tooltip_style_get() for more details.
15302 * @see elm_toolbar_item_tooltip_style_set()
15306 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15309 * Set the type of mouse pointer/cursor decoration to be shown,
15310 * when the mouse pointer is over the given toolbar widget item
15312 * @param item toolbar item to customize cursor on
15313 * @param cursor the cursor type's name
15315 * This function works analogously as elm_object_cursor_set(), but
15316 * here the cursor's changing area is restricted to the item's
15317 * area, and not the whole widget's. Note that that item cursors
15318 * have precedence over widget cursors, so that a mouse over an
15319 * item with custom cursor set will always show @b that cursor.
15321 * If this function is called twice for an object, a previously set
15322 * cursor will be unset on the second call.
15324 * @see elm_object_cursor_set()
15325 * @see elm_toolbar_item_cursor_get()
15326 * @see elm_toolbar_item_cursor_unset()
15330 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15333 * Get the type of mouse pointer/cursor decoration set to be shown,
15334 * when the mouse pointer is over the given toolbar widget item
15336 * @param item toolbar item with custom cursor set
15337 * @return the cursor type's name or @c NULL, if no custom cursors
15338 * were set to @p item (and on errors)
15340 * @see elm_object_cursor_get()
15341 * @see elm_toolbar_item_cursor_set()
15342 * @see elm_toolbar_item_cursor_unset()
15346 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15349 * Unset any custom mouse pointer/cursor decoration set to be
15350 * shown, when the mouse pointer is over the given toolbar widget
15351 * item, thus making it show the @b default cursor again.
15353 * @param item a toolbar item
15355 * Use this call to undo any custom settings on this item's cursor
15356 * decoration, bringing it back to defaults (no custom style set).
15358 * @see elm_object_cursor_unset()
15359 * @see elm_toolbar_item_cursor_set()
15363 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15366 * Set a different @b style for a given custom cursor set for a
15369 * @param item toolbar item with custom cursor set
15370 * @param style the <b>theme style</b> to use (e.g. @c "default",
15371 * @c "transparent", etc)
15373 * This function only makes sense when one is using custom mouse
15374 * cursor decorations <b>defined in a theme file</b>, which can have,
15375 * given a cursor name/type, <b>alternate styles</b> on it. It
15376 * works analogously as elm_object_cursor_style_set(), but here
15377 * applyed only to toolbar item objects.
15379 * @warning Before you set a cursor style you should have definen a
15380 * custom cursor previously on the item, with
15381 * elm_toolbar_item_cursor_set()
15383 * @see elm_toolbar_item_cursor_engine_only_set()
15384 * @see elm_toolbar_item_cursor_style_get()
15388 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15391 * Get the current @b style set for a given toolbar item's custom
15394 * @param item toolbar item with custom cursor set.
15395 * @return style the cursor style in use. If the object does not
15396 * have a cursor set, then @c NULL is returned.
15398 * @see elm_toolbar_item_cursor_style_set() for more details
15402 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15405 * Set if the (custom)cursor for a given toolbar item should be
15406 * searched in its theme, also, or should only rely on the
15407 * rendering engine.
15409 * @param item item with custom (custom) cursor already set on
15410 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15411 * only on those provided by the rendering engine, @c EINA_FALSE to
15412 * have them searched on the widget's theme, as well.
15414 * @note This call is of use only if you've set a custom cursor
15415 * for toolbar items, with elm_toolbar_item_cursor_set().
15417 * @note By default, cursors will only be looked for between those
15418 * provided by the rendering engine.
15422 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15425 * Get if the (custom) cursor for a given toolbar item is being
15426 * searched in its theme, also, or is only relying on the rendering
15429 * @param item a toolbar item
15430 * @return @c EINA_TRUE, if cursors are being looked for only on
15431 * those provided by the rendering engine, @c EINA_FALSE if they
15432 * are being searched on the widget's theme, as well.
15434 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15438 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15441 * Change a toolbar's orientation
15442 * @param obj The toolbar object
15443 * @param vertical If @c EINA_TRUE, the toolbar is vertical
15444 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15446 * @deprecated use elm_toolbar_horizontal_set() instead.
15448 EINA_DEPRECATED EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15451 * Change a toolbar's orientation
15452 * @param obj The toolbar object
15453 * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15454 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15457 EAPI void elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15460 * Get a toolbar's orientation
15461 * @param obj The toolbar object
15462 * @return If @c EINA_TRUE, the toolbar is vertical
15463 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15465 * @deprecated use elm_toolbar_horizontal_get() instead.
15467 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15470 * Get a toolbar's orientation
15471 * @param obj The toolbar object
15472 * @return If @c EINA_TRUE, the toolbar is horizontal
15473 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15476 EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15482 * @defgroup Tooltips Tooltips
15484 * The Tooltip is an (internal, for now) smart object used to show a
15485 * content in a frame on mouse hover of objects(or widgets), with
15486 * tips/information about them.
15491 EAPI double elm_tooltip_delay_get(void);
15492 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
15493 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15494 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15495 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15496 EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15497 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15498 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);
15499 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15500 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15501 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15504 * @defgroup Cursors Cursors
15506 * The Elementary cursor is an internal smart object used to
15507 * customize the mouse cursor displayed over objects (or
15508 * widgets). In the most common scenario, the cursor decoration
15509 * comes from the graphical @b engine Elementary is running
15510 * on. Those engines may provide different decorations for cursors,
15511 * and Elementary provides functions to choose them (think of X11
15512 * cursors, as an example).
15514 * There's also the possibility of, besides using engine provided
15515 * cursors, also use ones coming from Edje theming files. Both
15516 * globally and per widget, Elementary makes it possible for one to
15517 * make the cursors lookup to be held on engines only or on
15518 * Elementary's theme file, too. To set cursor's hot spot,
15519 * two data items should be added to cursor's theme: "hot_x" and
15520 * "hot_y", that are the offset from upper-left corner of the cursor
15521 * (coordinates 0,0).
15527 * Set the cursor to be shown when mouse is over the object
15529 * Set the cursor that will be displayed when mouse is over the
15530 * object. The object can have only one cursor set to it, so if
15531 * this function is called twice for an object, the previous set
15533 * If using X cursors, a definition of all the valid cursor names
15534 * is listed on Elementary_Cursors.h. If an invalid name is set
15535 * the default cursor will be used.
15537 * @param obj the object being set a cursor.
15538 * @param cursor the cursor name to be used.
15542 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15545 * Get the cursor to be shown when mouse is over the object
15547 * @param obj an object with cursor already set.
15548 * @return the cursor name.
15552 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15555 * Unset cursor for object
15557 * Unset cursor for object, and set the cursor to default if the mouse
15558 * was over this object.
15560 * @param obj Target object
15561 * @see elm_object_cursor_set()
15565 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15568 * Sets a different style for this object cursor.
15570 * @note before you set a style you should define a cursor with
15571 * elm_object_cursor_set()
15573 * @param obj an object with cursor already set.
15574 * @param style the theme style to use (default, transparent, ...)
15578 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15581 * Get the style for this object cursor.
15583 * @param obj an object with cursor already set.
15584 * @return style the theme style in use, defaults to "default". If the
15585 * object does not have a cursor set, then NULL is returned.
15589 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15592 * Set if the cursor set should be searched on the theme or should use
15593 * the provided by the engine, only.
15595 * @note before you set if should look on theme you should define a cursor
15596 * with elm_object_cursor_set(). By default it will only look for cursors
15597 * provided by the engine.
15599 * @param obj an object with cursor already set.
15600 * @param engine_only boolean to define it cursors should be looked only
15601 * between the provided by the engine or searched on widget's theme as well.
15605 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15608 * Get the cursor engine only usage for this object cursor.
15610 * @param obj an object with cursor already set.
15611 * @return engine_only boolean to define it cursors should be
15612 * looked only between the provided by the engine or searched on
15613 * widget's theme as well. If the object does not have a cursor
15614 * set, then EINA_FALSE is returned.
15618 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15621 * Get the configured cursor engine only usage
15623 * This gets the globally configured exclusive usage of engine cursors.
15625 * @return 1 if only engine cursors should be used
15628 EAPI int elm_cursor_engine_only_get(void);
15631 * Set the configured cursor engine only usage
15633 * This sets the globally configured exclusive usage of engine cursors.
15634 * It won't affect cursors set before changing this value.
15636 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15637 * look for them on theme before.
15638 * @return EINA_TRUE if value is valid and setted (0 or 1)
15641 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
15648 * @defgroup Menu Menu
15650 * @image html img/widget/menu/preview-00.png
15651 * @image latex img/widget/menu/preview-00.eps
15653 * A menu is a list of items displayed above its parent. When the menu is
15654 * showing its parent is darkened. Each item can have a sub-menu. The menu
15655 * object can be used to display a menu on a right click event, in a toolbar,
15658 * Signals that you can add callbacks for are:
15659 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15660 * event_info is NULL.
15662 * @see @ref tutorial_menu
15665 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15667 * @brief Add a new menu to the parent
15669 * @param parent The parent object.
15670 * @return The new object or NULL if it cannot be created.
15672 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15674 * @brief Set the parent for the given menu widget
15676 * @param obj The menu object.
15677 * @param parent The new parent.
15679 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15681 * @brief Get the parent for the given menu widget
15683 * @param obj The menu object.
15684 * @return The parent.
15686 * @see elm_menu_parent_set()
15688 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15690 * @brief Move the menu to a new position
15692 * @param obj The menu object.
15693 * @param x The new position.
15694 * @param y The new position.
15696 * Sets the top-left position of the menu to (@p x,@p y).
15698 * @note @p x and @p y coordinates are relative to parent.
15700 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15702 * @brief Close a opened menu
15704 * @param obj the menu object
15707 * Hides the menu and all it's sub-menus.
15709 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15711 * @brief Returns a list of @p item's items.
15713 * @param obj The menu object
15714 * @return An Eina_List* of @p item's items
15716 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15718 * @brief Get the Evas_Object of an Elm_Menu_Item
15720 * @param item The menu item object.
15721 * @return The edje object containing the swallowed content
15723 * @warning Don't manipulate this object!
15725 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15727 * @brief Add an item at the end of the given menu widget
15729 * @param obj The menu object.
15730 * @param parent The parent menu item (optional)
15731 * @param icon A icon display on the item. The icon will be destryed by the menu.
15732 * @param label The label of the item.
15733 * @param func Function called when the user select the item.
15734 * @param data Data sent by the callback.
15735 * @return Returns the new item.
15737 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);
15739 * @brief Add an object swallowed in an item at the end of the given menu
15742 * @param obj The menu object.
15743 * @param parent The parent menu item (optional)
15744 * @param subobj The object to swallow
15745 * @param func Function called when the user select the item.
15746 * @param data Data sent by the callback.
15747 * @return Returns the new item.
15749 * Add an evas object as an item to the menu.
15751 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);
15753 * @brief Set the label of a menu item
15755 * @param item The menu item object.
15756 * @param label The label to set for @p item
15758 * @warning Don't use this funcion on items created with
15759 * elm_menu_item_add_object() or elm_menu_item_separator_add().
15761 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15763 * @brief Get the label of a menu item
15765 * @param item The menu item object.
15766 * @return The label of @p item
15768 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15770 * @brief Set the icon of a menu item to the standard icon with name @p icon
15772 * @param item The menu item object.
15773 * @param icon The icon object to set for the content of @p item
15775 * Once this icon is set, any previously set icon will be deleted.
15777 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
15779 * @brief Get the string representation from the icon of a menu item
15781 * @param item The menu item object.
15782 * @return The string representation of @p item's icon or NULL
15784 * @see elm_menu_item_object_icon_name_set()
15786 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15788 * @brief Set the content object of a menu item
15790 * @param item The menu item object
15791 * @param The content object or NULL
15792 * @return EINA_TRUE on success, else EINA_FALSE
15794 * Use this function to change the object swallowed by a menu item, deleting
15795 * any previously swallowed object.
15797 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
15799 * @brief Get the content object of a menu item
15801 * @param item The menu item object
15802 * @return The content object or NULL
15803 * @note If @p item was added with elm_menu_item_add_object, this
15804 * function will return the object passed, else it will return the
15807 * @see elm_menu_item_object_content_set()
15809 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15811 EINA_DEPRECATED extern inline void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2)
15813 elm_menu_item_object_icon_name_set(item, icon);
15816 EINA_DEPRECATED extern inline Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1)
15818 return elm_menu_item_object_content_get(item);
15821 EINA_DEPRECATED extern inline const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1)
15823 return elm_menu_item_object_icon_name_get(item);
15827 * @brief Set the selected state of @p item.
15829 * @param item The menu item object.
15830 * @param selected The selected/unselected state of the item
15832 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15834 * @brief Get the selected state of @p item.
15836 * @param item The menu item object.
15837 * @return The selected/unselected state of the item
15839 * @see elm_menu_item_selected_set()
15841 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15843 * @brief Set the disabled state of @p item.
15845 * @param item The menu item object.
15846 * @param disabled The enabled/disabled state of the item
15848 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15850 * @brief Get the disabled state of @p item.
15852 * @param item The menu item object.
15853 * @return The enabled/disabled state of the item
15855 * @see elm_menu_item_disabled_set()
15857 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15859 * @brief Add a separator item to menu @p obj under @p parent.
15861 * @param obj The menu object
15862 * @param parent The item to add the separator under
15863 * @return The created item or NULL on failure
15865 * This is item is a @ref Separator.
15867 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
15869 * @brief Returns whether @p item is a separator.
15871 * @param item The item to check
15872 * @return If true, @p item is a separator
15874 * @see elm_menu_item_separator_add()
15876 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15878 * @brief Deletes an item from the menu.
15880 * @param item The item to delete.
15882 * @see elm_menu_item_add()
15884 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15886 * @brief Set the function called when a menu item is deleted.
15888 * @param item The item to set the callback on
15889 * @param func The function called
15891 * @see elm_menu_item_add()
15892 * @see elm_menu_item_del()
15894 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15896 * @brief Returns the data associated with menu item @p item.
15898 * @param item The item
15899 * @return The data associated with @p item or NULL if none was set.
15901 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
15903 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15905 * @brief Sets the data to be associated with menu item @p item.
15907 * @param item The item
15908 * @param data The data to be associated with @p item
15910 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
15912 * @brief Returns a list of @p item's subitems.
15914 * @param item The item
15915 * @return An Eina_List* of @p item's subitems
15917 * @see elm_menu_add()
15919 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15921 * @brief Get the position of a menu item
15923 * @param item The menu item
15924 * @return The item's index
15926 * This function returns the index position of a menu item in a menu.
15927 * For a sub-menu, this number is relative to the first item in the sub-menu.
15929 * @note Index values begin with 0
15931 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
15933 * @brief @brief Return a menu item's owner menu
15935 * @param item The menu item
15936 * @return The menu object owning @p item, or NULL on failure
15938 * Use this function to get the menu object owning an item.
15940 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
15942 * @brief Get the selected item in the menu
15944 * @param obj The menu object
15945 * @return The selected item, or NULL if none
15947 * @see elm_menu_item_selected_get()
15948 * @see elm_menu_item_selected_set()
15950 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15952 * @brief Get the last item in the menu
15954 * @param obj The menu object
15955 * @return The last item, or NULL if none
15957 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15959 * @brief Get the first item in the menu
15961 * @param obj The menu object
15962 * @return The first item, or NULL if none
15964 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15966 * @brief Get the next item in the menu.
15968 * @param item The menu item object.
15969 * @return The item after it, or NULL if none
15971 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15973 * @brief Get the previous item in the menu.
15975 * @param item The menu item object.
15976 * @return The item before it, or NULL if none
15978 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15984 * @defgroup List List
15985 * @ingroup Elementary
15987 * @image html img/widget/list/preview-00.png
15988 * @image latex img/widget/list/preview-00.eps width=\textwidth
15990 * @image html img/list.png
15991 * @image latex img/list.eps width=\textwidth
15993 * A list widget is a container whose children are displayed vertically or
15994 * horizontally, in order, and can be selected.
15995 * The list can accept only one or multiple items selection. Also has many
15996 * modes of items displaying.
15998 * A list is a very simple type of list widget. For more robust
15999 * lists, @ref Genlist should probably be used.
16001 * Smart callbacks one can listen to:
16002 * - @c "activated" - The user has double-clicked or pressed
16003 * (enter|return|spacebar) on an item. The @c event_info parameter
16004 * is the item that was activated.
16005 * - @c "clicked,double" - The user has double-clicked an item.
16006 * The @c event_info parameter is the item that was double-clicked.
16007 * - "selected" - when the user selected an item
16008 * - "unselected" - when the user unselected an item
16009 * - "longpressed" - an item in the list is long-pressed
16010 * - "edge,top" - the list is scrolled until the top edge
16011 * - "edge,bottom" - the list is scrolled until the bottom edge
16012 * - "edge,left" - the list is scrolled until the left edge
16013 * - "edge,right" - the list is scrolled until the right edge
16014 * - "language,changed" - the program's language changed
16016 * Available styles for it:
16019 * List of examples:
16020 * @li @ref list_example_01
16021 * @li @ref list_example_02
16022 * @li @ref list_example_03
16031 * @enum _Elm_List_Mode
16032 * @typedef Elm_List_Mode
16034 * Set list's resize behavior, transverse axis scroll and
16035 * items cropping. See each mode's description for more details.
16037 * @note Default value is #ELM_LIST_SCROLL.
16039 * Values <b> don't </b> work as bitmask, only one can be choosen.
16041 * @see elm_list_mode_set()
16042 * @see elm_list_mode_get()
16046 typedef enum _Elm_List_Mode
16048 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. */
16049 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). */
16050 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. */
16051 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. */
16052 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16055 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(). */
16058 * Add a new list widget to the given parent Elementary
16059 * (container) object.
16061 * @param parent The parent object.
16062 * @return a new list widget handle or @c NULL, on errors.
16064 * This function inserts a new list widget on the canvas.
16068 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16073 * @param obj The list object
16075 * @note Call before running show() on the list object.
16076 * @warning If not called, it won't display the list properly.
16079 * li = elm_list_add(win);
16080 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16081 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16083 * evas_object_show(li);
16088 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16091 * Enable or disable multiple items selection on the list object.
16093 * @param obj The list object
16094 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16097 * Disabled by default. If disabled, the user can select a single item of
16098 * the list each time. Selected items are highlighted on list.
16099 * If enabled, many items can be selected.
16101 * If a selected item is selected again, it will be unselected.
16103 * @see elm_list_multi_select_get()
16107 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16110 * Get a value whether multiple items selection is enabled or not.
16112 * @see elm_list_multi_select_set() for details.
16114 * @param obj The list object.
16115 * @return @c EINA_TRUE means multiple items selection is enabled.
16116 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16117 * @c EINA_FALSE is returned.
16121 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16124 * Set which mode to use for the list object.
16126 * @param obj The list object
16127 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16128 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16130 * Set list's resize behavior, transverse axis scroll and
16131 * items cropping. See each mode's description for more details.
16133 * @note Default value is #ELM_LIST_SCROLL.
16135 * Only one can be set, if a previous one was set, it will be changed
16136 * by the new mode set. Bitmask won't work as well.
16138 * @see elm_list_mode_get()
16142 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16145 * Get the mode the list is at.
16147 * @param obj The list object
16148 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16149 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16151 * @note see elm_list_mode_set() for more information.
16155 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16158 * Enable or disable horizontal mode on the list object.
16160 * @param obj The list object.
16161 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16162 * disable it, i.e., to enable vertical mode.
16164 * @note Vertical mode is set by default.
16166 * On horizontal mode items are displayed on list from left to right,
16167 * instead of from top to bottom. Also, the list will scroll horizontally.
16168 * Each item will presents left icon on top and right icon, or end, at
16171 * @see elm_list_horizontal_get()
16175 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16178 * Get a value whether horizontal mode is enabled or not.
16180 * @param obj The list object.
16181 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16182 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16183 * @c EINA_FALSE is returned.
16185 * @see elm_list_horizontal_set() for details.
16189 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16192 * Enable or disable always select mode on the list object.
16194 * @param obj The list object
16195 * @param always_select @c EINA_TRUE to enable always select mode or
16196 * @c EINA_FALSE to disable it.
16198 * @note Always select mode is disabled by default.
16200 * Default behavior of list items is to only call its callback function
16201 * the first time it's pressed, i.e., when it is selected. If a selected
16202 * item is pressed again, and multi-select is disabled, it won't call
16203 * this function (if multi-select is enabled it will unselect the item).
16205 * If always select is enabled, it will call the callback function
16206 * everytime a item is pressed, so it will call when the item is selected,
16207 * and again when a selected item is pressed.
16209 * @see elm_list_always_select_mode_get()
16210 * @see elm_list_multi_select_set()
16214 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16217 * Get a value whether always select mode is enabled or not, meaning that
16218 * an item will always call its callback function, even if already selected.
16220 * @param obj The list object
16221 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16222 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16223 * @c EINA_FALSE is returned.
16225 * @see elm_list_always_select_mode_set() for details.
16229 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16232 * Set bouncing behaviour when the scrolled content reaches an edge.
16234 * Tell the internal scroller object whether it should bounce or not
16235 * when it reaches the respective edges for each axis.
16237 * @param obj The list object
16238 * @param h_bounce Whether to bounce or not in the horizontal axis.
16239 * @param v_bounce Whether to bounce or not in the vertical axis.
16241 * @see elm_scroller_bounce_set()
16245 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16248 * Get the bouncing behaviour of the internal scroller.
16250 * Get whether the internal scroller should bounce when the edge of each
16251 * axis is reached scrolling.
16253 * @param obj The list object.
16254 * @param h_bounce Pointer where to store the bounce state of the horizontal
16256 * @param v_bounce Pointer where to store the bounce state of the vertical
16259 * @see elm_scroller_bounce_get()
16260 * @see elm_list_bounce_set()
16264 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16267 * Set the scrollbar policy.
16269 * @param obj The list object
16270 * @param policy_h Horizontal scrollbar policy.
16271 * @param policy_v Vertical scrollbar policy.
16273 * This sets the scrollbar visibility policy for the given scroller.
16274 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16275 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16276 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16277 * This applies respectively for the horizontal and vertical scrollbars.
16279 * The both are disabled by default, i.e., are set to
16280 * #ELM_SCROLLER_POLICY_OFF.
16284 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16287 * Get the scrollbar policy.
16289 * @see elm_list_scroller_policy_get() for details.
16291 * @param obj The list object.
16292 * @param policy_h Pointer where to store horizontal scrollbar policy.
16293 * @param policy_v Pointer where to store vertical scrollbar policy.
16297 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);
16300 * Append a new item to the list object.
16302 * @param obj The list object.
16303 * @param label The label of the list item.
16304 * @param icon The icon object to use for the left side of the item. An
16305 * icon can be any Evas object, but usually it is an icon created
16306 * with elm_icon_add().
16307 * @param end The icon object to use for the right side of the item. An
16308 * icon can be any Evas object.
16309 * @param func The function to call when the item is clicked.
16310 * @param data The data to associate with the item for related callbacks.
16312 * @return The created item or @c NULL upon failure.
16314 * A new item will be created and appended to the list, i.e., will
16315 * be set as @b last item.
16317 * Items created with this method can be deleted with
16318 * elm_list_item_del().
16320 * Associated @p data can be properly freed when item is deleted if a
16321 * callback function is set with elm_list_item_del_cb_set().
16323 * If a function is passed as argument, it will be called everytime this item
16324 * is selected, i.e., the user clicks over an unselected item.
16325 * If always select is enabled it will call this function every time
16326 * user clicks over an item (already selected or not).
16327 * If such function isn't needed, just passing
16328 * @c NULL as @p func is enough. The same should be done for @p data.
16330 * Simple example (with no function callback or data associated):
16332 * li = elm_list_add(win);
16333 * ic = elm_icon_add(win);
16334 * elm_icon_file_set(ic, "path/to/image", NULL);
16335 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16336 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16338 * evas_object_show(li);
16341 * @see elm_list_always_select_mode_set()
16342 * @see elm_list_item_del()
16343 * @see elm_list_item_del_cb_set()
16344 * @see elm_list_clear()
16345 * @see elm_icon_add()
16349 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);
16352 * Prepend a new item to the list object.
16354 * @param obj The list object.
16355 * @param label The label of the list item.
16356 * @param icon The icon object to use for the left side of the item. An
16357 * icon can be any Evas object, but usually it is an icon created
16358 * with elm_icon_add().
16359 * @param end The icon object to use for the right side of the item. An
16360 * icon can be any Evas object.
16361 * @param func The function to call when the item is clicked.
16362 * @param data The data to associate with the item for related callbacks.
16364 * @return The created item or @c NULL upon failure.
16366 * A new item will be created and prepended to the list, i.e., will
16367 * be set as @b first item.
16369 * Items created with this method can be deleted with
16370 * elm_list_item_del().
16372 * Associated @p data can be properly freed when item is deleted if a
16373 * callback function is set with elm_list_item_del_cb_set().
16375 * If a function is passed as argument, it will be called everytime this item
16376 * is selected, i.e., the user clicks over an unselected item.
16377 * If always select is enabled it will call this function every time
16378 * user clicks over an item (already selected or not).
16379 * If such function isn't needed, just passing
16380 * @c NULL as @p func is enough. The same should be done for @p data.
16382 * @see elm_list_item_append() for a simple code example.
16383 * @see elm_list_always_select_mode_set()
16384 * @see elm_list_item_del()
16385 * @see elm_list_item_del_cb_set()
16386 * @see elm_list_clear()
16387 * @see elm_icon_add()
16391 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);
16394 * Insert a new item into the list object before item @p before.
16396 * @param obj The list object.
16397 * @param before The list item to insert before.
16398 * @param label The label of the list item.
16399 * @param icon The icon object to use for the left side of the item. An
16400 * icon can be any Evas object, but usually it is an icon created
16401 * with elm_icon_add().
16402 * @param end The icon object to use for the right side of the item. An
16403 * icon can be any Evas object.
16404 * @param func The function to call when the item is clicked.
16405 * @param data The data to associate with the item for related callbacks.
16407 * @return The created item or @c NULL upon failure.
16409 * A new item will be created and added to the list. Its position in
16410 * this list will be just before item @p before.
16412 * Items created with this method can be deleted with
16413 * elm_list_item_del().
16415 * Associated @p data can be properly freed when item is deleted if a
16416 * callback function is set with elm_list_item_del_cb_set().
16418 * If a function is passed as argument, it will be called everytime this item
16419 * is selected, i.e., the user clicks over an unselected item.
16420 * If always select is enabled it will call this function every time
16421 * user clicks over an item (already selected or not).
16422 * If such function isn't needed, just passing
16423 * @c NULL as @p func is enough. The same should be done for @p data.
16425 * @see elm_list_item_append() for a simple code example.
16426 * @see elm_list_always_select_mode_set()
16427 * @see elm_list_item_del()
16428 * @see elm_list_item_del_cb_set()
16429 * @see elm_list_clear()
16430 * @see elm_icon_add()
16434 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);
16437 * Insert a new item into the list object after item @p after.
16439 * @param obj The list object.
16440 * @param after The list item to insert after.
16441 * @param label The label of the list item.
16442 * @param icon The icon object to use for the left side of the item. An
16443 * icon can be any Evas object, but usually it is an icon created
16444 * with elm_icon_add().
16445 * @param end The icon object to use for the right side of the item. An
16446 * icon can be any Evas object.
16447 * @param func The function to call when the item is clicked.
16448 * @param data The data to associate with the item for related callbacks.
16450 * @return The created item or @c NULL upon failure.
16452 * A new item will be created and added to the list. Its position in
16453 * this list will be just after item @p after.
16455 * Items created with this method can be deleted with
16456 * elm_list_item_del().
16458 * Associated @p data can be properly freed when item is deleted if a
16459 * callback function is set with elm_list_item_del_cb_set().
16461 * If a function is passed as argument, it will be called everytime this item
16462 * is selected, i.e., the user clicks over an unselected item.
16463 * If always select is enabled it will call this function every time
16464 * user clicks over an item (already selected or not).
16465 * If such function isn't needed, just passing
16466 * @c NULL as @p func is enough. The same should be done for @p data.
16468 * @see elm_list_item_append() for a simple code example.
16469 * @see elm_list_always_select_mode_set()
16470 * @see elm_list_item_del()
16471 * @see elm_list_item_del_cb_set()
16472 * @see elm_list_clear()
16473 * @see elm_icon_add()
16477 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);
16480 * Insert a new item into the sorted list object.
16482 * @param obj The list object.
16483 * @param label The label of the list item.
16484 * @param icon The icon object to use for the left side of the item. An
16485 * icon can be any Evas object, but usually it is an icon created
16486 * with elm_icon_add().
16487 * @param end The icon object to use for the right side of the item. An
16488 * icon can be any Evas object.
16489 * @param func The function to call when the item is clicked.
16490 * @param data The data to associate with the item for related callbacks.
16491 * @param cmp_func The comparing function to be used to sort list
16492 * items <b>by #Elm_List_Item item handles</b>. This function will
16493 * receive two items and compare them, returning a non-negative integer
16494 * if the second item should be place after the first, or negative value
16495 * if should be placed before.
16497 * @return The created item or @c NULL upon failure.
16499 * @note This function inserts values into a list object assuming it was
16500 * sorted and the result will be sorted.
16502 * A new item will be created and added to the list. Its position in
16503 * this list will be found comparing the new item with previously inserted
16504 * items using function @p cmp_func.
16506 * Items created with this method can be deleted with
16507 * elm_list_item_del().
16509 * Associated @p data can be properly freed when item is deleted if a
16510 * callback function is set with elm_list_item_del_cb_set().
16512 * If a function is passed as argument, it will be called everytime this item
16513 * is selected, i.e., the user clicks over an unselected item.
16514 * If always select is enabled it will call this function every time
16515 * user clicks over an item (already selected or not).
16516 * If such function isn't needed, just passing
16517 * @c NULL as @p func is enough. The same should be done for @p data.
16519 * @see elm_list_item_append() for a simple code example.
16520 * @see elm_list_always_select_mode_set()
16521 * @see elm_list_item_del()
16522 * @see elm_list_item_del_cb_set()
16523 * @see elm_list_clear()
16524 * @see elm_icon_add()
16528 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);
16531 * Remove all list's items.
16533 * @param obj The list object
16535 * @see elm_list_item_del()
16536 * @see elm_list_item_append()
16540 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16543 * Get a list of all the list items.
16545 * @param obj The list object
16546 * @return An @c Eina_List of list items, #Elm_List_Item,
16547 * or @c NULL on failure.
16549 * @see elm_list_item_append()
16550 * @see elm_list_item_del()
16551 * @see elm_list_clear()
16555 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16558 * Get the selected item.
16560 * @param obj The list object.
16561 * @return The selected list item.
16563 * The selected item can be unselected with function
16564 * elm_list_item_selected_set().
16566 * The selected item always will be highlighted on list.
16568 * @see elm_list_selected_items_get()
16572 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16575 * Return a list of the currently selected list items.
16577 * @param obj The list object.
16578 * @return An @c Eina_List of list items, #Elm_List_Item,
16579 * or @c NULL on failure.
16581 * Multiple items can be selected if multi select is enabled. It can be
16582 * done with elm_list_multi_select_set().
16584 * @see elm_list_selected_item_get()
16585 * @see elm_list_multi_select_set()
16589 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16592 * Set the selected state of an item.
16594 * @param item The list item
16595 * @param selected The selected state
16597 * This sets the selected state of the given item @p it.
16598 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16600 * If a new item is selected the previosly selected will be unselected,
16601 * unless multiple selection is enabled with elm_list_multi_select_set().
16602 * Previoulsy selected item can be get with function
16603 * elm_list_selected_item_get().
16605 * Selected items will be highlighted.
16607 * @see elm_list_item_selected_get()
16608 * @see elm_list_selected_item_get()
16609 * @see elm_list_multi_select_set()
16613 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16616 * Get whether the @p item is selected or not.
16618 * @param item The list item.
16619 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16620 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16622 * @see elm_list_selected_item_set() for details.
16623 * @see elm_list_item_selected_get()
16627 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16630 * Set or unset item as a separator.
16632 * @param it The list item.
16633 * @param setting @c EINA_TRUE to set item @p it as separator or
16634 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16636 * Items aren't set as separator by default.
16638 * If set as separator it will display separator theme, so won't display
16641 * @see elm_list_item_separator_get()
16645 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16648 * Get a value whether item is a separator or not.
16650 * @see elm_list_item_separator_set() for details.
16652 * @param it The list item.
16653 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16654 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16658 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16661 * Show @p item in the list view.
16663 * @param item The list item to be shown.
16665 * It won't animate list until item is visible. If such behavior is wanted,
16666 * use elm_list_bring_in() intead.
16670 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16673 * Bring in the given item to list view.
16675 * @param item The item.
16677 * This causes list to jump to the given item @p item and show it
16678 * (by scrolling), if it is not fully visible.
16680 * This may use animation to do so and take a period of time.
16682 * If animation isn't wanted, elm_list_item_show() can be used.
16686 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16689 * Delete them item from the list.
16691 * @param item The item of list to be deleted.
16693 * If deleting all list items is required, elm_list_clear()
16694 * should be used instead of getting items list and deleting each one.
16696 * @see elm_list_clear()
16697 * @see elm_list_item_append()
16698 * @see elm_list_item_del_cb_set()
16702 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16705 * Set the function called when a list item is freed.
16707 * @param item The item to set the callback on
16708 * @param func The function called
16710 * If there is a @p func, then it will be called prior item's memory release.
16711 * That will be called with the following arguments:
16713 * @li item's Evas object;
16716 * This way, a data associated to a list item could be properly freed.
16720 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16723 * Get the data associated to the item.
16725 * @param item The list item
16726 * @return The data associated to @p item
16728 * The return value is a pointer to data associated to @p item when it was
16729 * created, with function elm_list_item_append() or similar. If no data
16730 * was passed as argument, it will return @c NULL.
16732 * @see elm_list_item_append()
16736 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16739 * Get the left side icon associated to the item.
16741 * @param item The list item
16742 * @return The left side icon associated to @p item
16744 * The return value is a pointer to the icon associated to @p item when
16746 * created, with function elm_list_item_append() or similar, or later
16747 * with function elm_list_item_icon_set(). If no icon
16748 * was passed as argument, it will return @c NULL.
16750 * @see elm_list_item_append()
16751 * @see elm_list_item_icon_set()
16755 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16758 * Set the left side icon associated to the item.
16760 * @param item The list item
16761 * @param icon The left side icon object to associate with @p item
16763 * The icon object to use at left side of the item. An
16764 * icon can be any Evas object, but usually it is an icon created
16765 * with elm_icon_add().
16767 * Once the icon object is set, a previously set one will be deleted.
16768 * @warning Setting the same icon for two items will cause the icon to
16769 * dissapear from the first item.
16771 * If an icon was passed as argument on item creation, with function
16772 * elm_list_item_append() or similar, it will be already
16773 * associated to the item.
16775 * @see elm_list_item_append()
16776 * @see elm_list_item_icon_get()
16780 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16783 * Get the right side icon associated to the item.
16785 * @param item The list item
16786 * @return The right side icon associated to @p item
16788 * The return value is a pointer to the icon associated to @p item when
16790 * created, with function elm_list_item_append() or similar, or later
16791 * with function elm_list_item_icon_set(). If no icon
16792 * was passed as argument, it will return @c NULL.
16794 * @see elm_list_item_append()
16795 * @see elm_list_item_icon_set()
16799 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16802 * Set the right side icon associated to the item.
16804 * @param item The list item
16805 * @param end The right side icon object to associate with @p item
16807 * The icon object to use at right side of the item. An
16808 * icon can be any Evas object, but usually it is an icon created
16809 * with elm_icon_add().
16811 * Once the icon object is set, a previously set one will be deleted.
16812 * @warning Setting the same icon for two items will cause the icon to
16813 * dissapear from the first item.
16815 * If an icon was passed as argument on item creation, with function
16816 * elm_list_item_append() or similar, it will be already
16817 * associated to the item.
16819 * @see elm_list_item_append()
16820 * @see elm_list_item_end_get()
16824 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
16825 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16828 * Gets the base object of the item.
16830 * @param item The list item
16831 * @return The base object associated with @p item
16833 * Base object is the @c Evas_Object that represents that item.
16837 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16840 * Get the label of item.
16842 * @param item The item of list.
16843 * @return The label of item.
16845 * The return value is a pointer to the label associated to @p item when
16846 * it was created, with function elm_list_item_append(), or later
16847 * with function elm_list_item_label_set. If no label
16848 * was passed as argument, it will return @c NULL.
16850 * @see elm_list_item_label_set() for more details.
16851 * @see elm_list_item_append()
16855 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16858 * Set the label of item.
16860 * @param item The item of list.
16861 * @param text The label of item.
16863 * The label to be displayed by the item.
16864 * Label will be placed between left and right side icons (if set).
16866 * If a label was passed as argument on item creation, with function
16867 * elm_list_item_append() or similar, it will be already
16868 * displayed by the item.
16870 * @see elm_list_item_label_get()
16871 * @see elm_list_item_append()
16875 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16879 * Get the item before @p it in list.
16881 * @param it The list item.
16882 * @return The item before @p it, or @c NULL if none or on failure.
16884 * @note If it is the first item, @c NULL will be returned.
16886 * @see elm_list_item_append()
16887 * @see elm_list_items_get()
16891 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16894 * Get the item after @p it in list.
16896 * @param it The list item.
16897 * @return The item after @p it, or @c NULL if none or on failure.
16899 * @note If it is the last item, @c NULL will be returned.
16901 * @see elm_list_item_append()
16902 * @see elm_list_items_get()
16906 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16909 * Sets the disabled/enabled state of a list item.
16911 * @param it The item.
16912 * @param disabled The disabled state.
16914 * A disabled item cannot be selected or unselected. It will also
16915 * change its appearance (generally greyed out). This sets the
16916 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
16921 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16924 * Get a value whether list item is disabled or not.
16926 * @param it The item.
16927 * @return The disabled state.
16929 * @see elm_list_item_disabled_set() for more details.
16933 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16936 * Set the text to be shown in a given list item's tooltips.
16938 * @param item Target item.
16939 * @param text The text to set in the content.
16941 * Setup the text as tooltip to object. The item can have only one tooltip,
16942 * so any previous tooltip data - set with this function or
16943 * elm_list_item_tooltip_content_cb_set() - is removed.
16945 * @see elm_object_tooltip_text_set() for more details.
16949 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16953 * @brief Disable size restrictions on an object's tooltip
16954 * @param item The tooltip's anchor object
16955 * @param disable If EINA_TRUE, size restrictions are disabled
16956 * @return EINA_FALSE on failure, EINA_TRUE on success
16958 * This function allows a tooltip to expand beyond its parant window's canvas.
16959 * It will instead be limited only by the size of the display.
16961 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
16963 * @brief Retrieve size restriction state of an object's tooltip
16964 * @param obj The tooltip's anchor object
16965 * @return If EINA_TRUE, size restrictions are disabled
16967 * This function returns whether a tooltip is allowed to expand beyond
16968 * its parant window's canvas.
16969 * It will instead be limited only by the size of the display.
16971 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16974 * Set the content to be shown in the tooltip item.
16976 * Setup the tooltip to item. The item can have only one tooltip,
16977 * so any previous tooltip data is removed. @p func(with @p data) will
16978 * be called every time that need show the tooltip and it should
16979 * return a valid Evas_Object. This object is then managed fully by
16980 * tooltip system and is deleted when the tooltip is gone.
16982 * @param item the list item being attached a tooltip.
16983 * @param func the function used to create the tooltip contents.
16984 * @param data what to provide to @a func as callback data/context.
16985 * @param del_cb called when data is not needed anymore, either when
16986 * another callback replaces @a func, the tooltip is unset with
16987 * elm_list_item_tooltip_unset() or the owner @a item
16988 * dies. This callback receives as the first parameter the
16989 * given @a data, and @c event_info is the item.
16991 * @see elm_object_tooltip_content_cb_set() for more details.
16995 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);
16998 * Unset tooltip from item.
17000 * @param item list item to remove previously set tooltip.
17002 * Remove tooltip from item. The callback provided as del_cb to
17003 * elm_list_item_tooltip_content_cb_set() will be called to notify
17004 * it is not used anymore.
17006 * @see elm_object_tooltip_unset() for more details.
17007 * @see elm_list_item_tooltip_content_cb_set()
17011 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17014 * Sets a different style for this item tooltip.
17016 * @note before you set a style you should define a tooltip with
17017 * elm_list_item_tooltip_content_cb_set() or
17018 * elm_list_item_tooltip_text_set()
17020 * @param item list item with tooltip already set.
17021 * @param style the theme style to use (default, transparent, ...)
17023 * @see elm_object_tooltip_style_set() for more details.
17027 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17030 * Get the style for this item tooltip.
17032 * @param item list item with tooltip already set.
17033 * @return style the theme style in use, defaults to "default". If the
17034 * object does not have a tooltip set, then NULL is returned.
17036 * @see elm_object_tooltip_style_get() for more details.
17037 * @see elm_list_item_tooltip_style_set()
17041 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17044 * Set the type of mouse pointer/cursor decoration to be shown,
17045 * when the mouse pointer is over the given list widget item
17047 * @param item list item to customize cursor on
17048 * @param cursor the cursor type's name
17050 * This function works analogously as elm_object_cursor_set(), but
17051 * here the cursor's changing area is restricted to the item's
17052 * area, and not the whole widget's. Note that that item cursors
17053 * have precedence over widget cursors, so that a mouse over an
17054 * item with custom cursor set will always show @b that cursor.
17056 * If this function is called twice for an object, a previously set
17057 * cursor will be unset on the second call.
17059 * @see elm_object_cursor_set()
17060 * @see elm_list_item_cursor_get()
17061 * @see elm_list_item_cursor_unset()
17065 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17068 * Get the type of mouse pointer/cursor decoration set to be shown,
17069 * when the mouse pointer is over the given list widget item
17071 * @param item list item with custom cursor set
17072 * @return the cursor type's name or @c NULL, if no custom cursors
17073 * were set to @p item (and on errors)
17075 * @see elm_object_cursor_get()
17076 * @see elm_list_item_cursor_set()
17077 * @see elm_list_item_cursor_unset()
17081 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17084 * Unset any custom mouse pointer/cursor decoration set to be
17085 * shown, when the mouse pointer is over the given list widget
17086 * item, thus making it show the @b default cursor again.
17088 * @param item a list item
17090 * Use this call to undo any custom settings on this item's cursor
17091 * decoration, bringing it back to defaults (no custom style set).
17093 * @see elm_object_cursor_unset()
17094 * @see elm_list_item_cursor_set()
17098 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17101 * Set a different @b style for a given custom cursor set for a
17104 * @param item list item with custom cursor set
17105 * @param style the <b>theme style</b> to use (e.g. @c "default",
17106 * @c "transparent", etc)
17108 * This function only makes sense when one is using custom mouse
17109 * cursor decorations <b>defined in a theme file</b>, which can have,
17110 * given a cursor name/type, <b>alternate styles</b> on it. It
17111 * works analogously as elm_object_cursor_style_set(), but here
17112 * applyed only to list item objects.
17114 * @warning Before you set a cursor style you should have definen a
17115 * custom cursor previously on the item, with
17116 * elm_list_item_cursor_set()
17118 * @see elm_list_item_cursor_engine_only_set()
17119 * @see elm_list_item_cursor_style_get()
17123 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17126 * Get the current @b style set for a given list item's custom
17129 * @param item list item with custom cursor set.
17130 * @return style the cursor style in use. If the object does not
17131 * have a cursor set, then @c NULL is returned.
17133 * @see elm_list_item_cursor_style_set() for more details
17137 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17140 * Set if the (custom)cursor for a given list item should be
17141 * searched in its theme, also, or should only rely on the
17142 * rendering engine.
17144 * @param item item with custom (custom) cursor already set on
17145 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17146 * only on those provided by the rendering engine, @c EINA_FALSE to
17147 * have them searched on the widget's theme, as well.
17149 * @note This call is of use only if you've set a custom cursor
17150 * for list items, with elm_list_item_cursor_set().
17152 * @note By default, cursors will only be looked for between those
17153 * provided by the rendering engine.
17157 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17160 * Get if the (custom) cursor for a given list item is being
17161 * searched in its theme, also, or is only relying on the rendering
17164 * @param item a list item
17165 * @return @c EINA_TRUE, if cursors are being looked for only on
17166 * those provided by the rendering engine, @c EINA_FALSE if they
17167 * are being searched on the widget's theme, as well.
17169 * @see elm_list_item_cursor_engine_only_set(), for more details
17173 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17180 * @defgroup Slider Slider
17181 * @ingroup Elementary
17183 * @image html img/widget/slider/preview-00.png
17184 * @image latex img/widget/slider/preview-00.eps width=\textwidth
17186 * The slider adds a dragable “slider” widget for selecting the value of
17187 * something within a range.
17189 * A slider can be horizontal or vertical. It can contain an Icon and has a
17190 * primary label as well as a units label (that is formatted with floating
17191 * point values and thus accepts a printf-style format string, like
17192 * “%1.2f units”. There is also an indicator string that may be somewhere
17193 * else (like on the slider itself) that also accepts a format string like
17194 * units. Label, Icon Unit and Indicator strings/objects are optional.
17196 * A slider may be inverted which means values invert, with high vales being
17197 * on the left or top and low values on the right or bottom (as opposed to
17198 * normally being low on the left or top and high on the bottom and right).
17200 * The slider should have its minimum and maximum values set by the
17201 * application with elm_slider_min_max_set() and value should also be set by
17202 * the application before use with elm_slider_value_set(). The span of the
17203 * slider is its length (horizontally or vertically). This will be scaled by
17204 * the object or applications scaling factor. At any point code can query the
17205 * slider for its value with elm_slider_value_get().
17207 * Smart callbacks one can listen to:
17208 * - "changed" - Whenever the slider value is changed by the user.
17209 * - "slider,drag,start" - dragging the slider indicator around has started.
17210 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17211 * - "delay,changed" - A short time after the value is changed by the user.
17212 * This will be called only when the user stops dragging for
17213 * a very short period or when they release their
17214 * finger/mouse, so it avoids possibly expensive reactions to
17215 * the value change.
17217 * Available styles for it:
17220 * Default contents parts of the slider widget that you can use for are:
17221 * @li "elm.swallow.icon" - A icon of the slider
17222 * @li "elm.swallow.end" - A end part content of the slider
17224 * Here is an example on its usage:
17225 * @li @ref slider_example
17228 #define ELM_SLIDER_CONTENT_ICON "elm.swallow.icon"
17229 #define ELM_SLIDER_CONTENT_END "elm.swallow.end"
17232 * @addtogroup Slider
17237 * Add a new slider widget to the given parent Elementary
17238 * (container) object.
17240 * @param parent The parent object.
17241 * @return a new slider widget handle or @c NULL, on errors.
17243 * This function inserts a new slider widget on the canvas.
17247 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17250 * Set the label of a given slider widget
17252 * @param obj The progress bar object
17253 * @param label The text label string, in UTF-8
17256 * @deprecated use elm_object_text_set() instead.
17258 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17261 * Get the label of a given slider widget
17263 * @param obj The progressbar object
17264 * @return The text label string, in UTF-8
17267 * @deprecated use elm_object_text_get() instead.
17269 EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17272 * Set the icon object of the slider object.
17274 * @param obj The slider object.
17275 * @param icon The icon object.
17277 * On horizontal mode, icon is placed at left, and on vertical mode,
17280 * @note Once the icon object is set, a previously set one will be deleted.
17281 * If you want to keep that old content object, use the
17282 * elm_slider_icon_unset() function.
17284 * @warning If the object being set does not have minimum size hints set,
17285 * it won't get properly displayed.
17288 * @deprecated use elm_object_content_set() instead.
17290 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17293 * Unset an icon set on a given slider widget.
17295 * @param obj The slider object.
17296 * @return The icon object that was being used, if any was set, or
17297 * @c NULL, otherwise (and on errors).
17299 * On horizontal mode, icon is placed at left, and on vertical mode,
17302 * This call will unparent and return the icon object which was set
17303 * for this widget, previously, on success.
17305 * @see elm_slider_icon_set() for more details
17306 * @see elm_slider_icon_get()
17307 * @deprecated use elm_object_content_unset() instead.
17311 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17314 * Retrieve the icon object set for a given slider widget.
17316 * @param obj The slider object.
17317 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17318 * otherwise (and on errors).
17320 * On horizontal mode, icon is placed at left, and on vertical mode,
17323 * @see elm_slider_icon_set() for more details
17324 * @see elm_slider_icon_unset()
17328 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17331 * Set the end object of the slider object.
17333 * @param obj The slider object.
17334 * @param end The end object.
17336 * On horizontal mode, end is placed at left, and on vertical mode,
17337 * placed at bottom.
17339 * @note Once the icon object is set, a previously set one will be deleted.
17340 * If you want to keep that old content object, use the
17341 * elm_slider_end_unset() function.
17343 * @warning If the object being set does not have minimum size hints set,
17344 * it won't get properly displayed.
17348 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17351 * Unset an end object set on a given slider widget.
17353 * @param obj The slider object.
17354 * @return The end object that was being used, if any was set, or
17355 * @c NULL, otherwise (and on errors).
17357 * On horizontal mode, end is placed at left, and on vertical mode,
17358 * placed at bottom.
17360 * This call will unparent and return the icon object which was set
17361 * for this widget, previously, on success.
17363 * @see elm_slider_end_set() for more details.
17364 * @see elm_slider_end_get()
17368 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17371 * Retrieve the end object set for a given slider widget.
17373 * @param obj The slider object.
17374 * @return The end object's handle, if @p obj had one set, or @c NULL,
17375 * otherwise (and on errors).
17377 * On horizontal mode, icon is placed at right, and on vertical mode,
17378 * placed at bottom.
17380 * @see elm_slider_end_set() for more details.
17381 * @see elm_slider_end_unset()
17385 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17388 * Set the (exact) length of the bar region of a given slider widget.
17390 * @param obj The slider object.
17391 * @param size The length of the slider's bar region.
17393 * This sets the minimum width (when in horizontal mode) or height
17394 * (when in vertical mode) of the actual bar area of the slider
17395 * @p obj. This in turn affects the object's minimum size. Use
17396 * this when you're not setting other size hints expanding on the
17397 * given direction (like weight and alignment hints) and you would
17398 * like it to have a specific size.
17400 * @note Icon, end, label, indicator and unit text around @p obj
17401 * will require their
17402 * own space, which will make @p obj to require more the @p size,
17405 * @see elm_slider_span_size_get()
17409 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17412 * Get the length set for the bar region of a given slider widget
17414 * @param obj The slider object.
17415 * @return The length of the slider's bar region.
17417 * If that size was not set previously, with
17418 * elm_slider_span_size_set(), this call will return @c 0.
17422 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17425 * Set the format string for the unit label.
17427 * @param obj The slider object.
17428 * @param format The format string for the unit display.
17430 * Unit label is displayed all the time, if set, after slider's bar.
17431 * In horizontal mode, at right and in vertical mode, at bottom.
17433 * If @c NULL, unit label won't be visible. If not it sets the format
17434 * string for the label text. To the label text is provided a floating point
17435 * value, so the label text can display up to 1 floating point value.
17436 * Note that this is optional.
17438 * Use a format string such as "%1.2f meters" for example, and it will
17439 * display values like: "3.14 meters" for a value equal to 3.14159.
17441 * Default is unit label disabled.
17443 * @see elm_slider_indicator_format_get()
17447 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17450 * Get the unit label format of the slider.
17452 * @param obj The slider object.
17453 * @return The unit label format string in UTF-8.
17455 * Unit label is displayed all the time, if set, after slider's bar.
17456 * In horizontal mode, at right and in vertical mode, at bottom.
17458 * @see elm_slider_unit_format_set() for more
17459 * information on how this works.
17463 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17466 * Set the format string for the indicator label.
17468 * @param obj The slider object.
17469 * @param indicator The format string for the indicator display.
17471 * The slider may display its value somewhere else then unit label,
17472 * for example, above the slider knob that is dragged around. This function
17473 * sets the format string used for this.
17475 * If @c NULL, indicator label won't be visible. If not it sets the format
17476 * string for the label text. To the label text is provided a floating point
17477 * value, so the label text can display up to 1 floating point value.
17478 * Note that this is optional.
17480 * Use a format string such as "%1.2f meters" for example, and it will
17481 * display values like: "3.14 meters" for a value equal to 3.14159.
17483 * Default is indicator label disabled.
17485 * @see elm_slider_indicator_format_get()
17489 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17492 * Get the indicator label format of the slider.
17494 * @param obj The slider object.
17495 * @return The indicator label format string in UTF-8.
17497 * The slider may display its value somewhere else then unit label,
17498 * for example, above the slider knob that is dragged around. This function
17499 * gets the format string used for this.
17501 * @see elm_slider_indicator_format_set() for more
17502 * information on how this works.
17506 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17509 * Set the format function pointer for the indicator label
17511 * @param obj The slider object.
17512 * @param func The indicator format function.
17513 * @param free_func The freeing function for the format string.
17515 * Set the callback function to format the indicator string.
17517 * @see elm_slider_indicator_format_set() for more info on how this works.
17521 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);
17524 * Set the format function pointer for the units label
17526 * @param obj The slider object.
17527 * @param func The units format function.
17528 * @param free_func The freeing function for the format string.
17530 * Set the callback function to format the indicator string.
17532 * @see elm_slider_units_format_set() for more info on how this works.
17536 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);
17539 * Set the orientation of a given slider widget.
17541 * @param obj The slider object.
17542 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17543 * @b horizontal, @c EINA_FALSE to make it @b vertical.
17545 * Use this function to change how your slider is to be
17546 * disposed: vertically or horizontally.
17548 * By default it's displayed horizontally.
17550 * @see elm_slider_horizontal_get()
17554 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17557 * Retrieve the orientation of a given slider widget
17559 * @param obj The slider object.
17560 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17561 * @c EINA_FALSE if it's @b vertical (and on errors).
17563 * @see elm_slider_horizontal_set() for more details.
17567 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17570 * Set the minimum and maximum values for the slider.
17572 * @param obj The slider object.
17573 * @param min The minimum value.
17574 * @param max The maximum value.
17576 * Define the allowed range of values to be selected by the user.
17578 * If actual value is less than @p min, it will be updated to @p min. If it
17579 * is bigger then @p max, will be updated to @p max. Actual value can be
17580 * get with elm_slider_value_get().
17582 * By default, min is equal to 0.0, and max is equal to 1.0.
17584 * @warning Maximum must be greater than minimum, otherwise behavior
17587 * @see elm_slider_min_max_get()
17591 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17594 * Get the minimum and maximum values of the slider.
17596 * @param obj The slider object.
17597 * @param min Pointer where to store the minimum value.
17598 * @param max Pointer where to store the maximum value.
17600 * @note If only one value is needed, the other pointer can be passed
17603 * @see elm_slider_min_max_set() for details.
17607 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17610 * Set the value the slider displays.
17612 * @param obj The slider object.
17613 * @param val The value to be displayed.
17615 * Value will be presented on the unit label following format specified with
17616 * elm_slider_unit_format_set() and on indicator with
17617 * elm_slider_indicator_format_set().
17619 * @warning The value must to be between min and max values. This values
17620 * are set by elm_slider_min_max_set().
17622 * @see elm_slider_value_get()
17623 * @see elm_slider_unit_format_set()
17624 * @see elm_slider_indicator_format_set()
17625 * @see elm_slider_min_max_set()
17629 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17632 * Get the value displayed by the spinner.
17634 * @param obj The spinner object.
17635 * @return The value displayed.
17637 * @see elm_spinner_value_set() for details.
17641 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17644 * Invert a given slider widget's displaying values order
17646 * @param obj The slider object.
17647 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17648 * @c EINA_FALSE to bring it back to default, non-inverted values.
17650 * A slider may be @b inverted, in which state it gets its
17651 * values inverted, with high vales being on the left or top and
17652 * low values on the right or bottom, as opposed to normally have
17653 * the low values on the former and high values on the latter,
17654 * respectively, for horizontal and vertical modes.
17656 * @see elm_slider_inverted_get()
17660 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17663 * Get whether a given slider widget's displaying values are
17666 * @param obj The slider object.
17667 * @return @c EINA_TRUE, if @p obj has inverted values,
17668 * @c EINA_FALSE otherwise (and on errors).
17670 * @see elm_slider_inverted_set() for more details.
17674 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17677 * Set whether to enlarge slider indicator (augmented knob) or not.
17679 * @param obj The slider object.
17680 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17681 * let the knob always at default size.
17683 * By default, indicator will be bigger while dragged by the user.
17685 * @warning It won't display values set with
17686 * elm_slider_indicator_format_set() if you disable indicator.
17690 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17693 * Get whether a given slider widget's enlarging indicator or not.
17695 * @param obj The slider object.
17696 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17697 * @c EINA_FALSE otherwise (and on errors).
17699 * @see elm_slider_indicator_show_set() for details.
17703 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17710 * @addtogroup Actionslider Actionslider
17712 * @image html img/widget/actionslider/preview-00.png
17713 * @image latex img/widget/actionslider/preview-00.eps
17715 * An actionslider is a switcher for 2 or 3 labels with customizable magnet
17716 * properties. The user drags and releases the indicator, to choose a label.
17718 * Labels occupy the following positions.
17723 * Positions can be enabled or disabled.
17725 * Magnets can be set on the above positions.
17727 * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
17729 * @note By default all positions are set as enabled.
17731 * Signals that you can add callbacks for are:
17733 * "selected" - when user selects an enabled position (the label is passed
17736 * "pos_changed" - when the indicator reaches any of the positions("left",
17737 * "right" or "center").
17739 * See an example of actionslider usage @ref actionslider_example_page "here"
17743 typedef enum _Elm_Actionslider_Indicator_Pos
17745 ELM_ACTIONSLIDER_INDICATOR_NONE,
17746 ELM_ACTIONSLIDER_INDICATOR_LEFT,
17747 ELM_ACTIONSLIDER_INDICATOR_RIGHT,
17748 ELM_ACTIONSLIDER_INDICATOR_CENTER
17749 } Elm_Actionslider_Indicator_Pos;
17751 typedef enum _Elm_Actionslider_Magnet_Pos
17753 ELM_ACTIONSLIDER_MAGNET_NONE = 0,
17754 ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
17755 ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
17756 ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
17757 ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
17758 ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
17759 } Elm_Actionslider_Magnet_Pos;
17761 typedef enum _Elm_Actionslider_Label_Pos
17763 ELM_ACTIONSLIDER_LABEL_LEFT,
17764 ELM_ACTIONSLIDER_LABEL_RIGHT,
17765 ELM_ACTIONSLIDER_LABEL_CENTER,
17766 ELM_ACTIONSLIDER_LABEL_BUTTON
17767 } Elm_Actionslider_Label_Pos;
17769 /* smart callbacks called:
17770 * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
17774 * Add a new actionslider to the parent.
17776 * @param parent The parent object
17777 * @return The new actionslider object or NULL if it cannot be created
17779 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17782 * Set actionslider label.
17784 * @param[in] obj The actionslider object
17785 * @param[in] pos The position of the label.
17786 * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
17787 * @param label The label which is going to be set.
17789 EAPI void elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
17791 * Get actionslider labels.
17793 * @param obj The actionslider object
17794 * @param left_label A char** to place the left_label of @p obj into.
17795 * @param center_label A char** to place the center_label of @p obj into.
17796 * @param right_label A char** to place the right_label of @p obj into.
17798 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);
17800 * Get actionslider selected label.
17802 * @param obj The actionslider object
17803 * @return The selected label
17805 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17807 * Set actionslider indicator position.
17809 * @param obj The actionslider object.
17810 * @param pos The position of the indicator.
17812 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
17814 * Get actionslider indicator position.
17816 * @param obj The actionslider object.
17817 * @return The position of the indicator.
17819 EAPI Elm_Actionslider_Indicator_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17821 * Set actionslider magnet position. To make multiple positions magnets @c or
17822 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
17824 * @param obj The actionslider object.
17825 * @param pos Bit mask indicating the magnet positions.
17827 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
17829 * Get actionslider magnet position.
17831 * @param obj The actionslider object.
17832 * @return The positions with magnet property.
17834 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17836 * Set actionslider enabled position. To set multiple positions as enabled @c or
17837 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
17839 * @note All the positions are enabled by default.
17841 * @param obj The actionslider object.
17842 * @param pos Bit mask indicating the enabled positions.
17844 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
17846 * Get actionslider enabled position.
17848 * @param obj The actionslider object.
17849 * @return The enabled positions.
17851 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17853 * Set the label used on the indicator.
17855 * @param obj The actionslider object
17856 * @param label The label to be set on the indicator.
17857 * @deprecated use elm_object_text_set() instead.
17859 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17861 * Get the label used on the indicator object.
17863 * @param obj The actionslider object
17864 * @return The indicator label
17865 * @deprecated use elm_object_text_get() instead.
17867 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
17873 * @defgroup Genlist Genlist
17875 * @image html img/widget/genlist/preview-00.png
17876 * @image latex img/widget/genlist/preview-00.eps
17877 * @image html img/genlist.png
17878 * @image latex img/genlist.eps
17880 * This widget aims to have more expansive list than the simple list in
17881 * Elementary that could have more flexible items and allow many more entries
17882 * while still being fast and low on memory usage. At the same time it was
17883 * also made to be able to do tree structures. But the price to pay is more
17884 * complexity when it comes to usage. If all you want is a simple list with
17885 * icons and a single label, use the normal @ref List object.
17887 * Genlist has a fairly large API, mostly because it's relatively complex,
17888 * trying to be both expansive, powerful and efficient. First we will begin
17889 * an overview on the theory behind genlist.
17891 * @section Genlist_Item_Class Genlist item classes - creating items
17893 * In order to have the ability to add and delete items on the fly, genlist
17894 * implements a class (callback) system where the application provides a
17895 * structure with information about that type of item (genlist may contain
17896 * multiple different items with different classes, states and styles).
17897 * Genlist will call the functions in this struct (methods) when an item is
17898 * "realized" (i.e., created dynamically, while the user is scrolling the
17899 * grid). All objects will simply be deleted when no longer needed with
17900 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
17901 * following members:
17902 * - @c item_style - This is a constant string and simply defines the name
17903 * of the item style. It @b must be specified and the default should be @c
17906 * - @c func - A struct with pointers to functions that will be called when
17907 * an item is going to be actually created. All of them receive a @c data
17908 * parameter that will point to the same data passed to
17909 * elm_genlist_item_append() and related item creation functions, and a @c
17910 * obj parameter that points to the genlist object itself.
17912 * The function pointers inside @c func are @c label_get, @c icon_get, @c
17913 * state_get and @c del. The 3 first functions also receive a @c part
17914 * parameter described below. A brief description of these functions follows:
17916 * - @c label_get - The @c part parameter is the name string of one of the
17917 * existing text parts in the Edje group implementing the item's theme.
17918 * This function @b must return a strdup'()ed string, as the caller will
17919 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
17920 * - @c content_get - The @c part parameter is the name string of one of the
17921 * existing (content) swallow parts in the Edje group implementing the item's
17922 * theme. It must return @c NULL, when no content is desired, or a valid
17923 * object handle, otherwise. The object will be deleted by the genlist on
17924 * its deletion or when the item is "unrealized". See
17925 * #Elm_Genlist_Item_Icon_Get_Cb.
17926 * - @c func.state_get - The @c part parameter is the name string of one of
17927 * the state parts in the Edje group implementing the item's theme. Return
17928 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
17929 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
17930 * and @c "elm" as "emission" and "source" arguments, respectively, when
17931 * the state is true (the default is false), where @c XXX is the name of
17932 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
17933 * - @c func.del - This is intended for use when genlist items are deleted,
17934 * so any data attached to the item (e.g. its data parameter on creation)
17935 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
17937 * available item styles:
17939 * - default_style - The text part is a textblock
17941 * @image html img/widget/genlist/preview-04.png
17942 * @image latex img/widget/genlist/preview-04.eps
17946 * @image html img/widget/genlist/preview-01.png
17947 * @image latex img/widget/genlist/preview-01.eps
17949 * - icon_top_text_bottom
17951 * @image html img/widget/genlist/preview-02.png
17952 * @image latex img/widget/genlist/preview-02.eps
17956 * @image html img/widget/genlist/preview-03.png
17957 * @image latex img/widget/genlist/preview-03.eps
17959 * @section Genlist_Items Structure of items
17961 * An item in a genlist can have 0 or more text labels (they can be regular
17962 * text or textblock Evas objects - that's up to the style to determine), 0
17963 * or more contents (which are simply objects swallowed into the genlist item's
17964 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
17965 * behavior left to the user to define. The Edje part names for each of
17966 * these properties will be looked up, in the theme file for the genlist,
17967 * under the Edje (string) data items named @c "labels", @c "contents" and @c
17968 * "states", respectively. For each of those properties, if more than one
17969 * part is provided, they must have names listed separated by spaces in the
17970 * data fields. For the default genlist item theme, we have @b one label
17971 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
17972 * "elm.swallow.end") and @b no state parts.
17974 * A genlist item may be at one of several styles. Elementary provides one
17975 * by default - "default", but this can be extended by system or application
17976 * custom themes/overlays/extensions (see @ref Theme "themes" for more
17979 * @section Genlist_Manipulation Editing and Navigating
17981 * Items can be added by several calls. All of them return a @ref
17982 * Elm_Genlist_Item handle that is an internal member inside the genlist.
17983 * They all take a data parameter that is meant to be used for a handle to
17984 * the applications internal data (eg the struct with the original item
17985 * data). The parent parameter is the parent genlist item this belongs to if
17986 * it is a tree or an indexed group, and NULL if there is no parent. The
17987 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
17988 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
17989 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
17990 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
17991 * is set then this item is group index item that is displayed at the top
17992 * until the next group comes. The func parameter is a convenience callback
17993 * that is called when the item is selected and the data parameter will be
17994 * the func_data parameter, obj be the genlist object and event_info will be
17995 * the genlist item.
17997 * elm_genlist_item_append() adds an item to the end of the list, or if
17998 * there is a parent, to the end of all the child items of the parent.
17999 * elm_genlist_item_prepend() is the same but adds to the beginning of
18000 * the list or children list. elm_genlist_item_insert_before() inserts at
18001 * item before another item and elm_genlist_item_insert_after() inserts after
18002 * the indicated item.
18004 * The application can clear the list with elm_gen_clear() which deletes
18005 * all the items in the list and elm_genlist_item_del() will delete a specific
18006 * item. elm_genlist_item_subitems_clear() will clear all items that are
18007 * children of the indicated parent item.
18009 * To help inspect list items you can jump to the item at the top of the list
18010 * with elm_genlist_first_item_get() which will return the item pointer, and
18011 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18012 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18013 * and previous items respectively relative to the indicated item. Using
18014 * these calls you can walk the entire item list/tree. Note that as a tree
18015 * the items are flattened in the list, so elm_genlist_item_parent_get() will
18016 * let you know which item is the parent (and thus know how to skip them if
18019 * @section Genlist_Muti_Selection Multi-selection
18021 * If the application wants multiple items to be able to be selected,
18022 * elm_genlist_multi_select_set() can enable this. If the list is
18023 * single-selection only (the default), then elm_genlist_selected_item_get()
18024 * will return the selected item, if any, or NULL I none is selected. If the
18025 * list is multi-select then elm_genlist_selected_items_get() will return a
18026 * list (that is only valid as long as no items are modified (added, deleted,
18027 * selected or unselected)).
18029 * @section Genlist_Usage_Hints Usage hints
18031 * There are also convenience functions. elm_gen_item_genlist_get() will
18032 * return the genlist object the item belongs to. elm_genlist_item_show()
18033 * will make the scroller scroll to show that specific item so its visible.
18034 * elm_genlist_item_data_get() returns the data pointer set by the item
18035 * creation functions.
18037 * If an item changes (state of boolean changes, label or contents change),
18038 * then use elm_genlist_item_update() to have genlist update the item with
18039 * the new state. Genlist will re-realize the item thus call the functions
18040 * in the _Elm_Genlist_Item_Class for that item.
18042 * To programmatically (un)select an item use elm_genlist_item_selected_set().
18043 * To get its selected state use elm_genlist_item_selected_get(). Similarly
18044 * to expand/contract an item and get its expanded state, use
18045 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18046 * again to make an item disabled (unable to be selected and appear
18047 * differently) use elm_genlist_item_disabled_set() to set this and
18048 * elm_genlist_item_disabled_get() to get the disabled state.
18050 * In general to indicate how the genlist should expand items horizontally to
18051 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18052 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18053 * mode means that if items are too wide to fit, the scroller will scroll
18054 * horizontally. Otherwise items are expanded to fill the width of the
18055 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18056 * to the viewport width and limited to that size. This can be combined with
18057 * a different style that uses edjes' ellipsis feature (cutting text off like
18060 * Items will only call their selection func and callback when first becoming
18061 * selected. Any further clicks will do nothing, unless you enable always
18062 * select with elm_gen_always_select_mode_set(). This means even if
18063 * selected, every click will make the selected callbacks be called.
18064 * elm_genlist_no_select_mode_set() will turn off the ability to select
18065 * items entirely and they will neither appear selected nor call selected
18066 * callback functions.
18068 * Remember that you can create new styles and add your own theme augmentation
18069 * per application with elm_theme_extension_add(). If you absolutely must
18070 * have a specific style that overrides any theme the user or system sets up
18071 * you can use elm_theme_overlay_add() to add such a file.
18073 * @section Genlist_Implementation Implementation
18075 * Evas tracks every object you create. Every time it processes an event
18076 * (mouse move, down, up etc.) it needs to walk through objects and find out
18077 * what event that affects. Even worse every time it renders display updates,
18078 * in order to just calculate what to re-draw, it needs to walk through many
18079 * many many objects. Thus, the more objects you keep active, the more
18080 * overhead Evas has in just doing its work. It is advisable to keep your
18081 * active objects to the minimum working set you need. Also remember that
18082 * object creation and deletion carries an overhead, so there is a
18083 * middle-ground, which is not easily determined. But don't keep massive lists
18084 * of objects you can't see or use. Genlist does this with list objects. It
18085 * creates and destroys them dynamically as you scroll around. It groups them
18086 * into blocks so it can determine the visibility etc. of a whole block at
18087 * once as opposed to having to walk the whole list. This 2-level list allows
18088 * for very large numbers of items to be in the list (tests have used up to
18089 * 2,000,000 items). Also genlist employs a queue for adding items. As items
18090 * may be different sizes, every item added needs to be calculated as to its
18091 * size and thus this presents a lot of overhead on populating the list, this
18092 * genlist employs a queue. Any item added is queued and spooled off over
18093 * time, actually appearing some time later, so if your list has many members
18094 * you may find it takes a while for them to all appear, with your process
18095 * consuming a lot of CPU while it is busy spooling.
18097 * Genlist also implements a tree structure, but it does so with callbacks to
18098 * the application, with the application filling in tree structures when
18099 * requested (allowing for efficient building of a very deep tree that could
18100 * even be used for file-management). See the above smart signal callbacks for
18103 * @section Genlist_Smart_Events Genlist smart events
18105 * Signals that you can add callbacks for are:
18106 * - @c "activated" - The user has double-clicked or pressed
18107 * (enter|return|spacebar) on an item. The @c event_info parameter is the
18108 * item that was activated.
18109 * - @c "clicked,double" - The user has double-clicked an item. The @c
18110 * event_info parameter is the item that was double-clicked.
18111 * - @c "selected" - This is called when a user has made an item selected.
18112 * The event_info parameter is the genlist item that was selected.
18113 * - @c "unselected" - This is called when a user has made an item
18114 * unselected. The event_info parameter is the genlist item that was
18116 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18117 * called and the item is now meant to be expanded. The event_info
18118 * parameter is the genlist item that was indicated to expand. It is the
18119 * job of this callback to then fill in the child items.
18120 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18121 * called and the item is now meant to be contracted. The event_info
18122 * parameter is the genlist item that was indicated to contract. It is the
18123 * job of this callback to then delete the child items.
18124 * - @c "expand,request" - This is called when a user has indicated they want
18125 * to expand a tree branch item. The callback should decide if the item can
18126 * expand (has any children) and then call elm_genlist_item_expanded_set()
18127 * appropriately to set the state. The event_info parameter is the genlist
18128 * item that was indicated to expand.
18129 * - @c "contract,request" - This is called when a user has indicated they
18130 * want to contract a tree branch item. The callback should decide if the
18131 * item can contract (has any children) and then call
18132 * elm_genlist_item_expanded_set() appropriately to set the state. The
18133 * event_info parameter is the genlist item that was indicated to contract.
18134 * - @c "realized" - This is called when the item in the list is created as a
18135 * real evas object. event_info parameter is the genlist item that was
18136 * created. The object may be deleted at any time, so it is up to the
18137 * caller to not use the object pointer from elm_genlist_item_object_get()
18138 * in a way where it may point to freed objects.
18139 * - @c "unrealized" - This is called just before an item is unrealized.
18140 * After this call content objects provided will be deleted and the item
18141 * object itself delete or be put into a floating cache.
18142 * - @c "drag,start,up" - This is called when the item in the list has been
18143 * dragged (not scrolled) up.
18144 * - @c "drag,start,down" - This is called when the item in the list has been
18145 * dragged (not scrolled) down.
18146 * - @c "drag,start,left" - This is called when the item in the list has been
18147 * dragged (not scrolled) left.
18148 * - @c "drag,start,right" - This is called when the item in the list has
18149 * been dragged (not scrolled) right.
18150 * - @c "drag,stop" - This is called when the item in the list has stopped
18152 * - @c "drag" - This is called when the item in the list is being dragged.
18153 * - @c "longpressed" - This is called when the item is pressed for a certain
18154 * amount of time. By default it's 1 second.
18155 * - @c "scroll,anim,start" - This is called when scrolling animation has
18157 * - @c "scroll,anim,stop" - This is called when scrolling animation has
18159 * - @c "scroll,drag,start" - This is called when dragging the content has
18161 * - @c "scroll,drag,stop" - This is called when dragging the content has
18163 * - @c "edge,top" - This is called when the genlist is scrolled until
18165 * - @c "edge,bottom" - This is called when the genlist is scrolled
18166 * until the bottom edge.
18167 * - @c "edge,left" - This is called when the genlist is scrolled
18168 * until the left edge.
18169 * - @c "edge,right" - This is called when the genlist is scrolled
18170 * until the right edge.
18171 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18173 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18175 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18177 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18179 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18180 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
18181 * multi-touch pinched in.
18182 * - @c "swipe" - This is called when the genlist is swiped.
18183 * - @c "moved" - This is called when a genlist item is moved.
18184 * - @c "language,changed" - This is called when the program's language is
18187 * @section Genlist_Examples Examples
18189 * Here is a list of examples that use the genlist, trying to show some of
18190 * its capabilities:
18191 * - @ref genlist_example_01
18192 * - @ref genlist_example_02
18193 * - @ref genlist_example_03
18194 * - @ref genlist_example_04
18195 * - @ref genlist_example_05
18199 * @addtogroup Genlist
18204 * @enum _Elm_Genlist_Item_Flags
18205 * @typedef Elm_Genlist_Item_Flags
18207 * Defines if the item is of any special type (has subitems or it's the
18208 * index of a group), or is just a simple item.
18212 typedef enum _Elm_Genlist_Item_Flags
18214 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18215 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18216 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18217 } Elm_Genlist_Item_Flags;
18218 typedef enum _Elm_Genlist_Item_Field_Flags
18220 ELM_GENLIST_ITEM_FIELD_ALL = 0,
18221 ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
18222 ELM_GENLIST_ITEM_FIELD_ICON = (1 << 1),
18223 ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
18224 } Elm_Genlist_Item_Field_Flags;
18225 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
18226 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18227 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
18228 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
18229 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
18230 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
18231 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj);
18232 typedef void (*GenlistItemMovedFunc) ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
18235 * @struct _Elm_Genlist_Item_Class
18237 * Genlist item class definition structs.
18239 * This struct contains the style and fetching functions that will define the
18240 * contents of each item.
18242 * @see @ref Genlist_Item_Class
18244 struct _Elm_Genlist_Item_Class
18246 const char *item_style;
18248 GenlistItemLabelGetFunc label_get;
18249 GenlistItemIconGetFunc icon_get;
18250 GenlistItemStateGetFunc state_get;
18251 GenlistItemDelFunc del;
18252 GenlistItemMovedFunc moved;
18254 const char *edit_item_style;
18255 const char *mode_item_style;
18257 #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18259 * Add a new genlist widget to the given parent Elementary
18260 * (container) object
18262 * @param parent The parent object
18263 * @return a new genlist widget handle or @c NULL, on errors
18265 * This function inserts a new genlist widget on the canvas.
18267 * @see elm_genlist_item_append()
18268 * @see elm_genlist_item_del()
18269 * @see elm_gen_clear()
18273 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18275 * Remove all items from a given genlist widget.
18277 * @param obj The genlist object
18279 * This removes (and deletes) all items in @p obj, leaving it empty.
18281 * @see elm_genlist_item_del(), to remove just one item.
18285 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18287 * Enable or disable multi-selection in the genlist
18289 * @param obj The genlist object
18290 * @param multi Multi-select enable/disable. Default is disabled.
18292 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18293 * the list. This allows more than 1 item to be selected. To retrieve the list
18294 * of selected items, use elm_genlist_selected_items_get().
18296 * @see elm_genlist_selected_items_get()
18297 * @see elm_genlist_multi_select_get()
18301 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18303 * Gets if multi-selection in genlist is enabled or disabled.
18305 * @param obj The genlist object
18306 * @return Multi-select enabled/disabled
18307 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18309 * @see elm_genlist_multi_select_set()
18313 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18315 * This sets the horizontal stretching mode.
18317 * @param obj The genlist object
18318 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18320 * This sets the mode used for sizing items horizontally. Valid modes
18321 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18322 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18323 * the scroller will scroll horizontally. Otherwise items are expanded
18324 * to fill the width of the viewport of the scroller. If it is
18325 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18326 * limited to that size.
18328 * @see elm_genlist_horizontal_get()
18332 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18334 * Gets the horizontal stretching mode.
18336 * @param obj The genlist object
18337 * @return The mode to use
18338 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18340 * @see elm_genlist_horizontal_set()
18344 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18346 * Set the always select mode.
18348 * @param obj The genlist object
18349 * @param always_select The always select mode (@c EINA_TRUE = on, @c
18350 * EINA_FALSE = off). Default is @c EINA_FALSE.
18352 * Items will only call their selection func and callback when first
18353 * becoming selected. Any further clicks will do nothing, unless you
18354 * enable always select with elm_genlist_always_select_mode_set().
18355 * This means that, even if selected, every click will make the selected
18356 * callbacks be called.
18358 * @see elm_genlist_always_select_mode_get()
18362 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18364 * Get the always select mode.
18366 * @param obj The genlist object
18367 * @return The always select mode
18368 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18370 * @see elm_genlist_always_select_mode_set()
18374 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18376 * Enable/disable the no select mode.
18378 * @param obj The genlist object
18379 * @param no_select The no select mode
18380 * (EINA_TRUE = on, EINA_FALSE = off)
18382 * This will turn off the ability to select items entirely and they
18383 * will neither appear selected nor call selected callback functions.
18385 * @see elm_genlist_no_select_mode_get()
18389 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18391 * Gets whether the no select mode is enabled.
18393 * @param obj The genlist object
18394 * @return The no select mode
18395 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18397 * @see elm_genlist_no_select_mode_set()
18401 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18403 * Enable/disable compress mode.
18405 * @param obj The genlist object
18406 * @param compress The compress mode
18407 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18409 * This will enable the compress mode where items are "compressed"
18410 * horizontally to fit the genlist scrollable viewport width. This is
18411 * special for genlist. Do not rely on
18412 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18413 * work as genlist needs to handle it specially.
18415 * @see elm_genlist_compress_mode_get()
18419 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18421 * Get whether the compress mode is enabled.
18423 * @param obj The genlist object
18424 * @return The compress mode
18425 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18427 * @see elm_genlist_compress_mode_set()
18431 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18433 * Enable/disable height-for-width mode.
18435 * @param obj The genlist object
18436 * @param setting The height-for-width mode (@c EINA_TRUE = on,
18437 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18439 * With height-for-width mode the item width will be fixed (restricted
18440 * to a minimum of) to the list width when calculating its size in
18441 * order to allow the height to be calculated based on it. This allows,
18442 * for instance, text block to wrap lines if the Edje part is
18443 * configured with "text.min: 0 1".
18445 * @note This mode will make list resize slower as it will have to
18446 * recalculate every item height again whenever the list width
18449 * @note When height-for-width mode is enabled, it also enables
18450 * compress mode (see elm_genlist_compress_mode_set()) and
18451 * disables homogeneous (see elm_genlist_homogeneous_set()).
18455 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18457 * Get whether the height-for-width mode is enabled.
18459 * @param obj The genlist object
18460 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18465 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18467 * Enable/disable horizontal and vertical bouncing effect.
18469 * @param obj The genlist object
18470 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18471 * EINA_FALSE = off). Default is @c EINA_FALSE.
18472 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18473 * EINA_FALSE = off). Default is @c EINA_TRUE.
18475 * This will enable or disable the scroller bouncing effect for the
18476 * genlist. See elm_scroller_bounce_set() for details.
18478 * @see elm_scroller_bounce_set()
18479 * @see elm_genlist_bounce_get()
18483 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18485 * Get whether the horizontal and vertical bouncing effect is enabled.
18487 * @param obj The genlist object
18488 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18490 * @param v_bounce Pointer to a bool to receive if the bounce vertically
18493 * @see elm_genlist_bounce_set()
18497 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18499 * Enable/disable homogenous mode.
18501 * @param obj The genlist object
18502 * @param homogeneous Assume the items within the genlist are of the
18503 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18506 * This will enable the homogeneous mode where items are of the same
18507 * height and width so that genlist may do the lazy-loading at its
18508 * maximum (which increases the performance for scrolling the list). This
18509 * implies 'compressed' mode.
18511 * @see elm_genlist_compress_mode_set()
18512 * @see elm_genlist_homogeneous_get()
18516 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18518 * Get whether the homogenous mode is enabled.
18520 * @param obj The genlist object
18521 * @return Assume the items within the genlist are of the same height
18522 * and width (EINA_TRUE = on, EINA_FALSE = off)
18524 * @see elm_genlist_homogeneous_set()
18528 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18530 * Set the maximum number of items within an item block
18532 * @param obj The genlist object
18533 * @param n Maximum number of items within an item block. Default is 32.
18535 * This will configure the block count to tune to the target with
18536 * particular performance matrix.
18538 * A block of objects will be used to reduce the number of operations due to
18539 * many objects in the screen. It can determine the visibility, or if the
18540 * object has changed, it theme needs to be updated, etc. doing this kind of
18541 * calculation to the entire block, instead of per object.
18543 * The default value for the block count is enough for most lists, so unless
18544 * you know you will have a lot of objects visible in the screen at the same
18545 * time, don't try to change this.
18547 * @see elm_genlist_block_count_get()
18548 * @see @ref Genlist_Implementation
18552 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18554 * Get the maximum number of items within an item block
18556 * @param obj The genlist object
18557 * @return Maximum number of items within an item block
18559 * @see elm_genlist_block_count_set()
18563 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18565 * Set the timeout in seconds for the longpress event.
18567 * @param obj The genlist object
18568 * @param timeout timeout in seconds. Default is 1.
18570 * This option will change how long it takes to send an event "longpressed"
18571 * after the mouse down signal is sent to the list. If this event occurs, no
18572 * "clicked" event will be sent.
18574 * @see elm_genlist_longpress_timeout_set()
18578 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18580 * Get the timeout in seconds for the longpress event.
18582 * @param obj The genlist object
18583 * @return timeout in seconds
18585 * @see elm_genlist_longpress_timeout_get()
18589 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18591 * Append a new item in a given genlist widget.
18593 * @param obj The genlist object
18594 * @param itc The item class for the item
18595 * @param data The item data
18596 * @param parent The parent item, or NULL if none
18597 * @param flags Item flags
18598 * @param func Convenience function called when the item is selected
18599 * @param func_data Data passed to @p func above.
18600 * @return A handle to the item added or @c NULL if not possible
18602 * This adds the given item to the end of the list or the end of
18603 * the children list if the @p parent is given.
18605 * @see elm_genlist_item_prepend()
18606 * @see elm_genlist_item_insert_before()
18607 * @see elm_genlist_item_insert_after()
18608 * @see elm_genlist_item_del()
18612 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);
18614 * Prepend a new item in a given genlist widget.
18616 * @param obj The genlist object
18617 * @param itc The item class for the item
18618 * @param data The item data
18619 * @param parent The parent item, or NULL if none
18620 * @param flags Item flags
18621 * @param func Convenience function called when the item is selected
18622 * @param func_data Data passed to @p func above.
18623 * @return A handle to the item added or NULL if not possible
18625 * This adds an item to the beginning of the list or beginning of the
18626 * children of the parent if given.
18628 * @see elm_genlist_item_append()
18629 * @see elm_genlist_item_insert_before()
18630 * @see elm_genlist_item_insert_after()
18631 * @see elm_genlist_item_del()
18635 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);
18637 * Insert an item before another in a genlist widget
18639 * @param obj The genlist object
18640 * @param itc The item class for the item
18641 * @param data The item data
18642 * @param before The item to place this new one before.
18643 * @param flags Item flags
18644 * @param func Convenience function called when the item is selected
18645 * @param func_data Data passed to @p func above.
18646 * @return A handle to the item added or @c NULL if not possible
18648 * This inserts an item before another in the list. It will be in the
18649 * same tree level or group as the item it is inserted before.
18651 * @see elm_genlist_item_append()
18652 * @see elm_genlist_item_prepend()
18653 * @see elm_genlist_item_insert_after()
18654 * @see elm_genlist_item_del()
18658 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);
18660 * Insert an item after another in a genlist widget
18662 * @param obj The genlist object
18663 * @param itc The item class for the item
18664 * @param data The item data
18665 * @param after The item to place this new one after.
18666 * @param flags Item flags
18667 * @param func Convenience function called when the item is selected
18668 * @param func_data Data passed to @p func above.
18669 * @return A handle to the item added or @c NULL if not possible
18671 * This inserts an item after another in the list. It will be in the
18672 * same tree level or group as the item it is inserted after.
18674 * @see elm_genlist_item_append()
18675 * @see elm_genlist_item_prepend()
18676 * @see elm_genlist_item_insert_before()
18677 * @see elm_genlist_item_del()
18681 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);
18683 * Insert a new item into the sorted genlist object
18685 * @param obj The genlist object
18686 * @param itc The item class for the item
18687 * @param data The item data
18688 * @param parent The parent item, or NULL if none
18689 * @param flags Item flags
18690 * @param comp The function called for the sort
18691 * @param func Convenience function called when item selected
18692 * @param func_data Data passed to @p func above.
18693 * @return A handle to the item added or NULL if not possible
18697 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);
18698 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);
18699 /* operations to retrieve existing items */
18701 * Get the selectd item in the genlist.
18703 * @param obj The genlist object
18704 * @return The selected item, or NULL if none is selected.
18706 * This gets the selected item in the list (if multi-selection is enabled, only
18707 * the item that was first selected in the list is returned - which is not very
18708 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18711 * If no item is selected, NULL is returned.
18713 * @see elm_genlist_selected_items_get()
18717 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18719 * Get a list of selected items in the genlist.
18721 * @param obj The genlist object
18722 * @return The list of selected items, or NULL if none are selected.
18724 * It returns a list of the selected items. This list pointer is only valid so
18725 * long as the selection doesn't change (no items are selected or unselected, or
18726 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18727 * pointers. The order of the items in this list is the order which they were
18728 * selected, i.e. the first item in this list is the first item that was
18729 * selected, and so on.
18731 * @note If not in multi-select mode, consider using function
18732 * elm_genlist_selected_item_get() instead.
18734 * @see elm_genlist_multi_select_set()
18735 * @see elm_genlist_selected_item_get()
18739 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18741 * Get the mode item style of items in the genlist
18742 * @param obj The genlist object
18743 * @return The mode item style string, or NULL if none is specified
18745 * This is a constant string and simply defines the name of the
18746 * style that will be used for mode animations. It can be
18747 * @c NULL if you don't plan to use Genlist mode. See
18748 * elm_genlist_item_mode_set() for more info.
18752 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18754 * Set the mode item style of items in the genlist
18755 * @param obj The genlist object
18756 * @param style The mode item style string, or NULL if none is desired
18758 * This is a constant string and simply defines the name of the
18759 * style that will be used for mode animations. It can be
18760 * @c NULL if you don't plan to use Genlist mode. See
18761 * elm_genlist_item_mode_set() for more info.
18765 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
18767 * Get a list of realized items in genlist
18769 * @param obj The genlist object
18770 * @return The list of realized items, nor NULL if none are realized.
18772 * This returns a list of the realized items in the genlist. The list
18773 * contains Elm_Genlist_Item pointers. The list must be freed by the
18774 * caller when done with eina_list_free(). The item pointers in the
18775 * list are only valid so long as those items are not deleted or the
18776 * genlist is not deleted.
18778 * @see elm_genlist_realized_items_update()
18782 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18784 * Get the item that is at the x, y canvas coords.
18786 * @param obj The gelinst object.
18787 * @param x The input x coordinate
18788 * @param y The input y coordinate
18789 * @param posret The position relative to the item returned here
18790 * @return The item at the coordinates or NULL if none
18792 * This returns the item at the given coordinates (which are canvas
18793 * relative, not object-relative). If an item is at that coordinate,
18794 * that item handle is returned, and if @p posret is not NULL, the
18795 * integer pointed to is set to a value of -1, 0 or 1, depending if
18796 * the coordinate is on the upper portion of that item (-1), on the
18797 * middle section (0) or on the lower part (1). If NULL is returned as
18798 * an item (no item found there), then posret may indicate -1 or 1
18799 * based if the coordinate is above or below all items respectively in
18804 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);
18806 * Get the first item in the genlist
18808 * This returns the first item in the list.
18810 * @param obj The genlist object
18811 * @return The first item, or NULL if none
18815 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18817 * Get the last item in the genlist
18819 * This returns the last item in the list.
18821 * @return The last item, or NULL if none
18825 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18827 * Set the scrollbar policy
18829 * @param obj The genlist object
18830 * @param policy_h Horizontal scrollbar policy.
18831 * @param policy_v Vertical scrollbar policy.
18833 * This sets the scrollbar visibility policy for the given genlist
18834 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
18835 * made visible if it is needed, and otherwise kept hidden.
18836 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
18837 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
18838 * respectively for the horizontal and vertical scrollbars. Default is
18839 * #ELM_SMART_SCROLLER_POLICY_AUTO
18841 * @see elm_genlist_scroller_policy_get()
18845 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
18847 * Get the scrollbar policy
18849 * @param obj The genlist object
18850 * @param policy_h Pointer to store the horizontal scrollbar policy.
18851 * @param policy_v Pointer to store the vertical scrollbar policy.
18853 * @see elm_genlist_scroller_policy_set()
18857 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);
18859 * Get the @b next item in a genlist widget's internal list of items,
18860 * given a handle to one of those items.
18862 * @param item The genlist item to fetch next from
18863 * @return The item after @p item, or @c NULL if there's none (and
18866 * This returns the item placed after the @p item, on the container
18869 * @see elm_genlist_item_prev_get()
18873 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18875 * Get the @b previous item in a genlist widget's internal list of items,
18876 * given a handle to one of those items.
18878 * @param item The genlist item to fetch previous from
18879 * @return The item before @p item, or @c NULL if there's none (and
18882 * This returns the item placed before the @p item, on the container
18885 * @see elm_genlist_item_next_get()
18889 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18891 * Get the genlist object's handle which contains a given genlist
18894 * @param item The item to fetch the container from
18895 * @return The genlist (parent) object
18897 * This returns the genlist object itself that an item belongs to.
18901 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18903 * Get the parent item of the given item
18905 * @param it The item
18906 * @return The parent of the item or @c NULL if it has no parent.
18908 * This returns the item that was specified as parent of the item @p it on
18909 * elm_genlist_item_append() and insertion related functions.
18913 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18915 * Remove all sub-items (children) of the given item
18917 * @param it The item
18919 * This removes all items that are children (and their descendants) of the
18920 * given item @p it.
18922 * @see elm_genlist_clear()
18923 * @see elm_genlist_item_del()
18927 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18929 * Set whether a given genlist item is selected or not
18931 * @param it The item
18932 * @param selected Use @c EINA_TRUE, to make it selected, @c
18933 * EINA_FALSE to make it unselected
18935 * This sets the selected state of an item. If multi selection is
18936 * not enabled on the containing genlist and @p selected is @c
18937 * EINA_TRUE, any other previously selected items will get
18938 * unselected in favor of this new one.
18940 * @see elm_genlist_item_selected_get()
18944 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
18946 * Get whether a given genlist item is selected or not
18948 * @param it The item
18949 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
18951 * @see elm_genlist_item_selected_set() for more details
18955 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18957 * Sets the expanded state of an item.
18959 * @param it The item
18960 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
18962 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
18965 * The theme will respond to this change visually, and a signal "expanded" or
18966 * "contracted" will be sent from the genlist with a pointer to the item that
18967 * has been expanded/contracted.
18969 * Calling this function won't show or hide any child of this item (if it is
18970 * a parent). You must manually delete and create them on the callbacks fo
18971 * the "expanded" or "contracted" signals.
18973 * @see elm_genlist_item_expanded_get()
18977 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
18979 * Get the expanded state of an item
18981 * @param it The item
18982 * @return The expanded state
18984 * This gets the expanded state of an item.
18986 * @see elm_genlist_item_expanded_set()
18990 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18992 * Get the depth of expanded item
18994 * @param it The genlist item object
18995 * @return The depth of expanded item
18999 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19001 * Set whether a given genlist item is disabled or not.
19003 * @param it The item
19004 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19005 * to enable it back.
19007 * A disabled item cannot be selected or unselected. It will also
19008 * change its appearance, to signal the user it's disabled.
19010 * @see elm_genlist_item_disabled_get()
19014 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19016 * Get whether a given genlist item is disabled or not.
19018 * @param it The item
19019 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19022 * @see elm_genlist_item_disabled_set() for more details
19026 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19028 * Sets the display only state of an item.
19030 * @param it The item
19031 * @param display_only @c EINA_TRUE if the item is display only, @c
19032 * EINA_FALSE otherwise.
19034 * A display only item cannot be selected or unselected. It is for
19035 * display only and not selecting or otherwise clicking, dragging
19036 * etc. by the user, thus finger size rules will not be applied to
19039 * It's good to set group index items to display only state.
19041 * @see elm_genlist_item_display_only_get()
19045 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19047 * Get the display only state of an item
19049 * @param it The item
19050 * @return @c EINA_TRUE if the item is display only, @c
19051 * EINA_FALSE otherwise.
19053 * @see elm_genlist_item_display_only_set()
19057 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19059 * Show the portion of a genlist's internal list containing a given
19060 * item, immediately.
19062 * @param it The item to display
19064 * This causes genlist to jump to the given item @p it and show it (by
19065 * immediately scrolling to that position), if it is not fully visible.
19067 * @see elm_genlist_item_bring_in()
19068 * @see elm_genlist_item_top_show()
19069 * @see elm_genlist_item_middle_show()
19073 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19075 * Animatedly bring in, to the visible are of a genlist, a given
19078 * @param it The item to display
19080 * This causes genlist to jump to the given item @p it and show it (by
19081 * animatedly scrolling), if it is not fully visible. This may use animation
19082 * to do so and take a period of time
19084 * @see elm_genlist_item_show()
19085 * @see elm_genlist_item_top_bring_in()
19086 * @see elm_genlist_item_middle_bring_in()
19090 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19092 * Show the portion of a genlist's internal list containing a given
19093 * item, immediately.
19095 * @param it The item to display
19097 * This causes genlist to jump to the given item @p it and show it (by
19098 * immediately scrolling to that position), if it is not fully visible.
19100 * The item will be positioned at the top of the genlist viewport.
19102 * @see elm_genlist_item_show()
19103 * @see elm_genlist_item_top_bring_in()
19107 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19109 * Animatedly bring in, to the visible are of a genlist, a given
19112 * @param it The item
19114 * This causes genlist to jump to the given item @p it and show it (by
19115 * animatedly scrolling), if it is not fully visible. This may use animation
19116 * to do so and take a period of time
19118 * The item will be positioned at the top of the genlist viewport.
19120 * @see elm_genlist_item_bring_in()
19121 * @see elm_genlist_item_top_show()
19125 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19127 * Show the portion of a genlist's internal list containing a given
19128 * item, immediately.
19130 * @param it The item to display
19132 * This causes genlist to jump to the given item @p it and show it (by
19133 * immediately scrolling to that position), if it is not fully visible.
19135 * The item will be positioned at the middle of the genlist viewport.
19137 * @see elm_genlist_item_show()
19138 * @see elm_genlist_item_middle_bring_in()
19142 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19144 * Animatedly bring in, to the visible are of a genlist, a given
19147 * @param it The item
19149 * This causes genlist to jump to the given item @p it and show it (by
19150 * animatedly scrolling), if it is not fully visible. This may use animation
19151 * to do so and take a period of time
19153 * The item will be positioned at the middle of the genlist viewport.
19155 * @see elm_genlist_item_bring_in()
19156 * @see elm_genlist_item_middle_show()
19160 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19162 * Remove a genlist item from the its parent, deleting it.
19164 * @param item The item to be removed.
19165 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19167 * @see elm_genlist_clear(), to remove all items in a genlist at
19172 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19174 * Return the data associated to a given genlist item
19176 * @param item The genlist item.
19177 * @return the data associated to this item.
19179 * This returns the @c data value passed on the
19180 * elm_genlist_item_append() and related item addition calls.
19182 * @see elm_genlist_item_append()
19183 * @see elm_genlist_item_data_set()
19187 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19189 * Set the data associated to a given genlist item
19191 * @param item The genlist item
19192 * @param data The new data pointer to set on it
19194 * This @b overrides the @c data value passed on the
19195 * elm_genlist_item_append() and related item addition calls. This
19196 * function @b won't call elm_genlist_item_update() automatically,
19197 * so you'd issue it afterwards if you want to hove the item
19198 * updated to reflect the that new data.
19200 * @see elm_genlist_item_data_get()
19204 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19206 * Tells genlist to "orphan" icons fetchs by the item class
19208 * @param it The item
19210 * This instructs genlist to release references to icons in the item,
19211 * meaning that they will no longer be managed by genlist and are
19212 * floating "orphans" that can be re-used elsewhere if the user wants
19217 EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19218 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19220 * Get the real Evas object created to implement the view of a
19221 * given genlist item
19223 * @param item The genlist item.
19224 * @return the Evas object implementing this item's view.
19226 * This returns the actual Evas object used to implement the
19227 * specified genlist item's view. This may be @c NULL, as it may
19228 * not have been created or may have been deleted, at any time, by
19229 * the genlist. <b>Do not modify this object</b> (move, resize,
19230 * show, hide, etc.), as the genlist is controlling it. This
19231 * function is for querying, emitting custom signals or hooking
19232 * lower level callbacks for events on that object. Do not delete
19233 * this object under any circumstances.
19235 * @see elm_genlist_item_data_get()
19239 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19241 * Update the contents of an item
19243 * @param it The item
19245 * This updates an item by calling all the item class functions again
19246 * to get the icons, labels and states. Use this when the original
19247 * item data has changed and the changes are desired to be reflected.
19249 * Use elm_genlist_realized_items_update() to update all already realized
19252 * @see elm_genlist_realized_items_update()
19256 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19257 EAPI void elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
19259 * Update the item class of an item
19261 * @param it The item
19262 * @param itc The item class for the item
19264 * This sets another class fo the item, changing the way that it is
19265 * displayed. After changing the item class, elm_genlist_item_update() is
19266 * called on the item @p it.
19270 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19271 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19273 * Set the text to be shown in a given genlist item's tooltips.
19275 * @param item The genlist item
19276 * @param text The text to set in the content
19278 * This call will setup the text to be used as tooltip to that item
19279 * (analogous to elm_object_tooltip_text_set(), but being item
19280 * tooltips with higher precedence than object tooltips). It can
19281 * have only one tooltip at a time, so any previous tooltip data
19282 * will get removed.
19284 * In order to set an icon or something else as a tooltip, look at
19285 * elm_genlist_item_tooltip_content_cb_set().
19289 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19291 * Set the content to be shown in a given genlist item's tooltips
19293 * @param item The genlist item.
19294 * @param func The function returning the tooltip contents.
19295 * @param data What to provide to @a func as callback data/context.
19296 * @param del_cb Called when data is not needed anymore, either when
19297 * another callback replaces @p func, the tooltip is unset with
19298 * elm_genlist_item_tooltip_unset() or the owner @p item
19299 * dies. This callback receives as its first parameter the
19300 * given @p data, being @c event_info the item handle.
19302 * This call will setup the tooltip's contents to @p item
19303 * (analogous to elm_object_tooltip_content_cb_set(), but being
19304 * item tooltips with higher precedence than object tooltips). It
19305 * can have only one tooltip at a time, so any previous tooltip
19306 * content will get removed. @p func (with @p data) will be called
19307 * every time Elementary needs to show the tooltip and it should
19308 * return a valid Evas object, which will be fully managed by the
19309 * tooltip system, getting deleted when the tooltip is gone.
19311 * In order to set just a text as a tooltip, look at
19312 * elm_genlist_item_tooltip_text_set().
19316 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);
19318 * Unset a tooltip from a given genlist item
19320 * @param item genlist item to remove a previously set tooltip from.
19322 * This call removes any tooltip set on @p item. The callback
19323 * provided as @c del_cb to
19324 * elm_genlist_item_tooltip_content_cb_set() will be called to
19325 * notify it is not used anymore (and have resources cleaned, if
19328 * @see elm_genlist_item_tooltip_content_cb_set()
19332 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19334 * Set a different @b style for a given genlist item's tooltip.
19336 * @param item genlist item with tooltip set
19337 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19338 * "default", @c "transparent", etc)
19340 * Tooltips can have <b>alternate styles</b> to be displayed on,
19341 * which are defined by the theme set on Elementary. This function
19342 * works analogously as elm_object_tooltip_style_set(), but here
19343 * applied only to genlist item objects. The default style for
19344 * tooltips is @c "default".
19346 * @note before you set a style you should define a tooltip with
19347 * elm_genlist_item_tooltip_content_cb_set() or
19348 * elm_genlist_item_tooltip_text_set()
19350 * @see elm_genlist_item_tooltip_style_get()
19354 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19356 * Get the style set a given genlist item's tooltip.
19358 * @param item genlist item with tooltip already set on.
19359 * @return style the theme style in use, which defaults to
19360 * "default". If the object does not have a tooltip set,
19361 * then @c NULL is returned.
19363 * @see elm_genlist_item_tooltip_style_set() for more details
19367 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19369 * Set the type of mouse pointer/cursor decoration to be shown,
19370 * when the mouse pointer is over the given genlist widget item
19372 * @param item genlist item to customize cursor on
19373 * @param cursor the cursor type's name
19375 * This function works analogously as elm_object_cursor_set(), but
19376 * here the cursor's changing area is restricted to the item's
19377 * area, and not the whole widget's. Note that that item cursors
19378 * have precedence over widget cursors, so that a mouse over @p
19379 * item will always show cursor @p type.
19381 * If this function is called twice for an object, a previously set
19382 * cursor will be unset on the second call.
19384 * @see elm_object_cursor_set()
19385 * @see elm_genlist_item_cursor_get()
19386 * @see elm_genlist_item_cursor_unset()
19390 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19392 * Get the type of mouse pointer/cursor decoration set to be shown,
19393 * when the mouse pointer is over the given genlist widget item
19395 * @param item genlist item with custom cursor set
19396 * @return the cursor type's name or @c NULL, if no custom cursors
19397 * were set to @p item (and on errors)
19399 * @see elm_object_cursor_get()
19400 * @see elm_genlist_item_cursor_set() for more details
19401 * @see elm_genlist_item_cursor_unset()
19405 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19407 * Unset any custom mouse pointer/cursor decoration set to be
19408 * shown, when the mouse pointer is over the given genlist widget
19409 * item, thus making it show the @b default cursor again.
19411 * @param item a genlist item
19413 * Use this call to undo any custom settings on this item's cursor
19414 * decoration, bringing it back to defaults (no custom style set).
19416 * @see elm_object_cursor_unset()
19417 * @see elm_genlist_item_cursor_set() for more details
19421 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19423 * Set a different @b style for a given custom cursor set for a
19426 * @param item genlist item with custom cursor set
19427 * @param style the <b>theme style</b> to use (e.g. @c "default",
19428 * @c "transparent", etc)
19430 * This function only makes sense when one is using custom mouse
19431 * cursor decorations <b>defined in a theme file</b> , which can
19432 * have, given a cursor name/type, <b>alternate styles</b> on
19433 * it. It works analogously as elm_object_cursor_style_set(), but
19434 * here applied only to genlist item objects.
19436 * @warning Before you set a cursor style you should have defined a
19437 * custom cursor previously on the item, with
19438 * elm_genlist_item_cursor_set()
19440 * @see elm_genlist_item_cursor_engine_only_set()
19441 * @see elm_genlist_item_cursor_style_get()
19445 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19447 * Get the current @b style set for a given genlist item's custom
19450 * @param item genlist item with custom cursor set.
19451 * @return style the cursor style in use. If the object does not
19452 * have a cursor set, then @c NULL is returned.
19454 * @see elm_genlist_item_cursor_style_set() for more details
19458 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19460 * Set if the (custom) cursor for a given genlist item should be
19461 * searched in its theme, also, or should only rely on the
19462 * rendering engine.
19464 * @param item item with custom (custom) cursor already set on
19465 * @param engine_only Use @c EINA_TRUE to have cursors looked for
19466 * only on those provided by the rendering engine, @c EINA_FALSE to
19467 * have them searched on the widget's theme, as well.
19469 * @note This call is of use only if you've set a custom cursor
19470 * for genlist items, with elm_genlist_item_cursor_set().
19472 * @note By default, cursors will only be looked for between those
19473 * provided by the rendering engine.
19477 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19479 * Get if the (custom) cursor for a given genlist item is being
19480 * searched in its theme, also, or is only relying on the rendering
19483 * @param item a genlist item
19484 * @return @c EINA_TRUE, if cursors are being looked for only on
19485 * those provided by the rendering engine, @c EINA_FALSE if they
19486 * are being searched on the widget's theme, as well.
19488 * @see elm_genlist_item_cursor_engine_only_set(), for more details
19492 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19494 * Update the contents of all realized items.
19496 * @param obj The genlist object.
19498 * This updates all realized items by calling all the item class functions again
19499 * to get the icons, labels and states. Use this when the original
19500 * item data has changed and the changes are desired to be reflected.
19502 * To update just one item, use elm_genlist_item_update().
19504 * @see elm_genlist_realized_items_get()
19505 * @see elm_genlist_item_update()
19509 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19511 * Activate a genlist mode on an item
19513 * @param item The genlist item
19514 * @param mode Mode name
19515 * @param mode_set Boolean to define set or unset mode.
19517 * A genlist mode is a different way of selecting an item. Once a mode is
19518 * activated on an item, any other selected item is immediately unselected.
19519 * This feature provides an easy way of implementing a new kind of animation
19520 * for selecting an item, without having to entirely rewrite the item style
19521 * theme. However, the elm_genlist_selected_* API can't be used to get what
19522 * item is activate for a mode.
19524 * The current item style will still be used, but applying a genlist mode to
19525 * an item will select it using a different kind of animation.
19527 * The current active item for a mode can be found by
19528 * elm_genlist_mode_item_get().
19530 * The characteristics of genlist mode are:
19531 * - Only one mode can be active at any time, and for only one item.
19532 * - Genlist handles deactivating other items when one item is activated.
19533 * - A mode is defined in the genlist theme (edc), and more modes can easily
19535 * - A mode style and the genlist item style are different things. They
19536 * can be combined to provide a default style to the item, with some kind
19537 * of animation for that item when the mode is activated.
19539 * When a mode is activated on an item, a new view for that item is created.
19540 * The theme of this mode defines the animation that will be used to transit
19541 * the item from the old view to the new view. This second (new) view will be
19542 * active for that item while the mode is active on the item, and will be
19543 * destroyed after the mode is totally deactivated from that item.
19545 * @see elm_genlist_mode_get()
19546 * @see elm_genlist_mode_item_get()
19550 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19552 * Get the last (or current) genlist mode used.
19554 * @param obj The genlist object
19556 * This function just returns the name of the last used genlist mode. It will
19557 * be the current mode if it's still active.
19559 * @see elm_genlist_item_mode_set()
19560 * @see elm_genlist_mode_item_get()
19564 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19566 * Get active genlist mode item
19568 * @param obj The genlist object
19569 * @return The active item for that current mode. Or @c NULL if no item is
19570 * activated with any mode.
19572 * This function returns the item that was activated with a mode, by the
19573 * function elm_genlist_item_mode_set().
19575 * @see elm_genlist_item_mode_set()
19576 * @see elm_genlist_mode_get()
19580 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19585 * @param obj The genlist object
19586 * @param reorder_mode The reorder mode
19587 * (EINA_TRUE = on, EINA_FALSE = off)
19591 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19594 * Get the reorder mode
19596 * @param obj The genlist object
19597 * @return The reorder mode
19598 * (EINA_TRUE = on, EINA_FALSE = off)
19602 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19604 EAPI void elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
19605 EAPI Eina_Bool elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19606 EAPI void elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
19607 EAPI Eina_Bool elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19608 EAPI void elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
19609 EAPI void elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
19610 EAPI void elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19611 EAPI void elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19612 EAPI void elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19613 EAPI Eina_Bool elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19620 * @defgroup Check Check
19622 * @image html img/widget/check/preview-00.png
19623 * @image latex img/widget/check/preview-00.eps
19624 * @image html img/widget/check/preview-01.png
19625 * @image latex img/widget/check/preview-01.eps
19626 * @image html img/widget/check/preview-02.png
19627 * @image latex img/widget/check/preview-02.eps
19629 * @brief The check widget allows for toggling a value between true and
19632 * Check objects are a lot like radio objects in layout and functionality
19633 * except they do not work as a group, but independently and only toggle the
19634 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19635 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19636 * returns the current state. For convenience, like the radio objects, you
19637 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19638 * for it to modify.
19640 * Signals that you can add callbacks for are:
19641 * "changed" - This is called whenever the user changes the state of one of
19642 * the check object(event_info is NULL).
19644 * Default contents parts of the check widget that you can use for are:
19645 * @li "icon" - A icon of the check
19647 * Default text parts of the check widget that you can use for are:
19648 * @li "elm.text" - Label of the check
19650 * @ref tutorial_check should give you a firm grasp of how to use this widget
19655 * @brief Add a new Check object
19657 * @param parent The parent object
19658 * @return The new object or NULL if it cannot be created
19660 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19662 * @brief Set the text label of the check object
19664 * @param obj The check object
19665 * @param label The text label string in UTF-8
19667 * @deprecated use elm_object_text_set() instead.
19669 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19671 * @brief Get the text label of the check object
19673 * @param obj The check object
19674 * @return The text label string in UTF-8
19676 * @deprecated use elm_object_text_get() instead.
19678 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19680 * @brief Set the icon object of the check object
19682 * @param obj The check object
19683 * @param icon The icon object
19685 * Once the icon object is set, a previously set one will be deleted.
19686 * If you want to keep that old content object, use the
19687 * elm_object_content_unset() function.
19689 * @deprecated use elm_object_part_content_set() instead.
19692 EINA_DEPRECATED EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19694 * @brief Get the icon object of the check object
19696 * @param obj The check object
19697 * @return The icon object
19699 * @deprecated use elm_object_part_content_get() instead.
19702 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19704 * @brief Unset the icon used for the check object
19706 * @param obj The check object
19707 * @return The icon object that was being used
19709 * Unparent and return the icon object which was set for this widget.
19711 * @deprecated use elm_object_part_content_unset() instead.
19714 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19716 * @brief Set the on/off state of the check object
19718 * @param obj The check object
19719 * @param state The state to use (1 == on, 0 == off)
19721 * This sets the state of the check. If set
19722 * with elm_check_state_pointer_set() the state of that variable is also
19723 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19725 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19727 * @brief Get the state of the check object
19729 * @param obj The check object
19730 * @return The boolean state
19732 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19734 * @brief Set a convenience pointer to a boolean to change
19736 * @param obj The check object
19737 * @param statep Pointer to the boolean to modify
19739 * This sets a pointer to a boolean, that, in addition to the check objects
19740 * state will also be modified directly. To stop setting the object pointed
19741 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19742 * then when this is called, the check objects state will also be modified to
19743 * reflect the value of the boolean @p statep points to, just like calling
19744 * elm_check_state_set().
19746 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19751 /* compatibility code for toggle controls */
19753 EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1)
19757 obj = elm_check_add(parent);
19758 elm_object_style_set(obj, "toggle");
19759 elm_object_text_part_set(obj, "on", "ON");
19760 elm_object_text_part_set(obj, "off", "OFF");
19764 EINA_DEPRECATED EAPI extern inline void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1)
19766 elm_object_text_set(obj, label);
19769 EINA_DEPRECATED EAPI extern inline const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
19771 return elm_object_text_get(obj);
19774 EINA_DEPRECATED EAPI extern inline void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1)
19776 elm_object_content_set(obj, icon);
19779 EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
19781 return elm_object_content_get(obj);
19784 EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1)
19786 return elm_object_content_unset(obj);
19789 EINA_DEPRECATED EAPI extern inline void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1)
19791 elm_object_text_part_set(obj, "on", onlabel);
19792 elm_object_text_part_set(obj, "off", offlabel);
19795 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)
19797 if (onlabel) *onlabel = elm_object_text_part_get(obj, "on");
19798 if (offlabel) *offlabel = elm_object_text_part_get(obj, "off");
19801 EINA_DEPRECATED EAPI extern inline void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1)
19803 elm_check_state_set(obj, state);
19806 EINA_DEPRECATED EAPI extern inline Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
19808 return elm_check_state_get(obj);
19811 EINA_DEPRECATED EAPI extern inline void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1)
19813 elm_check_state_pointer_set(obj, statep);
19817 * @defgroup Radio Radio
19819 * @image html img/widget/radio/preview-00.png
19820 * @image latex img/widget/radio/preview-00.eps
19822 * @brief Radio is a widget that allows for 1 or more options to be displayed
19823 * and have the user choose only 1 of them.
19825 * A radio object contains an indicator, an optional Label and an optional
19826 * icon object. While it's possible to have a group of only one radio they,
19827 * are normally used in groups of 2 or more. To add a radio to a group use
19828 * elm_radio_group_add(). The radio object(s) will select from one of a set
19829 * of integer values, so any value they are configuring needs to be mapped to
19830 * a set of integers. To configure what value that radio object represents,
19831 * use elm_radio_state_value_set() to set the integer it represents. To set
19832 * the value the whole group(which one is currently selected) is to indicate
19833 * use elm_radio_value_set() on any group member, and to get the groups value
19834 * use elm_radio_value_get(). For convenience the radio objects are also able
19835 * to directly set an integer(int) to the value that is selected. To specify
19836 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
19837 * The radio objects will modify this directly. That implies the pointer must
19838 * point to valid memory for as long as the radio objects exist.
19840 * Signals that you can add callbacks for are:
19841 * @li changed - This is called whenever the user changes the state of one of
19842 * the radio objects within the group of radio objects that work together.
19844 * Default contents parts of the radio widget that you can use for are:
19845 * @li "icon" - A icon of the radio
19847 * @ref tutorial_radio show most of this API in action.
19851 * @brief Add a new radio to the parent
19853 * @param parent The parent object
19854 * @return The new object or NULL if it cannot be created
19856 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19858 * @brief Set the text label of the radio object
19860 * @param obj The radio object
19861 * @param label The text label string in UTF-8
19863 * @deprecated use elm_object_text_set() instead.
19865 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19867 * @brief Get the text label of the radio object
19869 * @param obj The radio object
19870 * @return The text label string in UTF-8
19872 * @deprecated use elm_object_text_set() instead.
19874 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19876 * @brief Set the icon object of the radio object
19878 * @param obj The radio object
19879 * @param icon The icon object
19881 * Once the icon object is set, a previously set one will be deleted. If you
19882 * want to keep that old content object, use the elm_radio_icon_unset()
19885 * @deprecated use elm_object_part_content_set() instead.
19888 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19890 * @brief Get the icon object of the radio object
19892 * @param obj The radio object
19893 * @return The icon object
19895 * @see elm_radio_icon_set()
19897 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19899 * @brief Unset the icon used for the radio object
19901 * @param obj The radio object
19902 * @return The icon object that was being used
19904 * Unparent and return the icon object which was set for this widget.
19906 * @see elm_radio_icon_set()
19907 * @deprecated use elm_object_content_unset() instead.
19909 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19911 * @brief Add this radio to a group of other radio objects
19913 * @param obj The radio object
19914 * @param group Any object whose group the @p obj is to join.
19916 * Radio objects work in groups. Each member should have a different integer
19917 * value assigned. In order to have them work as a group, they need to know
19918 * about each other. This adds the given radio object to the group of which
19919 * the group object indicated is a member.
19921 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
19923 * @brief Set the integer value that this radio object represents
19925 * @param obj The radio object
19926 * @param value The value to use if this radio object is selected
19928 * This sets the value of the radio.
19930 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19932 * @brief Get the integer value that this radio object represents
19934 * @param obj The radio object
19935 * @return The value used if this radio object is selected
19937 * This gets the value of the radio.
19939 * @see elm_radio_value_set()
19941 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19943 * @brief Set the value of the radio.
19945 * @param obj The radio object
19946 * @param value The value to use for the group
19948 * This sets the value of the radio group and will also set the value if
19949 * pointed to, to the value supplied, but will not call any callbacks.
19951 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19953 * @brief Get the state of the radio object
19955 * @param obj The radio object
19956 * @return The integer state
19958 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19960 * @brief Set a convenience pointer to a integer to change
19962 * @param obj The radio object
19963 * @param valuep Pointer to the integer to modify
19965 * This sets a pointer to a integer, that, in addition to the radio objects
19966 * state will also be modified directly. To stop setting the object pointed
19967 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
19968 * when this is called, the radio objects state will also be modified to
19969 * reflect the value of the integer valuep points to, just like calling
19970 * elm_radio_value_set().
19972 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
19978 * @defgroup Pager Pager
19980 * @image html img/widget/pager/preview-00.png
19981 * @image latex img/widget/pager/preview-00.eps
19983 * @brief Widget that allows flipping between 1 or more “pages” of objects.
19985 * The flipping between “pages” of objects is animated. All content in pager
19986 * is kept in a stack, the last content to be added will be on the top of the
19987 * stack(be visible).
19989 * Objects can be pushed or popped from the stack or deleted as normal.
19990 * Pushes and pops will animate (and a pop will delete the object once the
19991 * animation is finished). Any object already in the pager can be promoted to
19992 * the top(from its current stacking position) through the use of
19993 * elm_pager_content_promote(). Objects are pushed to the top with
19994 * elm_pager_content_push() and when the top item is no longer wanted, simply
19995 * pop it with elm_pager_content_pop() and it will also be deleted. If an
19996 * object is no longer needed and is not the top item, just delete it as
19997 * normal. You can query which objects are the top and bottom with
19998 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20000 * Signals that you can add callbacks for are:
20001 * "hide,finished" - when the previous page is hided
20003 * This widget has the following styles available:
20006 * @li fade_translucide
20007 * @li fade_invisible
20008 * @note This styles affect only the flipping animations, the appearance when
20009 * not animating is unaffected by styles.
20011 * @ref tutorial_pager gives a good overview of the usage of the API.
20015 * Add a new pager to the parent
20017 * @param parent The parent object
20018 * @return The new object or NULL if it cannot be created
20022 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20024 * @brief Push an object to the top of the pager stack (and show it).
20026 * @param obj The pager object
20027 * @param content The object to push
20029 * The object pushed becomes a child of the pager, it will be controlled and
20030 * deleted when the pager is deleted.
20032 * @note If the content is already in the stack use
20033 * elm_pager_content_promote().
20034 * @warning Using this function on @p content already in the stack results in
20035 * undefined behavior.
20037 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20039 * @brief Pop the object that is on top of the stack
20041 * @param obj The pager object
20043 * This pops the object that is on the top(visible) of the pager, makes it
20044 * disappear, then deletes the object. The object that was underneath it on
20045 * the stack will become visible.
20047 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20049 * @brief Moves an object already in the pager stack to the top of the stack.
20051 * @param obj The pager object
20052 * @param content The object to promote
20054 * This will take the @p content and move it to the top of the stack as
20055 * if it had been pushed there.
20057 * @note If the content isn't already in the stack use
20058 * elm_pager_content_push().
20059 * @warning Using this function on @p content not already in the stack
20060 * results in undefined behavior.
20062 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20064 * @brief Return the object at the bottom of the pager stack
20066 * @param obj The pager object
20067 * @return The bottom object or NULL if none
20069 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20071 * @brief Return the object at the top of the pager stack
20073 * @param obj The pager object
20074 * @return The top object or NULL if none
20076 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20078 EAPI void elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
20079 EINA_DEPRECATED EAPI void elm_pager_animation_disabled_set(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
20086 * @defgroup Slideshow Slideshow
20088 * @image html img/widget/slideshow/preview-00.png
20089 * @image latex img/widget/slideshow/preview-00.eps
20091 * This widget, as the name indicates, is a pre-made image
20092 * slideshow panel, with API functions acting on (child) image
20093 * items presentation. Between those actions, are:
20094 * - advance to next/previous image
20095 * - select the style of image transition animation
20096 * - set the exhibition time for each image
20097 * - start/stop the slideshow
20099 * The transition animations are defined in the widget's theme,
20100 * consequently new animations can be added without having to
20101 * update the widget's code.
20103 * @section Slideshow_Items Slideshow items
20105 * For slideshow items, just like for @ref Genlist "genlist" ones,
20106 * the user defines a @b classes, specifying functions that will be
20107 * called on the item's creation and deletion times.
20109 * The #Elm_Slideshow_Item_Class structure contains the following
20112 * - @c func.get - When an item is displayed, this function is
20113 * called, and it's where one should create the item object, de
20114 * facto. For example, the object can be a pure Evas image object
20115 * or an Elementary @ref Photocam "photocam" widget. See
20116 * #SlideshowItemGetFunc.
20117 * - @c func.del - When an item is no more displayed, this function
20118 * is called, where the user must delete any data associated to
20119 * the item. See #SlideshowItemDelFunc.
20121 * @section Slideshow_Caching Slideshow caching
20123 * The slideshow provides facilities to have items adjacent to the
20124 * one being displayed <b>already "realized"</b> (i.e. loaded) for
20125 * you, so that the system does not have to decode image data
20126 * anymore at the time it has to actually switch images on its
20127 * viewport. The user is able to set the numbers of items to be
20128 * cached @b before and @b after the current item, in the widget's
20131 * Smart events one can add callbacks for are:
20133 * - @c "changed" - when the slideshow switches its view to a new
20136 * List of examples for the slideshow widget:
20137 * @li @ref slideshow_example
20141 * @addtogroup Slideshow
20145 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20146 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20147 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
20148 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20149 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20152 * @struct _Elm_Slideshow_Item_Class
20154 * Slideshow item class definition. See @ref Slideshow_Items for
20157 struct _Elm_Slideshow_Item_Class
20159 struct _Elm_Slideshow_Item_Class_Func
20161 SlideshowItemGetFunc get;
20162 SlideshowItemDelFunc del;
20164 }; /**< #Elm_Slideshow_Item_Class member definitions */
20167 * Add a new slideshow widget to the given parent Elementary
20168 * (container) object
20170 * @param parent The parent object
20171 * @return A new slideshow widget handle or @c NULL, on errors
20173 * This function inserts a new slideshow widget on the canvas.
20175 * @ingroup Slideshow
20177 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20180 * Add (append) a new item in a given slideshow widget.
20182 * @param obj The slideshow object
20183 * @param itc The item class for the item
20184 * @param data The item's data
20185 * @return A handle to the item added or @c NULL, on errors
20187 * Add a new item to @p obj's internal list of items, appending it.
20188 * The item's class must contain the function really fetching the
20189 * image object to show for this item, which could be an Evas image
20190 * object or an Elementary photo, for example. The @p data
20191 * parameter is going to be passed to both class functions of the
20194 * @see #Elm_Slideshow_Item_Class
20195 * @see elm_slideshow_item_sorted_insert()
20197 * @ingroup Slideshow
20199 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20202 * Insert a new item into the given slideshow widget, using the @p func
20203 * function to sort items (by item handles).
20205 * @param obj The slideshow object
20206 * @param itc The item class for the item
20207 * @param data The item's data
20208 * @param func The comparing function to be used to sort slideshow
20209 * items <b>by #Elm_Slideshow_Item item handles</b>
20210 * @return Returns The slideshow item handle, on success, or
20211 * @c NULL, on errors
20213 * Add a new item to @p obj's internal list of items, in a position
20214 * determined by the @p func comparing function. The item's class
20215 * must contain the function really fetching the image object to
20216 * show for this item, which could be an Evas image object or an
20217 * Elementary photo, for example. The @p data parameter is going to
20218 * be passed to both class functions of the item.
20220 * @see #Elm_Slideshow_Item_Class
20221 * @see elm_slideshow_item_add()
20223 * @ingroup Slideshow
20225 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);
20228 * Display a given slideshow widget's item, programmatically.
20230 * @param obj The slideshow object
20231 * @param item The item to display on @p obj's viewport
20233 * The change between the current item and @p item will use the
20234 * transition @p obj is set to use (@see
20235 * elm_slideshow_transition_set()).
20237 * @ingroup Slideshow
20239 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20242 * Slide to the @b next item, in a given slideshow widget
20244 * @param obj The slideshow object
20246 * The sliding animation @p obj is set to use will be the
20247 * transition effect used, after this call is issued.
20249 * @note If the end of the slideshow's internal list of items is
20250 * reached, it'll wrap around to the list's beginning, again.
20252 * @ingroup Slideshow
20254 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20257 * Slide to the @b previous item, in a given slideshow widget
20259 * @param obj The slideshow object
20261 * The sliding animation @p obj is set to use will be the
20262 * transition effect used, after this call is issued.
20264 * @note If the beginning of the slideshow's internal list of items
20265 * is reached, it'll wrap around to the list's end, again.
20267 * @ingroup Slideshow
20269 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20272 * Returns the list of sliding transition/effect names available, for a
20273 * given slideshow widget.
20275 * @param obj The slideshow object
20276 * @return The list of transitions (list of @b stringshared strings
20279 * The transitions, which come from @p obj's theme, must be an EDC
20280 * data item named @c "transitions" on the theme file, with (prefix)
20281 * names of EDC programs actually implementing them.
20283 * The available transitions for slideshows on the default theme are:
20284 * - @c "fade" - the current item fades out, while the new one
20285 * fades in to the slideshow's viewport.
20286 * - @c "black_fade" - the current item fades to black, and just
20287 * then, the new item will fade in.
20288 * - @c "horizontal" - the current item slides horizontally, until
20289 * it gets out of the slideshow's viewport, while the new item
20290 * comes from the left to take its place.
20291 * - @c "vertical" - the current item slides vertically, until it
20292 * gets out of the slideshow's viewport, while the new item comes
20293 * from the bottom to take its place.
20294 * - @c "square" - the new item starts to appear from the middle of
20295 * the current one, but with a tiny size, growing until its
20296 * target (full) size and covering the old one.
20298 * @warning The stringshared strings get no new references
20299 * exclusive to the user grabbing the list, here, so if you'd like
20300 * to use them out of this call's context, you'd better @c
20301 * eina_stringshare_ref() them.
20303 * @see elm_slideshow_transition_set()
20305 * @ingroup Slideshow
20307 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20310 * Set the current slide transition/effect in use for a given
20313 * @param obj The slideshow object
20314 * @param transition The new transition's name string
20316 * If @p transition is implemented in @p obj's theme (i.e., is
20317 * contained in the list returned by
20318 * elm_slideshow_transitions_get()), this new sliding effect will
20319 * be used on the widget.
20321 * @see elm_slideshow_transitions_get() for more details
20323 * @ingroup Slideshow
20325 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20328 * Get the current slide transition/effect in use for a given
20331 * @param obj The slideshow object
20332 * @return The current transition's name
20334 * @see elm_slideshow_transition_set() for more details
20336 * @ingroup Slideshow
20338 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20341 * Set the interval between each image transition on a given
20342 * slideshow widget, <b>and start the slideshow, itself</b>
20344 * @param obj The slideshow object
20345 * @param timeout The new displaying timeout for images
20347 * After this call, the slideshow widget will start cycling its
20348 * view, sequentially and automatically, with the images of the
20349 * items it has. The time between each new image displayed is going
20350 * to be @p timeout, in @b seconds. If a different timeout was set
20351 * previously and an slideshow was in progress, it will continue
20352 * with the new time between transitions, after this call.
20354 * @note A value less than or equal to 0 on @p timeout will disable
20355 * the widget's internal timer, thus halting any slideshow which
20356 * could be happening on @p obj.
20358 * @see elm_slideshow_timeout_get()
20360 * @ingroup Slideshow
20362 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20365 * Get the interval set for image transitions on a given slideshow
20368 * @param obj The slideshow object
20369 * @return Returns the timeout set on it
20371 * @see elm_slideshow_timeout_set() for more details
20373 * @ingroup Slideshow
20375 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20378 * Set if, after a slideshow is started, for a given slideshow
20379 * widget, its items should be displayed cyclically or not.
20381 * @param obj The slideshow object
20382 * @param loop Use @c EINA_TRUE to make it cycle through items or
20383 * @c EINA_FALSE for it to stop at the end of @p obj's internal
20386 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20387 * ignore what is set by this functions, i.e., they'll @b always
20388 * cycle through items. This affects only the "automatic"
20389 * slideshow, as set by elm_slideshow_timeout_set().
20391 * @see elm_slideshow_loop_get()
20393 * @ingroup Slideshow
20395 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20398 * Get if, after a slideshow is started, for a given slideshow
20399 * widget, its items are to be displayed cyclically or not.
20401 * @param obj The slideshow object
20402 * @return @c EINA_TRUE, if the items in @p obj will be cycled
20403 * through or @c EINA_FALSE, otherwise
20405 * @see elm_slideshow_loop_set() for more details
20407 * @ingroup Slideshow
20409 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20412 * Remove all items from a given slideshow widget
20414 * @param obj The slideshow object
20416 * This removes (and deletes) all items in @p obj, leaving it
20419 * @see elm_slideshow_item_del(), to remove just one item.
20421 * @ingroup Slideshow
20423 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20426 * Get the internal list of items in a given slideshow widget.
20428 * @param obj The slideshow object
20429 * @return The list of items (#Elm_Slideshow_Item as data) or
20430 * @c NULL on errors.
20432 * This list is @b not to be modified in any way and must not be
20433 * freed. Use the list members with functions like
20434 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20436 * @warning This list is only valid until @p obj object's internal
20437 * items list is changed. It should be fetched again with another
20438 * call to this function when changes happen.
20440 * @ingroup Slideshow
20442 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20445 * Delete a given item from a slideshow widget.
20447 * @param item The slideshow item
20449 * @ingroup Slideshow
20451 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20454 * Return the data associated with a given slideshow item
20456 * @param item The slideshow item
20457 * @return Returns the data associated to this item
20459 * @ingroup Slideshow
20461 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20464 * Returns the currently displayed item, in a given slideshow widget
20466 * @param obj The slideshow object
20467 * @return A handle to the item being displayed in @p obj or
20468 * @c NULL, if none is (and on errors)
20470 * @ingroup Slideshow
20472 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20475 * Get the real Evas object created to implement the view of a
20476 * given slideshow item
20478 * @param item The slideshow item.
20479 * @return the Evas object implementing this item's view.
20481 * This returns the actual Evas object used to implement the
20482 * specified slideshow item's view. This may be @c NULL, as it may
20483 * not have been created or may have been deleted, at any time, by
20484 * the slideshow. <b>Do not modify this object</b> (move, resize,
20485 * show, hide, etc.), as the slideshow is controlling it. This
20486 * function is for querying, emitting custom signals or hooking
20487 * lower level callbacks for events on that object. Do not delete
20488 * this object under any circumstances.
20490 * @see elm_slideshow_item_data_get()
20492 * @ingroup Slideshow
20494 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20497 * Get the the item, in a given slideshow widget, placed at
20498 * position @p nth, in its internal items list
20500 * @param obj The slideshow object
20501 * @param nth The number of the item to grab a handle to (0 being
20503 * @return The item stored in @p obj at position @p nth or @c NULL,
20504 * if there's no item with that index (and on errors)
20506 * @ingroup Slideshow
20508 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20511 * Set the current slide layout in use for a given slideshow widget
20513 * @param obj The slideshow object
20514 * @param layout The new layout's name string
20516 * If @p layout is implemented in @p obj's theme (i.e., is contained
20517 * in the list returned by elm_slideshow_layouts_get()), this new
20518 * images layout will be used on the widget.
20520 * @see elm_slideshow_layouts_get() for more details
20522 * @ingroup Slideshow
20524 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20527 * Get the current slide layout in use for a given slideshow widget
20529 * @param obj The slideshow object
20530 * @return The current layout's name
20532 * @see elm_slideshow_layout_set() for more details
20534 * @ingroup Slideshow
20536 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20539 * Returns the list of @b layout names available, for a given
20540 * slideshow widget.
20542 * @param obj The slideshow object
20543 * @return The list of layouts (list of @b stringshared strings
20546 * Slideshow layouts will change how the widget is to dispose each
20547 * image item in its viewport, with regard to cropping, scaling,
20550 * The layouts, which come from @p obj's theme, must be an EDC
20551 * data item name @c "layouts" on the theme file, with (prefix)
20552 * names of EDC programs actually implementing them.
20554 * The available layouts for slideshows on the default theme are:
20555 * - @c "fullscreen" - item images with original aspect, scaled to
20556 * touch top and down slideshow borders or, if the image's heigh
20557 * is not enough, left and right slideshow borders.
20558 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20559 * one, but always leaving 10% of the slideshow's dimensions of
20560 * distance between the item image's borders and the slideshow
20561 * borders, for each axis.
20563 * @warning The stringshared strings get no new references
20564 * exclusive to the user grabbing the list, here, so if you'd like
20565 * to use them out of this call's context, you'd better @c
20566 * eina_stringshare_ref() them.
20568 * @see elm_slideshow_layout_set()
20570 * @ingroup Slideshow
20572 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20575 * Set the number of items to cache, on a given slideshow widget,
20576 * <b>before the current item</b>
20578 * @param obj The slideshow object
20579 * @param count Number of items to cache before the current one
20581 * The default value for this property is @c 2. See
20582 * @ref Slideshow_Caching "slideshow caching" for more details.
20584 * @see elm_slideshow_cache_before_get()
20586 * @ingroup Slideshow
20588 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20591 * Retrieve the number of items to cache, on a given slideshow widget,
20592 * <b>before the current item</b>
20594 * @param obj The slideshow object
20595 * @return The number of items set to be cached before the current one
20597 * @see elm_slideshow_cache_before_set() for more details
20599 * @ingroup Slideshow
20601 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20604 * Set the number of items to cache, on a given slideshow widget,
20605 * <b>after the current item</b>
20607 * @param obj The slideshow object
20608 * @param count Number of items to cache after the current one
20610 * The default value for this property is @c 2. See
20611 * @ref Slideshow_Caching "slideshow caching" for more details.
20613 * @see elm_slideshow_cache_after_get()
20615 * @ingroup Slideshow
20617 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20620 * Retrieve the number of items to cache, on a given slideshow widget,
20621 * <b>after the current item</b>
20623 * @param obj The slideshow object
20624 * @return The number of items set to be cached after the current one
20626 * @see elm_slideshow_cache_after_set() for more details
20628 * @ingroup Slideshow
20630 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20633 * Get the number of items stored in a given slideshow widget
20635 * @param obj The slideshow object
20636 * @return The number of items on @p obj, at the moment of this call
20638 * @ingroup Slideshow
20640 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20647 * @defgroup Fileselector File Selector
20649 * @image html img/widget/fileselector/preview-00.png
20650 * @image latex img/widget/fileselector/preview-00.eps
20652 * A file selector is a widget that allows a user to navigate
20653 * through a file system, reporting file selections back via its
20656 * It contains shortcut buttons for home directory (@c ~) and to
20657 * jump one directory upwards (..), as well as cancel/ok buttons to
20658 * confirm/cancel a given selection. After either one of those two
20659 * former actions, the file selector will issue its @c "done" smart
20662 * There's a text entry on it, too, showing the name of the current
20663 * selection. There's the possibility of making it editable, so it
20664 * is useful on file saving dialogs on applications, where one
20665 * gives a file name to save contents to, in a given directory in
20666 * the system. This custom file name will be reported on the @c
20667 * "done" smart callback (explained in sequence).
20669 * Finally, it has a view to display file system items into in two
20674 * If Elementary is built with support of the Ethumb thumbnailing
20675 * library, the second form of view will display preview thumbnails
20676 * of files which it supports.
20678 * Smart callbacks one can register to:
20680 * - @c "selected" - the user has clicked on a file (when not in
20681 * folders-only mode) or directory (when in folders-only mode)
20682 * - @c "directory,open" - the list has been populated with new
20683 * content (@c event_info is a pointer to the directory's
20684 * path, a @b stringshared string)
20685 * - @c "done" - the user has clicked on the "ok" or "cancel"
20686 * buttons (@c event_info is a pointer to the selection's
20687 * path, a @b stringshared string)
20689 * Here is an example on its usage:
20690 * @li @ref fileselector_example
20694 * @addtogroup Fileselector
20699 * Defines how a file selector widget is to layout its contents
20700 * (file system entries).
20702 typedef enum _Elm_Fileselector_Mode
20704 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20705 ELM_FILESELECTOR_GRID, /**< layout as a grid */
20706 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20707 } Elm_Fileselector_Mode;
20710 * Add a new file selector widget to the given parent Elementary
20711 * (container) object
20713 * @param parent The parent object
20714 * @return a new file selector widget handle or @c NULL, on errors
20716 * This function inserts a new file selector widget on the canvas.
20718 * @ingroup Fileselector
20720 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20723 * Enable/disable the file name entry box where the user can type
20724 * in a name for a file, in a given file selector widget
20726 * @param obj The file selector object
20727 * @param is_save @c EINA_TRUE to make the file selector a "saving
20728 * dialog", @c EINA_FALSE otherwise
20730 * Having the entry editable is useful on file saving dialogs on
20731 * applications, where one gives a file name to save contents to,
20732 * in a given directory in the system. This custom file name will
20733 * be reported on the @c "done" smart callback.
20735 * @see elm_fileselector_is_save_get()
20737 * @ingroup Fileselector
20739 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20742 * Get whether the given file selector is in "saving dialog" mode
20744 * @param obj The file selector object
20745 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20746 * mode, @c EINA_FALSE otherwise (and on errors)
20748 * @see elm_fileselector_is_save_set() for more details
20750 * @ingroup Fileselector
20752 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20755 * Enable/disable folder-only view for a given file selector widget
20757 * @param obj The file selector object
20758 * @param only @c EINA_TRUE to make @p obj only display
20759 * directories, @c EINA_FALSE to make files to be displayed in it
20762 * If enabled, the widget's view will only display folder items,
20765 * @see elm_fileselector_folder_only_get()
20767 * @ingroup Fileselector
20769 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20772 * Get whether folder-only view is set for a given file selector
20775 * @param obj The file selector object
20776 * @return only @c EINA_TRUE if @p obj is only displaying
20777 * directories, @c EINA_FALSE if files are being displayed in it
20778 * too (and on errors)
20780 * @see elm_fileselector_folder_only_get()
20782 * @ingroup Fileselector
20784 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20787 * Enable/disable the "ok" and "cancel" buttons on a given file
20790 * @param obj The file selector object
20791 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
20793 * @note A file selector without those buttons will never emit the
20794 * @c "done" smart event, and is only usable if one is just hooking
20795 * to the other two events.
20797 * @see elm_fileselector_buttons_ok_cancel_get()
20799 * @ingroup Fileselector
20801 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
20804 * Get whether the "ok" and "cancel" buttons on a given file
20805 * selector widget are being shown.
20807 * @param obj The file selector object
20808 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
20809 * otherwise (and on errors)
20811 * @see elm_fileselector_buttons_ok_cancel_set() for more details
20813 * @ingroup Fileselector
20815 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20818 * Enable/disable a tree view in the given file selector widget,
20819 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
20821 * @param obj The file selector object
20822 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
20825 * In a tree view, arrows are created on the sides of directories,
20826 * allowing them to expand in place.
20828 * @note If it's in other mode, the changes made by this function
20829 * will only be visible when one switches back to "list" mode.
20831 * @see elm_fileselector_expandable_get()
20833 * @ingroup Fileselector
20835 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
20838 * Get whether tree view is enabled for the given file selector
20841 * @param obj The file selector object
20842 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
20843 * otherwise (and or errors)
20845 * @see elm_fileselector_expandable_set() for more details
20847 * @ingroup Fileselector
20849 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20852 * Set, programmatically, the @b directory that a given file
20853 * selector widget will display contents from
20855 * @param obj The file selector object
20856 * @param path The path to display in @p obj
20858 * This will change the @b directory that @p obj is displaying. It
20859 * will also clear the text entry area on the @p obj object, which
20860 * displays select files' names.
20862 * @see elm_fileselector_path_get()
20864 * @ingroup Fileselector
20866 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20869 * Get the parent directory's path that a given file selector
20870 * widget is displaying
20872 * @param obj The file selector object
20873 * @return The (full) path of the directory the file selector is
20874 * displaying, a @b stringshared string
20876 * @see elm_fileselector_path_set()
20878 * @ingroup Fileselector
20880 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20883 * Set, programmatically, the currently selected file/directory in
20884 * the given file selector widget
20886 * @param obj The file selector object
20887 * @param path The (full) path to a file or directory
20888 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
20889 * latter case occurs if the directory or file pointed to do not
20892 * @see elm_fileselector_selected_get()
20894 * @ingroup Fileselector
20896 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20899 * Get the currently selected item's (full) path, in the given file
20902 * @param obj The file selector object
20903 * @return The absolute path of the selected item, a @b
20904 * stringshared string
20906 * @note Custom editions on @p obj object's text entry, if made,
20907 * will appear on the return string of this function, naturally.
20909 * @see elm_fileselector_selected_set() for more details
20911 * @ingroup Fileselector
20913 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20916 * Set the mode in which a given file selector widget will display
20917 * (layout) file system entries in its view
20919 * @param obj The file selector object
20920 * @param mode The mode of the fileselector, being it one of
20921 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
20922 * first one, naturally, will display the files in a list. The
20923 * latter will make the widget to display its entries in a grid
20926 * @note By using elm_fileselector_expandable_set(), the user may
20927 * trigger a tree view for that list.
20929 * @note If Elementary is built with support of the Ethumb
20930 * thumbnailing library, the second form of view will display
20931 * preview thumbnails of files which it supports. You must have
20932 * elm_need_ethumb() called in your Elementary for thumbnailing to
20935 * @see elm_fileselector_expandable_set().
20936 * @see elm_fileselector_mode_get().
20938 * @ingroup Fileselector
20940 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
20943 * Get the mode in which a given file selector widget is displaying
20944 * (layouting) file system entries in its view
20946 * @param obj The fileselector object
20947 * @return The mode in which the fileselector is at
20949 * @see elm_fileselector_mode_set() for more details
20951 * @ingroup Fileselector
20953 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20960 * @defgroup Progressbar Progress bar
20962 * The progress bar is a widget for visually representing the
20963 * progress status of a given job/task.
20965 * A progress bar may be horizontal or vertical. It may display an
20966 * icon besides it, as well as primary and @b units labels. The
20967 * former is meant to label the widget as a whole, while the
20968 * latter, which is formatted with floating point values (and thus
20969 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
20970 * units"</c>), is meant to label the widget's <b>progress
20971 * value</b>. Label, icon and unit strings/objects are @b optional
20972 * for progress bars.
20974 * A progress bar may be @b inverted, in which state it gets its
20975 * values inverted, with high values being on the left or top and
20976 * low values on the right or bottom, as opposed to normally have
20977 * the low values on the former and high values on the latter,
20978 * respectively, for horizontal and vertical modes.
20980 * The @b span of the progress, as set by
20981 * elm_progressbar_span_size_set(), is its length (horizontally or
20982 * vertically), unless one puts size hints on the widget to expand
20983 * on desired directions, by any container. That length will be
20984 * scaled by the object or applications scaling factor. At any
20985 * point code can query the progress bar for its value with
20986 * elm_progressbar_value_get().
20988 * Available widget styles for progress bars:
20990 * - @c "wheel" (simple style, no text, no progression, only
20991 * "pulse" effect is available)
20993 * Default contents parts of the progressbar widget that you can use for are:
20994 * @li "icon" - A icon of the progressbar
20996 * Here is an example on its usage:
20997 * @li @ref progressbar_example
21001 * Add a new progress bar widget to the given parent Elementary
21002 * (container) object
21004 * @param parent The parent object
21005 * @return a new progress bar widget handle or @c NULL, on errors
21007 * This function inserts a new progress bar widget on the canvas.
21009 * @ingroup Progressbar
21011 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21014 * Set whether a given progress bar widget is at "pulsing mode" or
21017 * @param obj The progress bar object
21018 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21019 * @c EINA_FALSE to put it back to its default one
21021 * By default, progress bars will display values from the low to
21022 * high value boundaries. There are, though, contexts in which the
21023 * state of progression of a given task is @b unknown. For those,
21024 * one can set a progress bar widget to a "pulsing state", to give
21025 * the user an idea that some computation is being held, but
21026 * without exact progress values. In the default theme it will
21027 * animate its bar with the contents filling in constantly and back
21028 * to non-filled, in a loop. To start and stop this pulsing
21029 * animation, one has to explicitly call elm_progressbar_pulse().
21031 * @see elm_progressbar_pulse_get()
21032 * @see elm_progressbar_pulse()
21034 * @ingroup Progressbar
21036 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21039 * Get whether a given progress bar widget is at "pulsing mode" or
21042 * @param obj The progress bar object
21043 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21044 * if it's in the default one (and on errors)
21046 * @ingroup Progressbar
21048 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21051 * Start/stop a given progress bar "pulsing" animation, if its
21054 * @param obj The progress bar object
21055 * @param state @c EINA_TRUE, to @b start the pulsing animation,
21056 * @c EINA_FALSE to @b stop it
21058 * @note This call won't do anything if @p obj is not under "pulsing mode".
21060 * @see elm_progressbar_pulse_set() for more details.
21062 * @ingroup Progressbar
21064 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21067 * Set the progress value (in percentage) on a given progress bar
21070 * @param obj The progress bar object
21071 * @param val The progress value (@b must be between @c 0.0 and @c
21074 * Use this call to set progress bar levels.
21076 * @note If you passes a value out of the specified range for @p
21077 * val, it will be interpreted as the @b closest of the @b boundary
21078 * values in the range.
21080 * @ingroup Progressbar
21082 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21085 * Get the progress value (in percentage) on a given progress bar
21088 * @param obj The progress bar object
21089 * @return The value of the progressbar
21091 * @see elm_progressbar_value_set() for more details
21093 * @ingroup Progressbar
21095 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21098 * Set the label of a given progress bar widget
21100 * @param obj The progress bar object
21101 * @param label The text label string, in UTF-8
21103 * @ingroup Progressbar
21104 * @deprecated use elm_object_text_set() instead.
21106 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21109 * Get the label of a given progress bar widget
21111 * @param obj The progressbar object
21112 * @return The text label string, in UTF-8
21114 * @ingroup Progressbar
21115 * @deprecated use elm_object_text_set() instead.
21117 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21120 * Set the icon object of a given progress bar widget
21122 * @param obj The progress bar object
21123 * @param icon The icon object
21125 * Use this call to decorate @p obj with an icon next to it.
21127 * @note Once the icon object is set, a previously set one will be
21128 * deleted. If you want to keep that old content object, use the
21129 * elm_progressbar_icon_unset() function.
21131 * @see elm_progressbar_icon_get()
21132 * @deprecated use elm_object_content_set() instead.
21134 * @ingroup Progressbar
21136 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21139 * Retrieve the icon object set for a given progress bar widget
21141 * @param obj The progress bar object
21142 * @return The icon object's handle, if @p obj had one set, or @c NULL,
21143 * otherwise (and on errors)
21145 * @see elm_progressbar_icon_set() for more details
21146 * @deprecated use elm_object_content_set() instead.
21148 * @ingroup Progressbar
21150 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21153 * Unset an icon set on a given progress bar widget
21155 * @param obj The progress bar object
21156 * @return The icon object that was being used, if any was set, or
21157 * @c NULL, otherwise (and on errors)
21159 * This call will unparent and return the icon object which was set
21160 * for this widget, previously, on success.
21162 * @see elm_progressbar_icon_set() for more details
21163 * @deprecated use elm_object_content_unset() instead.
21165 * @ingroup Progressbar
21167 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21170 * Set the (exact) length of the bar region of a given progress bar
21173 * @param obj The progress bar object
21174 * @param size The length of the progress bar's bar region
21176 * This sets the minimum width (when in horizontal mode) or height
21177 * (when in vertical mode) of the actual bar area of the progress
21178 * bar @p obj. This in turn affects the object's minimum size. Use
21179 * this when you're not setting other size hints expanding on the
21180 * given direction (like weight and alignment hints) and you would
21181 * like it to have a specific size.
21183 * @note Icon, label and unit text around @p obj will require their
21184 * own space, which will make @p obj to require more the @p size,
21187 * @see elm_progressbar_span_size_get()
21189 * @ingroup Progressbar
21191 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21194 * Get the length set for the bar region of a given progress bar
21197 * @param obj The progress bar object
21198 * @return The length of the progress bar's bar region
21200 * If that size was not set previously, with
21201 * elm_progressbar_span_size_set(), this call will return @c 0.
21203 * @ingroup Progressbar
21205 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21208 * Set the format string for a given progress bar widget's units
21211 * @param obj The progress bar object
21212 * @param format The format string for @p obj's units label
21214 * If @c NULL is passed on @p format, it will make @p obj's units
21215 * area to be hidden completely. If not, it'll set the <b>format
21216 * string</b> for the units label's @b text. The units label is
21217 * provided a floating point value, so the units text is up display
21218 * at most one floating point falue. Note that the units label is
21219 * optional. Use a format string such as "%1.2f meters" for
21222 * @note The default format string for a progress bar is an integer
21223 * percentage, as in @c "%.0f %%".
21225 * @see elm_progressbar_unit_format_get()
21227 * @ingroup Progressbar
21229 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21232 * Retrieve the format string set for a given progress bar widget's
21235 * @param obj The progress bar object
21236 * @return The format set string for @p obj's units label or
21237 * @c NULL, if none was set (and on errors)
21239 * @see elm_progressbar_unit_format_set() for more details
21241 * @ingroup Progressbar
21243 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21246 * Set the orientation of a given progress bar widget
21248 * @param obj The progress bar object
21249 * @param horizontal Use @c EINA_TRUE to make @p obj to be
21250 * @b horizontal, @c EINA_FALSE to make it @b vertical
21252 * Use this function to change how your progress bar is to be
21253 * disposed: vertically or horizontally.
21255 * @see elm_progressbar_horizontal_get()
21257 * @ingroup Progressbar
21259 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21262 * Retrieve the orientation of a given progress bar widget
21264 * @param obj The progress bar object
21265 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21266 * @c EINA_FALSE if it's @b vertical (and on errors)
21268 * @see elm_progressbar_horizontal_set() for more details
21270 * @ingroup Progressbar
21272 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21275 * Invert a given progress bar widget's displaying values order
21277 * @param obj The progress bar object
21278 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21279 * @c EINA_FALSE to bring it back to default, non-inverted values.
21281 * A progress bar may be @b inverted, in which state it gets its
21282 * values inverted, with high values being on the left or top and
21283 * low values on the right or bottom, as opposed to normally have
21284 * the low values on the former and high values on the latter,
21285 * respectively, for horizontal and vertical modes.
21287 * @see elm_progressbar_inverted_get()
21289 * @ingroup Progressbar
21291 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21294 * Get whether a given progress bar widget's displaying values are
21297 * @param obj The progress bar object
21298 * @return @c EINA_TRUE, if @p obj has inverted values,
21299 * @c EINA_FALSE otherwise (and on errors)
21301 * @see elm_progressbar_inverted_set() for more details
21303 * @ingroup Progressbar
21305 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21308 * @defgroup Separator Separator
21310 * @brief Separator is a very thin object used to separate other objects.
21312 * A separator can be vertical or horizontal.
21314 * @ref tutorial_separator is a good example of how to use a separator.
21318 * @brief Add a separator object to @p parent
21320 * @param parent The parent object
21322 * @return The separator object, or NULL upon failure
21324 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21326 * @brief Set the horizontal mode of a separator object
21328 * @param obj The separator object
21329 * @param horizontal If true, the separator is horizontal
21331 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21333 * @brief Get the horizontal mode of a separator object
21335 * @param obj The separator object
21336 * @return If true, the separator is horizontal
21338 * @see elm_separator_horizontal_set()
21340 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21346 * @defgroup Spinner Spinner
21347 * @ingroup Elementary
21349 * @image html img/widget/spinner/preview-00.png
21350 * @image latex img/widget/spinner/preview-00.eps
21352 * A spinner is a widget which allows the user to increase or decrease
21353 * numeric values using arrow buttons, or edit values directly, clicking
21354 * over it and typing the new value.
21356 * By default the spinner will not wrap and has a label
21357 * of "%.0f" (just showing the integer value of the double).
21359 * A spinner has a label that is formatted with floating
21360 * point values and thus accepts a printf-style format string, like
21363 * It also allows specific values to be replaced by pre-defined labels.
21365 * Smart callbacks one can register to:
21367 * - "changed" - Whenever the spinner value is changed.
21368 * - "delay,changed" - A short time after the value is changed by the user.
21369 * This will be called only when the user stops dragging for a very short
21370 * period or when they release their finger/mouse, so it avoids possibly
21371 * expensive reactions to the value change.
21373 * Available styles for it:
21375 * - @c "vertical": up/down buttons at the right side and text left aligned.
21377 * Here is an example on its usage:
21378 * @ref spinner_example
21382 * @addtogroup Spinner
21387 * Add a new spinner widget to the given parent Elementary
21388 * (container) object.
21390 * @param parent The parent object.
21391 * @return a new spinner widget handle or @c NULL, on errors.
21393 * This function inserts a new spinner widget on the canvas.
21398 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21401 * Set the format string of the displayed label.
21403 * @param obj The spinner object.
21404 * @param fmt The format string for the label display.
21406 * If @c NULL, this sets the format to "%.0f". If not it sets the format
21407 * string for the label text. The label text is provided a floating point
21408 * value, so the label text can display up to 1 floating point value.
21409 * Note that this is optional.
21411 * Use a format string such as "%1.2f meters" for example, and it will
21412 * display values like: "3.14 meters" for a value equal to 3.14159.
21414 * Default is "%0.f".
21416 * @see elm_spinner_label_format_get()
21420 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21423 * Get the label format of the spinner.
21425 * @param obj The spinner object.
21426 * @return The text label format string in UTF-8.
21428 * @see elm_spinner_label_format_set() for details.
21432 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21435 * Set the minimum and maximum values for the spinner.
21437 * @param obj The spinner object.
21438 * @param min The minimum value.
21439 * @param max The maximum value.
21441 * Define the allowed range of values to be selected by the user.
21443 * If actual value is less than @p min, it will be updated to @p min. If it
21444 * is bigger then @p max, will be updated to @p max. Actual value can be
21445 * get with elm_spinner_value_get().
21447 * By default, min is equal to 0, and max is equal to 100.
21449 * @warning Maximum must be greater than minimum.
21451 * @see elm_spinner_min_max_get()
21455 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21458 * Get the minimum and maximum values of the spinner.
21460 * @param obj The spinner object.
21461 * @param min Pointer where to store the minimum value.
21462 * @param max Pointer where to store the maximum value.
21464 * @note If only one value is needed, the other pointer can be passed
21467 * @see elm_spinner_min_max_set() for details.
21471 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21474 * Set the step used to increment or decrement the spinner value.
21476 * @param obj The spinner object.
21477 * @param step The step value.
21479 * This value will be incremented or decremented to the displayed value.
21480 * It will be incremented while the user keep right or top arrow pressed,
21481 * and will be decremented while the user keep left or bottom arrow pressed.
21483 * The interval to increment / decrement can be set with
21484 * elm_spinner_interval_set().
21486 * By default step value is equal to 1.
21488 * @see elm_spinner_step_get()
21492 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21495 * Get the step used to increment or decrement the spinner value.
21497 * @param obj The spinner object.
21498 * @return The step value.
21500 * @see elm_spinner_step_get() for more details.
21504 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21507 * Set the value the spinner displays.
21509 * @param obj The spinner object.
21510 * @param val The value to be displayed.
21512 * Value will be presented on the label following format specified with
21513 * elm_spinner_format_set().
21515 * @warning The value must to be between min and max values. This values
21516 * are set by elm_spinner_min_max_set().
21518 * @see elm_spinner_value_get().
21519 * @see elm_spinner_format_set().
21520 * @see elm_spinner_min_max_set().
21524 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21527 * Get the value displayed by the spinner.
21529 * @param obj The spinner object.
21530 * @return The value displayed.
21532 * @see elm_spinner_value_set() for details.
21536 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21539 * Set whether the spinner should wrap when it reaches its
21540 * minimum or maximum value.
21542 * @param obj The spinner object.
21543 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21546 * Disabled by default. If disabled, when the user tries to increment the
21548 * but displayed value plus step value is bigger than maximum value,
21550 * won't allow it. The same happens when the user tries to decrement it,
21551 * but the value less step is less than minimum value.
21553 * When wrap is enabled, in such situations it will allow these changes,
21554 * but will get the value that would be less than minimum and subtracts
21555 * from maximum. Or add the value that would be more than maximum to
21559 * @li min value = 10
21560 * @li max value = 50
21561 * @li step value = 20
21562 * @li displayed value = 20
21564 * When the user decrement value (using left or bottom arrow), it will
21565 * displays @c 40, because max - (min - (displayed - step)) is
21566 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21568 * @see elm_spinner_wrap_get().
21572 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21575 * Get whether the spinner should wrap when it reaches its
21576 * minimum or maximum value.
21578 * @param obj The spinner object
21579 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21580 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21582 * @see elm_spinner_wrap_set() for details.
21586 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21589 * Set whether the spinner can be directly edited by the user or not.
21591 * @param obj The spinner object.
21592 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21593 * don't allow users to edit it directly.
21595 * Spinner objects can have edition @b disabled, in which state they will
21596 * be changed only by arrows.
21597 * Useful for contexts
21598 * where you don't want your users to interact with it writting the value.
21600 * when using special values, the user can see real value instead
21601 * of special label on edition.
21603 * It's enabled by default.
21605 * @see elm_spinner_editable_get()
21609 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21612 * Get whether the spinner can be directly edited by the user or not.
21614 * @param obj The spinner object.
21615 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21616 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21618 * @see elm_spinner_editable_set() for details.
21622 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21625 * Set a special string to display in the place of the numerical value.
21627 * @param obj The spinner object.
21628 * @param value The value to be replaced.
21629 * @param label The label to be used.
21631 * It's useful for cases when a user should select an item that is
21632 * better indicated by a label than a value. For example, weekdays or months.
21636 * sp = elm_spinner_add(win);
21637 * elm_spinner_min_max_set(sp, 1, 3);
21638 * elm_spinner_special_value_add(sp, 1, "January");
21639 * elm_spinner_special_value_add(sp, 2, "February");
21640 * elm_spinner_special_value_add(sp, 3, "March");
21641 * evas_object_show(sp);
21646 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21649 * Set the interval on time updates for an user mouse button hold
21650 * on spinner widgets' arrows.
21652 * @param obj The spinner object.
21653 * @param interval The (first) interval value in seconds.
21655 * This interval value is @b decreased while the user holds the
21656 * mouse pointer either incrementing or decrementing spinner's value.
21658 * This helps the user to get to a given value distant from the
21659 * current one easier/faster, as it will start to change quicker and
21660 * quicker on mouse button holds.
21662 * The calculation for the next change interval value, starting from
21663 * the one set with this call, is the previous interval divided by
21664 * @c 1.05, so it decreases a little bit.
21666 * The default starting interval value for automatic changes is
21669 * @see elm_spinner_interval_get()
21673 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21676 * Get the interval on time updates for an user mouse button hold
21677 * on spinner widgets' arrows.
21679 * @param obj The spinner object.
21680 * @return The (first) interval value, in seconds, set on it.
21682 * @see elm_spinner_interval_set() for more details.
21686 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21693 * @defgroup Index Index
21695 * @image html img/widget/index/preview-00.png
21696 * @image latex img/widget/index/preview-00.eps
21698 * An index widget gives you an index for fast access to whichever
21699 * group of other UI items one might have. It's a list of text
21700 * items (usually letters, for alphabetically ordered access).
21702 * Index widgets are by default hidden and just appear when the
21703 * user clicks over it's reserved area in the canvas. In its
21704 * default theme, it's an area one @ref Fingers "finger" wide on
21705 * the right side of the index widget's container.
21707 * When items on the index are selected, smart callbacks get
21708 * called, so that its user can make other container objects to
21709 * show a given area or child object depending on the index item
21710 * selected. You'd probably be using an index together with @ref
21711 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21714 * Smart events one can add callbacks for are:
21715 * - @c "changed" - When the selected index item changes. @c
21716 * event_info is the selected item's data pointer.
21717 * - @c "delay,changed" - When the selected index item changes, but
21718 * after a small idling period. @c event_info is the selected
21719 * item's data pointer.
21720 * - @c "selected" - When the user releases a mouse button and
21721 * selects an item. @c event_info is the selected item's data
21723 * - @c "level,up" - when the user moves a finger from the first
21724 * level to the second level
21725 * - @c "level,down" - when the user moves a finger from the second
21726 * level to the first level
21728 * The @c "delay,changed" event is so that it'll wait a small time
21729 * before actually reporting those events and, moreover, just the
21730 * last event happening on those time frames will actually be
21733 * Here are some examples on its usage:
21734 * @li @ref index_example_01
21735 * @li @ref index_example_02
21739 * @addtogroup Index
21743 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21746 * Add a new index widget to the given parent Elementary
21747 * (container) object
21749 * @param parent The parent object
21750 * @return a new index widget handle or @c NULL, on errors
21752 * This function inserts a new index widget on the canvas.
21756 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21759 * Set whether a given index widget is or not visible,
21762 * @param obj The index object
21763 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21765 * Not to be confused with visible as in @c evas_object_show() --
21766 * visible with regard to the widget's auto hiding feature.
21768 * @see elm_index_active_get()
21772 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21775 * Get whether a given index widget is currently visible or not.
21777 * @param obj The index object
21778 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21780 * @see elm_index_active_set() for more details
21784 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21787 * Set the items level for a given index widget.
21789 * @param obj The index object.
21790 * @param level @c 0 or @c 1, the currently implemented levels.
21792 * @see elm_index_item_level_get()
21796 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21799 * Get the items level set for a given index widget.
21801 * @param obj The index object.
21802 * @return @c 0 or @c 1, which are the levels @p obj might be at.
21804 * @see elm_index_item_level_set() for more information
21808 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21811 * Returns the last selected item's data, for a given index widget.
21813 * @param obj The index object.
21814 * @return The item @b data associated to the last selected item on
21815 * @p obj (or @c NULL, on errors).
21817 * @warning The returned value is @b not an #Elm_Index_Item item
21818 * handle, but the data associated to it (see the @c item parameter
21819 * in elm_index_item_append(), as an example).
21823 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21826 * Append a new item on a given index widget.
21828 * @param obj The index object.
21829 * @param letter Letter under which the item should be indexed
21830 * @param item The item data to set for the index's item
21832 * Despite the most common usage of the @p letter argument is for
21833 * single char strings, one could use arbitrary strings as index
21836 * @c item will be the pointer returned back on @c "changed", @c
21837 * "delay,changed" and @c "selected" smart events.
21841 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21844 * Prepend a new item on a given index widget.
21846 * @param obj The index object.
21847 * @param letter Letter under which the item should be indexed
21848 * @param item The item data to set for the index's item
21850 * Despite the most common usage of the @p letter argument is for
21851 * single char strings, one could use arbitrary strings as index
21854 * @c item will be the pointer returned back on @c "changed", @c
21855 * "delay,changed" and @c "selected" smart events.
21859 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21862 * Append a new item, on a given index widget, <b>after the item
21863 * having @p relative as data</b>.
21865 * @param obj The index object.
21866 * @param letter Letter under which the item should be indexed
21867 * @param item The item data to set for the index's item
21868 * @param relative The item data of the index item to be the
21869 * predecessor of this new one
21871 * Despite the most common usage of the @p letter argument is for
21872 * single char strings, one could use arbitrary strings as index
21875 * @c item will be the pointer returned back on @c "changed", @c
21876 * "delay,changed" and @c "selected" smart events.
21878 * @note If @p relative is @c NULL or if it's not found to be data
21879 * set on any previous item on @p obj, this function will behave as
21880 * elm_index_item_append().
21884 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21887 * Prepend a new item, on a given index widget, <b>after the item
21888 * having @p relative as data</b>.
21890 * @param obj The index object.
21891 * @param letter Letter under which the item should be indexed
21892 * @param item The item data to set for the index's item
21893 * @param relative The item data of the index item to be the
21894 * successor of this new one
21896 * Despite the most common usage of the @p letter argument is for
21897 * single char strings, one could use arbitrary strings as index
21900 * @c item will be the pointer returned back on @c "changed", @c
21901 * "delay,changed" and @c "selected" smart events.
21903 * @note If @p relative is @c NULL or if it's not found to be data
21904 * set on any previous item on @p obj, this function will behave as
21905 * elm_index_item_prepend().
21909 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21912 * Insert a new item into the given index widget, using @p cmp_func
21913 * function to sort items (by item handles).
21915 * @param obj The index object.
21916 * @param letter Letter under which the item should be indexed
21917 * @param item The item data to set for the index's item
21918 * @param cmp_func The comparing function to be used to sort index
21919 * items <b>by #Elm_Index_Item item handles</b>
21920 * @param cmp_data_func A @b fallback function to be called for the
21921 * sorting of index items <b>by item data</b>). It will be used
21922 * when @p cmp_func returns @c 0 (equality), which means an index
21923 * item with provided item data already exists. To decide which
21924 * data item should be pointed to by the index item in question, @p
21925 * cmp_data_func will be used. If @p cmp_data_func returns a
21926 * non-negative value, the previous index item data will be
21927 * replaced by the given @p item pointer. If the previous data need
21928 * to be freed, it should be done by the @p cmp_data_func function,
21929 * because all references to it will be lost. If this function is
21930 * not provided (@c NULL is given), index items will be @b
21931 * duplicated, if @p cmp_func returns @c 0.
21933 * Despite the most common usage of the @p letter argument is for
21934 * single char strings, one could use arbitrary strings as index
21937 * @c item will be the pointer returned back on @c "changed", @c
21938 * "delay,changed" and @c "selected" smart events.
21942 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);
21945 * Remove an item from a given index widget, <b>to be referenced by
21946 * it's data value</b>.
21948 * @param obj The index object
21949 * @param item The item's data pointer for the item to be removed
21952 * If a deletion callback is set, via elm_index_item_del_cb_set(),
21953 * that callback function will be called by this one.
21955 * @warning The item to be removed from @p obj will be found via
21956 * its item data pointer, and not by an #Elm_Index_Item handle.
21960 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21963 * Find a given index widget's item, <b>using item data</b>.
21965 * @param obj The index object
21966 * @param item The item data pointed to by the desired index item
21967 * @return The index item handle, if found, or @c NULL otherwise
21971 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21974 * Removes @b all items from a given index widget.
21976 * @param obj The index object.
21978 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
21979 * that callback function will be called for each item in @p obj.
21983 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21986 * Go to a given items level on a index widget
21988 * @param obj The index object
21989 * @param level The index level (one of @c 0 or @c 1)
21993 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21996 * Return the data associated with a given index widget item
21998 * @param it The index widget item handle
21999 * @return The data associated with @p it
22001 * @see elm_index_item_data_set()
22005 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22008 * Set the data associated with a given index widget item
22010 * @param it The index widget item handle
22011 * @param data The new data pointer to set to @p it
22013 * This sets new item data on @p it.
22015 * @warning The old data pointer won't be touched by this function, so
22016 * the user had better to free that old data himself/herself.
22020 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22023 * Set the function to be called when a given index widget item is freed.
22025 * @param it The item to set the callback on
22026 * @param func The function to call on the item's deletion
22028 * When called, @p func will have both @c data and @c event_info
22029 * arguments with the @p it item's data value and, naturally, the
22030 * @c obj argument with a handle to the parent index widget.
22034 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22037 * Get the letter (string) set on a given index widget item.
22039 * @param it The index item handle
22040 * @return The letter string set on @p it
22044 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22048 EAPI void elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
22055 * @defgroup Photocam Photocam
22057 * @image html img/widget/photocam/preview-00.png
22058 * @image latex img/widget/photocam/preview-00.eps
22060 * This is a widget specifically for displaying high-resolution digital
22061 * camera photos giving speedy feedback (fast load), low memory footprint
22062 * and zooming and panning as well as fitting logic. It is entirely focused
22063 * on jpeg images, and takes advantage of properties of the jpeg format (via
22064 * evas loader features in the jpeg loader).
22066 * Signals that you can add callbacks for are:
22067 * @li "clicked" - This is called when a user has clicked the photo without
22069 * @li "press" - This is called when a user has pressed down on the photo.
22070 * @li "longpressed" - This is called when a user has pressed down on the
22071 * photo for a long time without dragging around.
22072 * @li "clicked,double" - This is called when a user has double-clicked the
22074 * @li "load" - Photo load begins.
22075 * @li "loaded" - This is called when the image file load is complete for the
22076 * first view (low resolution blurry version).
22077 * @li "load,detail" - Photo detailed data load begins.
22078 * @li "loaded,detail" - This is called when the image file load is complete
22079 * for the detailed image data (full resolution needed).
22080 * @li "zoom,start" - Zoom animation started.
22081 * @li "zoom,stop" - Zoom animation stopped.
22082 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22083 * @li "scroll" - the content has been scrolled (moved)
22084 * @li "scroll,anim,start" - scrolling animation has started
22085 * @li "scroll,anim,stop" - scrolling animation has stopped
22086 * @li "scroll,drag,start" - dragging the contents around has started
22087 * @li "scroll,drag,stop" - dragging the contents around has stopped
22089 * @ref tutorial_photocam shows the API in action.
22093 * @brief Types of zoom available.
22095 typedef enum _Elm_Photocam_Zoom_Mode
22097 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
22098 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22099 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22100 ELM_PHOTOCAM_ZOOM_MODE_LAST
22101 } Elm_Photocam_Zoom_Mode;
22103 * @brief Add a new Photocam object
22105 * @param parent The parent object
22106 * @return The new object or NULL if it cannot be created
22108 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22110 * @brief Set the photo file to be shown
22112 * @param obj The photocam object
22113 * @param file The photo file
22114 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22116 * This sets (and shows) the specified file (with a relative or absolute
22117 * path) and will return a load error (same error that
22118 * evas_object_image_load_error_get() will return). The image will change and
22119 * adjust its size at this point and begin a background load process for this
22120 * photo that at some time in the future will be displayed at the full
22123 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22125 * @brief Returns the path of the current image file
22127 * @param obj The photocam object
22128 * @return Returns the path
22130 * @see elm_photocam_file_set()
22132 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22134 * @brief Set the zoom level of the photo
22136 * @param obj The photocam object
22137 * @param zoom The zoom level to set
22139 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22140 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22141 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22142 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22145 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22147 * @brief Get the zoom level of the photo
22149 * @param obj The photocam object
22150 * @return The current zoom level
22152 * This returns the current zoom level of the photocam object. Note that if
22153 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22154 * (which is the default), the zoom level may be changed at any time by the
22155 * photocam object itself to account for photo size and photocam viewpoer
22158 * @see elm_photocam_zoom_set()
22159 * @see elm_photocam_zoom_mode_set()
22161 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22163 * @brief Set the zoom mode
22165 * @param obj The photocam object
22166 * @param mode The desired mode
22168 * This sets the zoom mode to manual or one of several automatic levels.
22169 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22170 * elm_photocam_zoom_set() and will stay at that level until changed by code
22171 * or until zoom mode is changed. This is the default mode. The Automatic
22172 * modes will allow the photocam object to automatically adjust zoom mode
22173 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22174 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22175 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22176 * pixels within the frame are left unfilled.
22178 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22180 * @brief Get the zoom mode
22182 * @param obj The photocam object
22183 * @return The current zoom mode
22185 * This gets the current zoom mode of the photocam object.
22187 * @see elm_photocam_zoom_mode_set()
22189 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22191 * @brief Get the current image pixel width and height
22193 * @param obj The photocam object
22194 * @param w A pointer to the width return
22195 * @param h A pointer to the height return
22197 * This gets the current photo pixel width and height (for the original).
22198 * The size will be returned in the integers @p w and @p h that are pointed
22201 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22203 * @brief Get the area of the image that is currently shown
22206 * @param x A pointer to the X-coordinate of region
22207 * @param y A pointer to the Y-coordinate of region
22208 * @param w A pointer to the width
22209 * @param h A pointer to the height
22211 * @see elm_photocam_image_region_show()
22212 * @see elm_photocam_image_region_bring_in()
22214 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22216 * @brief Set the viewed portion of the image
22218 * @param obj The photocam object
22219 * @param x X-coordinate of region in image original pixels
22220 * @param y Y-coordinate of region in image original pixels
22221 * @param w Width of region in image original pixels
22222 * @param h Height of region in image original pixels
22224 * This shows the region of the image without using animation.
22226 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22228 * @brief Bring in the viewed portion of the image
22230 * @param obj The photocam object
22231 * @param x X-coordinate of region in image original pixels
22232 * @param y Y-coordinate of region in image original pixels
22233 * @param w Width of region in image original pixels
22234 * @param h Height of region in image original pixels
22236 * This shows the region of the image using animation.
22238 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22240 * @brief Set the paused state for photocam
22242 * @param obj The photocam object
22243 * @param paused The pause state to set
22245 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22246 * photocam. The default is off. This will stop zooming using animation on
22247 * zoom levels changes and change instantly. This will stop any existing
22248 * animations that are running.
22250 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22252 * @brief Get the paused state for photocam
22254 * @param obj The photocam object
22255 * @return The current paused state
22257 * This gets the current paused state for the photocam object.
22259 * @see elm_photocam_paused_set()
22261 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22263 * @brief Get the internal low-res image used for photocam
22265 * @param obj The photocam object
22266 * @return The internal image object handle, or NULL if none exists
22268 * This gets the internal image object inside photocam. Do not modify it. It
22269 * is for inspection only, and hooking callbacks to. Nothing else. It may be
22270 * deleted at any time as well.
22272 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22274 * @brief Set the photocam scrolling bouncing.
22276 * @param obj The photocam object
22277 * @param h_bounce bouncing for horizontal
22278 * @param v_bounce bouncing for vertical
22280 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22282 * @brief Get the photocam scrolling bouncing.
22284 * @param obj The photocam object
22285 * @param h_bounce bouncing for horizontal
22286 * @param v_bounce bouncing for vertical
22288 * @see elm_photocam_bounce_set()
22290 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22296 * @defgroup Map Map
22297 * @ingroup Elementary
22299 * @image html img/widget/map/preview-00.png
22300 * @image latex img/widget/map/preview-00.eps
22302 * This is a widget specifically for displaying a map. It uses basically
22303 * OpenStreetMap provider http://www.openstreetmap.org/,
22304 * but custom providers can be added.
22306 * It supports some basic but yet nice features:
22307 * @li zoom and scroll
22308 * @li markers with content to be displayed when user clicks over it
22309 * @li group of markers
22312 * Smart callbacks one can listen to:
22314 * - "clicked" - This is called when a user has clicked the map without
22316 * - "press" - This is called when a user has pressed down on the map.
22317 * - "longpressed" - This is called when a user has pressed down on the map
22318 * for a long time without dragging around.
22319 * - "clicked,double" - This is called when a user has double-clicked
22321 * - "load,detail" - Map detailed data load begins.
22322 * - "loaded,detail" - This is called when all currently visible parts of
22323 * the map are loaded.
22324 * - "zoom,start" - Zoom animation started.
22325 * - "zoom,stop" - Zoom animation stopped.
22326 * - "zoom,change" - Zoom changed when using an auto zoom mode.
22327 * - "scroll" - the content has been scrolled (moved).
22328 * - "scroll,anim,start" - scrolling animation has started.
22329 * - "scroll,anim,stop" - scrolling animation has stopped.
22330 * - "scroll,drag,start" - dragging the contents around has started.
22331 * - "scroll,drag,stop" - dragging the contents around has stopped.
22332 * - "downloaded" - This is called when all currently required map images
22334 * - "route,load" - This is called when route request begins.
22335 * - "route,loaded" - This is called when route request ends.
22336 * - "name,load" - This is called when name request begins.
22337 * - "name,loaded- This is called when name request ends.
22339 * Available style for map widget:
22342 * Available style for markers:
22347 * Available style for marker bubble:
22350 * List of examples:
22351 * @li @ref map_example_01
22352 * @li @ref map_example_02
22353 * @li @ref map_example_03
22362 * @enum _Elm_Map_Zoom_Mode
22363 * @typedef Elm_Map_Zoom_Mode
22365 * Set map's zoom behavior. It can be set to manual or automatic.
22367 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22369 * Values <b> don't </b> work as bitmask, only one can be choosen.
22371 * @note Valid sizes are 2^zoom, consequently the map may be smaller
22372 * than the scroller view.
22374 * @see elm_map_zoom_mode_set()
22375 * @see elm_map_zoom_mode_get()
22379 typedef enum _Elm_Map_Zoom_Mode
22381 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22382 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22383 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22384 ELM_MAP_ZOOM_MODE_LAST
22385 } Elm_Map_Zoom_Mode;
22388 * @enum _Elm_Map_Route_Sources
22389 * @typedef Elm_Map_Route_Sources
22391 * Set route service to be used. By default used source is
22392 * #ELM_MAP_ROUTE_SOURCE_YOURS.
22394 * @see elm_map_route_source_set()
22395 * @see elm_map_route_source_get()
22399 typedef enum _Elm_Map_Route_Sources
22401 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22402 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. */
22403 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22404 ELM_MAP_ROUTE_SOURCE_LAST
22405 } Elm_Map_Route_Sources;
22407 typedef enum _Elm_Map_Name_Sources
22409 ELM_MAP_NAME_SOURCE_NOMINATIM,
22410 ELM_MAP_NAME_SOURCE_LAST
22411 } Elm_Map_Name_Sources;
22414 * @enum _Elm_Map_Route_Type
22415 * @typedef Elm_Map_Route_Type
22417 * Set type of transport used on route.
22419 * @see elm_map_route_add()
22423 typedef enum _Elm_Map_Route_Type
22425 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22426 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22427 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22428 ELM_MAP_ROUTE_TYPE_LAST
22429 } Elm_Map_Route_Type;
22432 * @enum _Elm_Map_Route_Method
22433 * @typedef Elm_Map_Route_Method
22435 * Set the routing method, what should be priorized, time or distance.
22437 * @see elm_map_route_add()
22441 typedef enum _Elm_Map_Route_Method
22443 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22444 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22445 ELM_MAP_ROUTE_METHOD_LAST
22446 } Elm_Map_Route_Method;
22448 typedef enum _Elm_Map_Name_Method
22450 ELM_MAP_NAME_METHOD_SEARCH,
22451 ELM_MAP_NAME_METHOD_REVERSE,
22452 ELM_MAP_NAME_METHOD_LAST
22453 } Elm_Map_Name_Method;
22455 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(). */
22456 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(). */
22457 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(). */
22458 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(). */
22459 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
22460 typedef struct _Elm_Map_Track Elm_Map_Track;
22462 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. */
22463 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22464 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22465 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22467 typedef char *(*ElmMapModuleSourceFunc) (void);
22468 typedef int (*ElmMapModuleZoomMinFunc) (void);
22469 typedef int (*ElmMapModuleZoomMaxFunc) (void);
22470 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22471 typedef int (*ElmMapModuleRouteSourceFunc) (void);
22472 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22473 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22474 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22475 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22478 * Add a new map widget to the given parent Elementary (container) object.
22480 * @param parent The parent object.
22481 * @return a new map widget handle or @c NULL, on errors.
22483 * This function inserts a new map widget on the canvas.
22487 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22490 * Set the zoom level of the map.
22492 * @param obj The map object.
22493 * @param zoom The zoom level to set.
22495 * This sets the zoom level.
22497 * It will respect limits defined by elm_map_source_zoom_min_set() and
22498 * elm_map_source_zoom_max_set().
22500 * By default these values are 0 (world map) and 18 (maximum zoom).
22502 * This function should be used when zoom mode is set to
22503 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22504 * with elm_map_zoom_mode_set().
22506 * @see elm_map_zoom_mode_set().
22507 * @see elm_map_zoom_get().
22511 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22514 * Get the zoom level of the map.
22516 * @param obj The map object.
22517 * @return The current zoom level.
22519 * This returns the current zoom level of the map object.
22521 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22522 * (which is the default), the zoom level may be changed at any time by the
22523 * map object itself to account for map size and map viewport size.
22525 * @see elm_map_zoom_set() for details.
22529 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22532 * Set the zoom mode used by the map object.
22534 * @param obj The map object.
22535 * @param mode The zoom mode of the map, being it one of
22536 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22537 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22539 * This sets the zoom mode to manual or one of the automatic levels.
22540 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22541 * elm_map_zoom_set() and will stay at that level until changed by code
22542 * or until zoom mode is changed. This is the default mode.
22544 * The Automatic modes will allow the map object to automatically
22545 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22546 * adjust zoom so the map fits inside the scroll frame with no pixels
22547 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22548 * ensure no pixels within the frame are left unfilled. Do not forget that
22549 * the valid sizes are 2^zoom, consequently the map may be smaller than
22550 * the scroller view.
22552 * @see elm_map_zoom_set()
22556 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22559 * Get the zoom mode used by the map object.
22561 * @param obj The map object.
22562 * @return The zoom mode of the map, being it one of
22563 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22564 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22566 * This function returns the current zoom mode used by the map object.
22568 * @see elm_map_zoom_mode_set() for more details.
22572 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22575 * Get the current coordinates of the map.
22577 * @param obj The map object.
22578 * @param lon Pointer where to store longitude.
22579 * @param lat Pointer where to store latitude.
22581 * This gets the current center coordinates of the map object. It can be
22582 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22584 * @see elm_map_geo_region_bring_in()
22585 * @see elm_map_geo_region_show()
22589 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22592 * Animatedly bring in given coordinates to the center of the map.
22594 * @param obj The map object.
22595 * @param lon Longitude to center at.
22596 * @param lat Latitude to center at.
22598 * This causes map to jump to the given @p lat and @p lon coordinates
22599 * and show it (by scrolling) in the center of the viewport, if it is not
22600 * already centered. This will use animation to do so and take a period
22601 * of time to complete.
22603 * @see elm_map_geo_region_show() for a function to avoid animation.
22604 * @see elm_map_geo_region_get()
22608 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22611 * Show the given coordinates at the center of the map, @b immediately.
22613 * @param obj The map object.
22614 * @param lon Longitude to center at.
22615 * @param lat Latitude to center at.
22617 * This causes map to @b redraw its viewport's contents to the
22618 * region contining the given @p lat and @p lon, that will be moved to the
22619 * center of the map.
22621 * @see elm_map_geo_region_bring_in() for a function to move with animation.
22622 * @see elm_map_geo_region_get()
22626 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22629 * Pause or unpause the map.
22631 * @param obj The map object.
22632 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22635 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22638 * The default is off.
22640 * This will stop zooming using animation, changing zoom levels will
22641 * change instantly. This will stop any existing animations that are running.
22643 * @see elm_map_paused_get()
22647 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22650 * Get a value whether map is paused or not.
22652 * @param obj The map object.
22653 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22654 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22656 * This gets the current paused state for the map object.
22658 * @see elm_map_paused_set() for details.
22662 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22665 * Set to show markers during zoom level changes or not.
22667 * @param obj The map object.
22668 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22671 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22674 * The default is off.
22676 * This will stop zooming using animation, changing zoom levels will
22677 * change instantly. This will stop any existing animations that are running.
22679 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22682 * The default is off.
22684 * Enabling it will force the map to stop displaying the markers during
22685 * zoom level changes. Set to on if you have a large number of markers.
22687 * @see elm_map_paused_markers_get()
22691 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22694 * Get a value whether markers will be displayed on zoom level changes or not
22696 * @param obj The map object.
22697 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22698 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22700 * This gets the current markers paused state for the map object.
22702 * @see elm_map_paused_markers_set() for details.
22706 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22709 * Get the information of downloading status.
22711 * @param obj The map object.
22712 * @param try_num Pointer where to store number of tiles being downloaded.
22713 * @param finish_num Pointer where to store number of tiles successfully
22716 * This gets the current downloading status for the map object, the number
22717 * of tiles being downloaded and the number of tiles already downloaded.
22721 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22724 * Convert a pixel coordinate (x,y) into a geographic coordinate
22725 * (longitude, latitude).
22727 * @param obj The map object.
22728 * @param x the coordinate.
22729 * @param y the coordinate.
22730 * @param size the size in pixels of the map.
22731 * The map is a square and generally his size is : pow(2.0, zoom)*256.
22732 * @param lon Pointer where to store the longitude that correspond to x.
22733 * @param lat Pointer where to store the latitude that correspond to y.
22735 * @note Origin pixel point is the top left corner of the viewport.
22736 * Map zoom and size are taken on account.
22738 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22742 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);
22745 * Convert a geographic coordinate (longitude, latitude) into a pixel
22746 * coordinate (x, y).
22748 * @param obj The map object.
22749 * @param lon the longitude.
22750 * @param lat the latitude.
22751 * @param size the size in pixels of the map. The map is a square
22752 * and generally his size is : pow(2.0, zoom)*256.
22753 * @param x Pointer where to store the horizontal pixel coordinate that
22754 * correspond to the longitude.
22755 * @param y Pointer where to store the vertical pixel coordinate that
22756 * correspond to the latitude.
22758 * @note Origin pixel point is the top left corner of the viewport.
22759 * Map zoom and size are taken on account.
22761 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22765 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);
22768 * Convert a geographic coordinate (longitude, latitude) into a name
22771 * @param obj The map object.
22772 * @param lon the longitude.
22773 * @param lat the latitude.
22774 * @return name A #Elm_Map_Name handle for this coordinate.
22776 * To get the string for this address, elm_map_name_address_get()
22779 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
22783 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22786 * Convert a name (address) into a geographic coordinate
22787 * (longitude, latitude).
22789 * @param obj The map object.
22790 * @param name The address.
22791 * @return name A #Elm_Map_Name handle for this address.
22793 * To get the longitude and latitude, elm_map_name_region_get()
22796 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
22800 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
22803 * Convert a pixel coordinate into a rotated pixel coordinate.
22805 * @param obj The map object.
22806 * @param x horizontal coordinate of the point to rotate.
22807 * @param y vertical coordinate of the point to rotate.
22808 * @param cx rotation's center horizontal position.
22809 * @param cy rotation's center vertical position.
22810 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
22811 * @param xx Pointer where to store rotated x.
22812 * @param yy Pointer where to store rotated y.
22816 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);
22819 * Add a new marker to the map object.
22821 * @param obj The map object.
22822 * @param lon The longitude of the marker.
22823 * @param lat The latitude of the marker.
22824 * @param clas The class, to use when marker @b isn't grouped to others.
22825 * @param clas_group The class group, to use when marker is grouped to others
22826 * @param data The data passed to the callbacks.
22828 * @return The created marker or @c NULL upon failure.
22830 * A marker will be created and shown in a specific point of the map, defined
22831 * by @p lon and @p lat.
22833 * It will be displayed using style defined by @p class when this marker
22834 * is displayed alone (not grouped). A new class can be created with
22835 * elm_map_marker_class_new().
22837 * If the marker is grouped to other markers, it will be displayed with
22838 * style defined by @p class_group. Markers with the same group are grouped
22839 * if they are close. A new group class can be created with
22840 * elm_map_marker_group_class_new().
22842 * Markers created with this method can be deleted with
22843 * elm_map_marker_remove().
22845 * A marker can have associated content to be displayed by a bubble,
22846 * when a user click over it, as well as an icon. These objects will
22847 * be fetch using class' callback functions.
22849 * @see elm_map_marker_class_new()
22850 * @see elm_map_marker_group_class_new()
22851 * @see elm_map_marker_remove()
22855 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);
22858 * Set the maximum numbers of markers' content to be displayed in a group.
22860 * @param obj The map object.
22861 * @param max The maximum numbers of items displayed in a bubble.
22863 * A bubble will be displayed when the user clicks over the group,
22864 * and will place the content of markers that belong to this group
22867 * A group can have a long list of markers, consequently the creation
22868 * of the content of the bubble can be very slow.
22870 * In order to avoid this, a maximum number of items is displayed
22873 * By default this number is 30.
22875 * Marker with the same group class are grouped if they are close.
22877 * @see elm_map_marker_add()
22881 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
22884 * Remove a marker from the map.
22886 * @param marker The marker to remove.
22888 * @see elm_map_marker_add()
22892 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22895 * Get the current coordinates of the marker.
22897 * @param marker marker.
22898 * @param lat Pointer where to store the marker's latitude.
22899 * @param lon Pointer where to store the marker's longitude.
22901 * These values are set when adding markers, with function
22902 * elm_map_marker_add().
22904 * @see elm_map_marker_add()
22908 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
22911 * Animatedly bring in given marker to the center of the map.
22913 * @param marker The marker to center at.
22915 * This causes map to jump to the given @p marker's coordinates
22916 * and show it (by scrolling) in the center of the viewport, if it is not
22917 * already centered. This will use animation to do so and take a period
22918 * of time to complete.
22920 * @see elm_map_marker_show() for a function to avoid animation.
22921 * @see elm_map_marker_region_get()
22925 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22928 * Show the given marker at the center of the map, @b immediately.
22930 * @param marker The marker to center at.
22932 * This causes map to @b redraw its viewport's contents to the
22933 * region contining the given @p marker's coordinates, that will be
22934 * moved to the center of the map.
22936 * @see elm_map_marker_bring_in() for a function to move with animation.
22937 * @see elm_map_markers_list_show() if more than one marker need to be
22939 * @see elm_map_marker_region_get()
22943 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22946 * Move and zoom the map to display a list of markers.
22948 * @param markers A list of #Elm_Map_Marker handles.
22950 * The map will be centered on the center point of the markers in the list.
22951 * Then the map will be zoomed in order to fit the markers using the maximum
22952 * zoom which allows display of all the markers.
22954 * @warning All the markers should belong to the same map object.
22956 * @see elm_map_marker_show() to show a single marker.
22957 * @see elm_map_marker_bring_in()
22961 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
22964 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
22966 * @param marker The marker wich content should be returned.
22967 * @return Return the evas object if it exists, else @c NULL.
22969 * To set callback function #ElmMapMarkerGetFunc for the marker class,
22970 * elm_map_marker_class_get_cb_set() should be used.
22972 * This content is what will be inside the bubble that will be displayed
22973 * when an user clicks over the marker.
22975 * This returns the actual Evas object used to be placed inside
22976 * the bubble. This may be @c NULL, as it may
22977 * not have been created or may have been deleted, at any time, by
22978 * the map. <b>Do not modify this object</b> (move, resize,
22979 * show, hide, etc.), as the map is controlling it. This
22980 * function is for querying, emitting custom signals or hooking
22981 * lower level callbacks for events on that object. Do not delete
22982 * this object under any circumstances.
22986 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22989 * Update the marker
22991 * @param marker The marker to be updated.
22993 * If a content is set to this marker, it will call function to delete it,
22994 * #ElmMapMarkerDelFunc, and then will fetch the content again with
22995 * #ElmMapMarkerGetFunc.
22997 * These functions are set for the marker class with
22998 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23002 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23005 * Close all the bubbles opened by the user.
23007 * @param obj The map object.
23009 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23010 * when the user clicks on a marker.
23012 * This functions is set for the marker class with
23013 * elm_map_marker_class_get_cb_set().
23017 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23020 * Create a new group class.
23022 * @param obj The map object.
23023 * @return Returns the new group class.
23025 * Each marker must be associated to a group class. Markers in the same
23026 * group are grouped if they are close.
23028 * The group class defines the style of the marker when a marker is grouped
23029 * to others markers. When it is alone, another class will be used.
23031 * A group class will need to be provided when creating a marker with
23032 * elm_map_marker_add().
23034 * Some properties and functions can be set by class, as:
23035 * - style, with elm_map_group_class_style_set()
23036 * - data - to be associated to the group class. It can be set using
23037 * elm_map_group_class_data_set().
23038 * - min zoom to display markers, set with
23039 * elm_map_group_class_zoom_displayed_set().
23040 * - max zoom to group markers, set using
23041 * elm_map_group_class_zoom_grouped_set().
23042 * - visibility - set if markers will be visible or not, set with
23043 * elm_map_group_class_hide_set().
23044 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23045 * It can be set using elm_map_group_class_icon_cb_set().
23047 * @see elm_map_marker_add()
23048 * @see elm_map_group_class_style_set()
23049 * @see elm_map_group_class_data_set()
23050 * @see elm_map_group_class_zoom_displayed_set()
23051 * @see elm_map_group_class_zoom_grouped_set()
23052 * @see elm_map_group_class_hide_set()
23053 * @see elm_map_group_class_icon_cb_set()
23057 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23060 * Set the marker's style of a group class.
23062 * @param clas The group class.
23063 * @param style The style to be used by markers.
23065 * Each marker must be associated to a group class, and will use the style
23066 * defined by such class when grouped to other markers.
23068 * The following styles are provided by default theme:
23069 * @li @c radio - blue circle
23070 * @li @c radio2 - green circle
23073 * @see elm_map_group_class_new() for more details.
23074 * @see elm_map_marker_add()
23078 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23081 * Set the icon callback function of a group class.
23083 * @param clas The group class.
23084 * @param icon_get The callback function that will return the icon.
23086 * Each marker must be associated to a group class, and it can display a
23087 * custom icon. The function @p icon_get must return this icon.
23089 * @see elm_map_group_class_new() for more details.
23090 * @see elm_map_marker_add()
23094 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23097 * Set the data associated to the group class.
23099 * @param clas The group class.
23100 * @param data The new user data.
23102 * This data will be passed for callback functions, like icon get callback,
23103 * that can be set with elm_map_group_class_icon_cb_set().
23105 * If a data was previously set, the object will lose the pointer for it,
23106 * so if needs to be freed, you must do it yourself.
23108 * @see elm_map_group_class_new() for more details.
23109 * @see elm_map_group_class_icon_cb_set()
23110 * @see elm_map_marker_add()
23114 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23117 * Set the minimum zoom from where the markers are displayed.
23119 * @param clas The group class.
23120 * @param zoom The minimum zoom.
23122 * Markers only will be displayed when the map is displayed at @p zoom
23125 * @see elm_map_group_class_new() for more details.
23126 * @see elm_map_marker_add()
23130 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23133 * Set the zoom from where the markers are no more grouped.
23135 * @param clas The group class.
23136 * @param zoom The maximum zoom.
23138 * Markers only will be grouped when the map is displayed at
23139 * less than @p zoom.
23141 * @see elm_map_group_class_new() for more details.
23142 * @see elm_map_marker_add()
23146 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23149 * Set if the markers associated to the group class @clas are hidden or not.
23151 * @param clas The group class.
23152 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23155 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23160 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23163 * Create a new marker class.
23165 * @param obj The map object.
23166 * @return Returns the new group class.
23168 * Each marker must be associated to a class.
23170 * The marker class defines the style of the marker when a marker is
23171 * displayed alone, i.e., not grouped to to others markers. When grouped
23172 * it will use group class style.
23174 * A marker class will need to be provided when creating a marker with
23175 * elm_map_marker_add().
23177 * Some properties and functions can be set by class, as:
23178 * - style, with elm_map_marker_class_style_set()
23179 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23180 * It can be set using elm_map_marker_class_icon_cb_set().
23181 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23182 * Set using elm_map_marker_class_get_cb_set().
23183 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23184 * Set using elm_map_marker_class_del_cb_set().
23186 * @see elm_map_marker_add()
23187 * @see elm_map_marker_class_style_set()
23188 * @see elm_map_marker_class_icon_cb_set()
23189 * @see elm_map_marker_class_get_cb_set()
23190 * @see elm_map_marker_class_del_cb_set()
23194 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23197 * Set the marker's style of a marker class.
23199 * @param clas The marker class.
23200 * @param style The style to be used by markers.
23202 * Each marker must be associated to a marker class, and will use the style
23203 * defined by such class when alone, i.e., @b not grouped to other markers.
23205 * The following styles are provided by default theme:
23210 * @see elm_map_marker_class_new() for more details.
23211 * @see elm_map_marker_add()
23215 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23218 * Set the icon callback function of a marker class.
23220 * @param clas The marker class.
23221 * @param icon_get The callback function that will return the icon.
23223 * Each marker must be associated to a marker class, and it can display a
23224 * custom icon. The function @p icon_get must return this icon.
23226 * @see elm_map_marker_class_new() for more details.
23227 * @see elm_map_marker_add()
23231 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23234 * Set the bubble content callback function of a marker class.
23236 * @param clas The marker class.
23237 * @param get The callback function that will return the content.
23239 * Each marker must be associated to a marker class, and it can display a
23240 * a content on a bubble that opens when the user click over the marker.
23241 * The function @p get must return this content object.
23243 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23246 * @see elm_map_marker_class_new() for more details.
23247 * @see elm_map_marker_class_del_cb_set()
23248 * @see elm_map_marker_add()
23252 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23255 * Set the callback function used to delete bubble content of a marker class.
23257 * @param clas The marker class.
23258 * @param del The callback function that will delete the content.
23260 * Each marker must be associated to a marker class, and it can display a
23261 * a content on a bubble that opens when the user click over the marker.
23262 * The function to return such content can be set with
23263 * elm_map_marker_class_get_cb_set().
23265 * If this content must be freed, a callback function need to be
23266 * set for that task with this function.
23268 * If this callback is defined it will have to delete (or not) the
23269 * object inside, but if the callback is not defined the object will be
23270 * destroyed with evas_object_del().
23272 * @see elm_map_marker_class_new() for more details.
23273 * @see elm_map_marker_class_get_cb_set()
23274 * @see elm_map_marker_add()
23278 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23281 * Get the list of available sources.
23283 * @param obj The map object.
23284 * @return The source names list.
23286 * It will provide a list with all available sources, that can be set as
23287 * current source with elm_map_source_name_set(), or get with
23288 * elm_map_source_name_get().
23290 * Available sources:
23296 * @see elm_map_source_name_set() for more details.
23297 * @see elm_map_source_name_get()
23301 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23304 * Set the source of the map.
23306 * @param obj The map object.
23307 * @param source The source to be used.
23309 * Map widget retrieves images that composes the map from a web service.
23310 * This web service can be set with this method.
23312 * A different service can return a different maps with different
23313 * information and it can use different zoom values.
23315 * The @p source_name need to match one of the names provided by
23316 * elm_map_source_names_get().
23318 * The current source can be get using elm_map_source_name_get().
23320 * @see elm_map_source_names_get()
23321 * @see elm_map_source_name_get()
23326 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23329 * Get the name of currently used source.
23331 * @param obj The map object.
23332 * @return Returns the name of the source in use.
23334 * @see elm_map_source_name_set() for more details.
23338 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23341 * Set the source of the route service to be used by the map.
23343 * @param obj The map object.
23344 * @param source The route service to be used, being it one of
23345 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23346 * and #ELM_MAP_ROUTE_SOURCE_ORS.
23348 * Each one has its own algorithm, so the route retrieved may
23349 * differ depending on the source route. Now, only the default is working.
23351 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23352 * http://www.yournavigation.org/.
23354 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23355 * assumptions. Its routing core is based on Contraction Hierarchies.
23357 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23359 * @see elm_map_route_source_get().
23363 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23366 * Get the current route source.
23368 * @param obj The map object.
23369 * @return The source of the route service used by the map.
23371 * @see elm_map_route_source_set() for details.
23375 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23378 * Set the minimum zoom of the source.
23380 * @param obj The map object.
23381 * @param zoom New minimum zoom value to be used.
23383 * By default, it's 0.
23387 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23390 * Get the minimum zoom of the source.
23392 * @param obj The map object.
23393 * @return Returns the minimum zoom of the source.
23395 * @see elm_map_source_zoom_min_set() for details.
23399 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23402 * Set the maximum zoom of the source.
23404 * @param obj The map object.
23405 * @param zoom New maximum zoom value to be used.
23407 * By default, it's 18.
23411 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23414 * Get the maximum zoom of the source.
23416 * @param obj The map object.
23417 * @return Returns the maximum zoom of the source.
23419 * @see elm_map_source_zoom_min_set() for details.
23423 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23426 * Set the user agent used by the map object to access routing services.
23428 * @param obj The map object.
23429 * @param user_agent The user agent to be used by the map.
23431 * User agent is a client application implementing a network protocol used
23432 * in communications within a client–server distributed computing system
23434 * The @p user_agent identification string will transmitted in a header
23435 * field @c User-Agent.
23437 * @see elm_map_user_agent_get()
23441 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23444 * Get the user agent used by the map object.
23446 * @param obj The map object.
23447 * @return The user agent identification string used by the map.
23449 * @see elm_map_user_agent_set() for details.
23453 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23456 * Add a new route to the map object.
23458 * @param obj The map object.
23459 * @param type The type of transport to be considered when tracing a route.
23460 * @param method The routing method, what should be priorized.
23461 * @param flon The start longitude.
23462 * @param flat The start latitude.
23463 * @param tlon The destination longitude.
23464 * @param tlat The destination latitude.
23466 * @return The created route or @c NULL upon failure.
23468 * A route will be traced by point on coordinates (@p flat, @p flon)
23469 * to point on coordinates (@p tlat, @p tlon), using the route service
23470 * set with elm_map_route_source_set().
23472 * It will take @p type on consideration to define the route,
23473 * depending if the user will be walking or driving, the route may vary.
23474 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23475 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23477 * Another parameter is what the route should priorize, the minor distance
23478 * or the less time to be spend on the route. So @p method should be one
23479 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23481 * Routes created with this method can be deleted with
23482 * elm_map_route_remove(), colored with elm_map_route_color_set(),
23483 * and distance can be get with elm_map_route_distance_get().
23485 * @see elm_map_route_remove()
23486 * @see elm_map_route_color_set()
23487 * @see elm_map_route_distance_get()
23488 * @see elm_map_route_source_set()
23492 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);
23495 * Remove a route from the map.
23497 * @param route The route to remove.
23499 * @see elm_map_route_add()
23503 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23506 * Set the route color.
23508 * @param route The route object.
23509 * @param r Red channel value, from 0 to 255.
23510 * @param g Green channel value, from 0 to 255.
23511 * @param b Blue channel value, from 0 to 255.
23512 * @param a Alpha channel value, from 0 to 255.
23514 * It uses an additive color model, so each color channel represents
23515 * how much of each primary colors must to be used. 0 represents
23516 * ausence of this color, so if all of the three are set to 0,
23517 * the color will be black.
23519 * These component values should be integers in the range 0 to 255,
23520 * (single 8-bit byte).
23522 * This sets the color used for the route. By default, it is set to
23523 * solid red (r = 255, g = 0, b = 0, a = 255).
23525 * For alpha channel, 0 represents completely transparent, and 255, opaque.
23527 * @see elm_map_route_color_get()
23531 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23534 * Get the route color.
23536 * @param route The route object.
23537 * @param r Pointer where to store the red channel value.
23538 * @param g Pointer where to store the green channel value.
23539 * @param b Pointer where to store the blue channel value.
23540 * @param a Pointer where to store the alpha channel value.
23542 * @see elm_map_route_color_set() for details.
23546 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23549 * Get the route distance in kilometers.
23551 * @param route The route object.
23552 * @return The distance of route (unit : km).
23556 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23559 * Get the information of route nodes.
23561 * @param route The route object.
23562 * @return Returns a string with the nodes of route.
23566 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23569 * Get the information of route waypoint.
23571 * @param route the route object.
23572 * @return Returns a string with information about waypoint of route.
23576 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23579 * Get the address of the name.
23581 * @param name The name handle.
23582 * @return Returns the address string of @p name.
23584 * This gets the coordinates of the @p name, created with one of the
23585 * conversion functions.
23587 * @see elm_map_utils_convert_name_into_coord()
23588 * @see elm_map_utils_convert_coord_into_name()
23592 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23595 * Get the current coordinates of the name.
23597 * @param name The name handle.
23598 * @param lat Pointer where to store the latitude.
23599 * @param lon Pointer where to store The longitude.
23601 * This gets the coordinates of the @p name, created with one of the
23602 * conversion functions.
23604 * @see elm_map_utils_convert_name_into_coord()
23605 * @see elm_map_utils_convert_coord_into_name()
23609 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23612 * Remove a name from the map.
23614 * @param name The name to remove.
23616 * Basically the struct handled by @p name will be freed, so convertions
23617 * between address and coordinates will be lost.
23619 * @see elm_map_utils_convert_name_into_coord()
23620 * @see elm_map_utils_convert_coord_into_name()
23624 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23629 * @param obj The map object.
23630 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23631 * @param cx Rotation's center horizontal position.
23632 * @param cy Rotation's center vertical position.
23634 * @see elm_map_rotate_get()
23638 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23641 * Get the rotate degree of the map
23643 * @param obj The map object
23644 * @param degree Pointer where to store degrees from 0.0 to 360.0
23645 * to rotate arount Z axis.
23646 * @param cx Pointer where to store rotation's center horizontal position.
23647 * @param cy Pointer where to store rotation's center vertical position.
23649 * @see elm_map_rotate_set() to set map rotation.
23653 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);
23656 * Enable or disable mouse wheel to be used to zoom in / out the map.
23658 * @param obj The map object.
23659 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23662 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23664 * It's disabled by default.
23666 * @see elm_map_wheel_disabled_get()
23670 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23673 * Get a value whether mouse wheel is enabled or not.
23675 * @param obj The map object.
23676 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23677 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23679 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23681 * @see elm_map_wheel_disabled_set() for details.
23685 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23689 * Add a track on the map
23691 * @param obj The map object.
23692 * @param emap The emap route object.
23693 * @return The route object. This is an elm object of type Route.
23695 * @see elm_route_add() for details.
23699 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23703 * Remove a track from the map
23705 * @param obj The map object.
23706 * @param route The track to remove.
23710 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23717 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23719 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23721 EAPI double elm_route_lon_min_get(Evas_Object *obj);
23722 EAPI double elm_route_lat_min_get(Evas_Object *obj);
23723 EAPI double elm_route_lon_max_get(Evas_Object *obj);
23724 EAPI double elm_route_lat_max_get(Evas_Object *obj);
23728 * @defgroup Panel Panel
23730 * @image html img/widget/panel/preview-00.png
23731 * @image latex img/widget/panel/preview-00.eps
23733 * @brief A panel is a type of animated container that contains subobjects.
23734 * It can be expanded or contracted by clicking the button on it's edge.
23736 * Orientations are as follows:
23737 * @li ELM_PANEL_ORIENT_TOP
23738 * @li ELM_PANEL_ORIENT_LEFT
23739 * @li ELM_PANEL_ORIENT_RIGHT
23741 * Default contents parts of the panel widget that you can use for are:
23742 * @li "default" - A content of the panel
23744 * @ref tutorial_panel shows one way to use this widget.
23747 typedef enum _Elm_Panel_Orient
23749 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23750 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23751 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23752 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23753 } Elm_Panel_Orient;
23755 * @brief Adds a panel object
23757 * @param parent The parent object
23759 * @return The panel object, or NULL on failure
23761 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23763 * @brief Sets the orientation of the panel
23765 * @param parent The parent object
23766 * @param orient The panel orientation. Can be one of the following:
23767 * @li ELM_PANEL_ORIENT_TOP
23768 * @li ELM_PANEL_ORIENT_LEFT
23769 * @li ELM_PANEL_ORIENT_RIGHT
23771 * Sets from where the panel will (dis)appear.
23773 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
23775 * @brief Get the orientation of the panel.
23777 * @param obj The panel object
23778 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
23780 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23782 * @brief Set the content of the panel.
23784 * @param obj The panel object
23785 * @param content The panel content
23787 * Once the content object is set, a previously set one will be deleted.
23788 * If you want to keep that old content object, use the
23789 * elm_panel_content_unset() function.
23791 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23793 * @brief Get the content of the panel.
23795 * @param obj The panel object
23796 * @return The content that is being used
23798 * Return the content object which is set for this widget.
23800 * @see elm_panel_content_set()
23802 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23804 * @brief Unset the content of the panel.
23806 * @param obj The panel object
23807 * @return The content that was being used
23809 * Unparent and return the content object which was set for this widget.
23811 * @see elm_panel_content_set()
23813 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23815 * @brief Set the state of the panel.
23817 * @param obj The panel object
23818 * @param hidden If true, the panel will run the animation to contract
23820 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
23822 * @brief Get the state of the panel.
23824 * @param obj The panel object
23825 * @param hidden If true, the panel is in the "hide" state
23827 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23829 * @brief Toggle the hidden state of the panel from code
23831 * @param obj The panel object
23833 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
23839 * @defgroup Panes Panes
23840 * @ingroup Elementary
23842 * @image html img/widget/panes/preview-00.png
23843 * @image latex img/widget/panes/preview-00.eps width=\textwidth
23845 * @image html img/panes.png
23846 * @image latex img/panes.eps width=\textwidth
23848 * The panes adds a dragable bar between two contents. When dragged
23849 * this bar will resize contents size.
23851 * Panes can be displayed vertically or horizontally, and contents
23852 * size proportion can be customized (homogeneous by default).
23854 * Smart callbacks one can listen to:
23855 * - "press" - The panes has been pressed (button wasn't released yet).
23856 * - "unpressed" - The panes was released after being pressed.
23857 * - "clicked" - The panes has been clicked>
23858 * - "clicked,double" - The panes has been double clicked
23860 * Available styles for it:
23863 * Default contents parts of the panes widget that you can use for are:
23864 * @li "elm.swallow.left" - A leftside content of the panes
23865 * @li "elm.swallow.right" - A rightside content of the panes
23867 * If panes is displayed vertically, left content will be displayed at
23870 * Here is an example on its usage:
23871 * @li @ref panes_example
23874 #define ELM_PANES_CONTENT_LEFT "elm.swallow.left"
23875 #define ELM_PANES_CONTENT_RIGHT "elm.swallow.right"
23878 * @addtogroup Panes
23883 * Add a new panes widget to the given parent Elementary
23884 * (container) object.
23886 * @param parent The parent object.
23887 * @return a new panes widget handle or @c NULL, on errors.
23889 * This function inserts a new panes widget on the canvas.
23893 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23896 * Set the left content of the panes widget.
23898 * @param obj The panes object.
23899 * @param content The new left content object.
23901 * Once the content object is set, a previously set one will be deleted.
23902 * If you want to keep that old content object, use the
23903 * elm_panes_content_left_unset() function.
23905 * If panes is displayed vertically, left content will be displayed at
23908 * @see elm_panes_content_left_get()
23909 * @see elm_panes_content_right_set() to set content on the other side.
23913 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23916 * Set the right content of the panes widget.
23918 * @param obj The panes object.
23919 * @param content The new right content object.
23921 * Once the content object is set, a previously set one will be deleted.
23922 * If you want to keep that old content object, use the
23923 * elm_panes_content_right_unset() function.
23925 * If panes is displayed vertically, left content will be displayed at
23928 * @see elm_panes_content_right_get()
23929 * @see elm_panes_content_left_set() to set content on the other side.
23933 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23936 * Get the left content of the panes.
23938 * @param obj The panes object.
23939 * @return The left content object that is being used.
23941 * Return the left content object which is set for this widget.
23943 * @see elm_panes_content_left_set() for details.
23947 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23950 * Get the right content of the panes.
23952 * @param obj The panes object
23953 * @return The right content object that is being used
23955 * Return the right content object which is set for this widget.
23957 * @see elm_panes_content_right_set() for details.
23961 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23964 * Unset the left content used for the panes.
23966 * @param obj The panes object.
23967 * @return The left content object that was being used.
23969 * Unparent and return the left content object which was set for this widget.
23971 * @see elm_panes_content_left_set() for details.
23972 * @see elm_panes_content_left_get().
23976 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23979 * Unset the right content used for the panes.
23981 * @param obj The panes object.
23982 * @return The right content object that was being used.
23984 * Unparent and return the right content object which was set for this
23987 * @see elm_panes_content_right_set() for details.
23988 * @see elm_panes_content_right_get().
23992 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23995 * Get the size proportion of panes widget's left side.
23997 * @param obj The panes object.
23998 * @return float value between 0.0 and 1.0 representing size proportion
24001 * @see elm_panes_content_left_size_set() for more details.
24005 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24008 * Set the size proportion of panes widget's left side.
24010 * @param obj The panes object.
24011 * @param size Value between 0.0 and 1.0 representing size proportion
24014 * By default it's homogeneous, i.e., both sides have the same size.
24016 * If something different is required, it can be set with this function.
24017 * For example, if the left content should be displayed over
24018 * 75% of the panes size, @p size should be passed as @c 0.75.
24019 * This way, right content will be resized to 25% of panes size.
24021 * If displayed vertically, left content is displayed at top, and
24022 * right content at bottom.
24024 * @note This proportion will change when user drags the panes bar.
24026 * @see elm_panes_content_left_size_get()
24030 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24033 * Set the orientation of a given panes widget.
24035 * @param obj The panes object.
24036 * @param horizontal Use @c EINA_TRUE to make @p obj to be
24037 * @b horizontal, @c EINA_FALSE to make it @b vertical.
24039 * Use this function to change how your panes is to be
24040 * disposed: vertically or horizontally.
24042 * By default it's displayed horizontally.
24044 * @see elm_panes_horizontal_get()
24048 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24051 * Retrieve the orientation of a given panes widget.
24053 * @param obj The panes object.
24054 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24055 * @c EINA_FALSE if it's @b vertical (and on errors).
24057 * @see elm_panes_horizontal_set() for more details.
24061 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24062 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24063 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24070 * @defgroup Flip Flip
24072 * @image html img/widget/flip/preview-00.png
24073 * @image latex img/widget/flip/preview-00.eps
24075 * This widget holds 2 content objects(Evas_Object): one on the front and one
24076 * on the back. It allows you to flip from front to back and vice-versa using
24077 * various animations.
24079 * If either the front or back contents are not set the flip will treat that
24080 * as transparent. So if you wore to set the front content but not the back,
24081 * and then call elm_flip_go() you would see whatever is below the flip.
24083 * For a list of supported animations see elm_flip_go().
24085 * Signals that you can add callbacks for are:
24086 * "animate,begin" - when a flip animation was started
24087 * "animate,done" - when a flip animation is finished
24089 * @ref tutorial_flip show how to use most of the API.
24093 typedef enum _Elm_Flip_Mode
24095 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24096 ELM_FLIP_ROTATE_X_CENTER_AXIS,
24097 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24098 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24099 ELM_FLIP_CUBE_LEFT,
24100 ELM_FLIP_CUBE_RIGHT,
24102 ELM_FLIP_CUBE_DOWN,
24103 ELM_FLIP_PAGE_LEFT,
24104 ELM_FLIP_PAGE_RIGHT,
24108 typedef enum _Elm_Flip_Interaction
24110 ELM_FLIP_INTERACTION_NONE,
24111 ELM_FLIP_INTERACTION_ROTATE,
24112 ELM_FLIP_INTERACTION_CUBE,
24113 ELM_FLIP_INTERACTION_PAGE
24114 } Elm_Flip_Interaction;
24115 typedef enum _Elm_Flip_Direction
24117 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24118 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24119 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24120 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24121 } Elm_Flip_Direction;
24123 * @brief Add a new flip to the parent
24125 * @param parent The parent object
24126 * @return The new object or NULL if it cannot be created
24128 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24130 * @brief Set the front content of the flip widget.
24132 * @param obj The flip object
24133 * @param content The new front content object
24135 * Once the content object is set, a previously set one will be deleted.
24136 * If you want to keep that old content object, use the
24137 * elm_flip_content_front_unset() function.
24139 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24141 * @brief Set the back content of the flip widget.
24143 * @param obj The flip object
24144 * @param content The new back content object
24146 * Once the content object is set, a previously set one will be deleted.
24147 * If you want to keep that old content object, use the
24148 * elm_flip_content_back_unset() function.
24150 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24152 * @brief Get the front content used for the flip
24154 * @param obj The flip object
24155 * @return The front content object that is being used
24157 * Return the front content object which is set for this widget.
24159 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24161 * @brief Get the back content used for the flip
24163 * @param obj The flip object
24164 * @return The back content object that is being used
24166 * Return the back content object which is set for this widget.
24168 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24170 * @brief Unset the front content used for the flip
24172 * @param obj The flip object
24173 * @return The front content object that was being used
24175 * Unparent and return the front content object which was set for this widget.
24177 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24179 * @brief Unset the back content used for the flip
24181 * @param obj The flip object
24182 * @return The back content object that was being used
24184 * Unparent and return the back content object which was set for this widget.
24186 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24188 * @brief Get flip front visibility state
24190 * @param obj The flip objct
24191 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24194 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24196 * @brief Set flip perspective
24198 * @param obj The flip object
24199 * @param foc The coordinate to set the focus on
24200 * @param x The X coordinate
24201 * @param y The Y coordinate
24203 * @warning This function currently does nothing.
24205 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24207 * @brief Runs the flip animation
24209 * @param obj The flip object
24210 * @param mode The mode type
24212 * Flips the front and back contents using the @p mode animation. This
24213 * efectively hides the currently visible content and shows the hidden one.
24215 * There a number of possible animations to use for the flipping:
24216 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24217 * around a horizontal axis in the middle of its height, the other content
24218 * is shown as the other side of the flip.
24219 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24220 * around a vertical axis in the middle of its width, the other content is
24221 * shown as the other side of the flip.
24222 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24223 * around a diagonal axis in the middle of its width, the other content is
24224 * shown as the other side of the flip.
24225 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24226 * around a diagonal axis in the middle of its height, the other content is
24227 * shown as the other side of the flip.
24228 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24229 * as if the flip was a cube, the other content is show as the right face of
24231 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24232 * right as if the flip was a cube, the other content is show as the left
24233 * face of the cube.
24234 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24235 * flip was a cube, the other content is show as the bottom face of the cube.
24236 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24237 * the flip was a cube, the other content is show as the upper face of the
24239 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24240 * if the flip was a book, the other content is shown as the page below that.
24241 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24242 * as if the flip was a book, the other content is shown as the page below
24244 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24245 * flip was a book, the other content is shown as the page below that.
24246 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24247 * flip was a book, the other content is shown as the page below that.
24249 * @image html elm_flip.png
24250 * @image latex elm_flip.eps width=\textwidth
24252 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24254 * @brief Set the interactive flip mode
24256 * @param obj The flip object
24257 * @param mode The interactive flip mode to use
24259 * This sets if the flip should be interactive (allow user to click and
24260 * drag a side of the flip to reveal the back page and cause it to flip).
24261 * By default a flip is not interactive. You may also need to set which
24262 * sides of the flip are "active" for flipping and how much space they use
24263 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24264 * and elm_flip_interacton_direction_hitsize_set()
24266 * The four avilable mode of interaction are:
24267 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24268 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24269 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24270 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24272 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24273 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24274 * happen, those can only be acheived with elm_flip_go();
24276 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24278 * @brief Get the interactive flip mode
24280 * @param obj The flip object
24281 * @return The interactive flip mode
24283 * Returns the interactive flip mode set by elm_flip_interaction_set()
24285 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24287 * @brief Set which directions of the flip respond to interactive flip
24289 * @param obj The flip object
24290 * @param dir The direction to change
24291 * @param enabled If that direction is enabled or not
24293 * By default all directions are disabled, so you may want to enable the
24294 * desired directions for flipping if you need interactive flipping. You must
24295 * call this function once for each direction that should be enabled.
24297 * @see elm_flip_interaction_set()
24299 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24301 * @brief Get the enabled state of that flip direction
24303 * @param obj The flip object
24304 * @param dir The direction to check
24305 * @return If that direction is enabled or not
24307 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24309 * @see elm_flip_interaction_set()
24311 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24313 * @brief Set the amount of the flip that is sensitive to interactive flip
24315 * @param obj The flip object
24316 * @param dir The direction to modify
24317 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24319 * Set the amount of the flip that is sensitive to interactive flip, with 0
24320 * representing no area in the flip and 1 representing the entire flip. There
24321 * is however a consideration to be made in that the area will never be
24322 * smaller than the finger size set(as set in your Elementary configuration).
24324 * @see elm_flip_interaction_set()
24326 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24328 * @brief Get the amount of the flip that is sensitive to interactive flip
24330 * @param obj The flip object
24331 * @param dir The direction to check
24332 * @return The size set for that direction
24334 * Returns the amount os sensitive area set by
24335 * elm_flip_interacton_direction_hitsize_set().
24337 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24342 /* scrolledentry */
24343 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24344 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24345 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24346 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24347 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24348 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24349 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24350 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24351 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24352 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24353 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24354 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24355 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24356 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24357 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24358 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24359 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24360 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24361 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24362 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24363 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24364 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24365 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24366 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24367 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24368 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24369 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24370 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24371 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24372 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24373 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24374 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24375 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24376 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24377 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24378 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);
24379 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24380 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24381 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);
24382 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24383 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);
24384 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24385 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24386 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24387 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24388 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24389 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24390 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24391 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24392 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);
24393 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);
24394 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);
24395 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);
24396 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);
24397 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);
24398 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24399 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24400 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24401 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24402 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24403 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24404 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24405 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
24406 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
24407 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
24408 EINA_DEPRECATED EAPI Ecore_IMF_Context *elm_scrolled_entry_imf_context_get(Evas_Object *obj);
24409 EINA_DEPRECATED EAPI void elm_scrolled_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
24410 EINA_DEPRECATED EAPI void elm_scrolled_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
24413 * @defgroup Conformant Conformant
24414 * @ingroup Elementary
24416 * @image html img/widget/conformant/preview-00.png
24417 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24419 * @image html img/conformant.png
24420 * @image latex img/conformant.eps width=\textwidth
24422 * The aim is to provide a widget that can be used in elementary apps to
24423 * account for space taken up by the indicator, virtual keypad & softkey
24424 * windows when running the illume2 module of E17.
24426 * So conformant content will be sized and positioned considering the
24427 * space required for such stuff, and when they popup, as a keyboard
24428 * shows when an entry is selected, conformant content won't change.
24430 * Available styles for it:
24433 * Default contents parts of the conformant widget that you can use for are:
24434 * @li "default" - A content of the conformant
24436 * See how to use this widget in this example:
24437 * @ref conformant_example
24441 * @addtogroup Conformant
24446 * Add a new conformant widget to the given parent Elementary
24447 * (container) object.
24449 * @param parent The parent object.
24450 * @return A new conformant widget handle or @c NULL, on errors.
24452 * This function inserts a new conformant widget on the canvas.
24454 * @ingroup Conformant
24456 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24459 * Set the content of the conformant widget.
24461 * @param obj The conformant object.
24462 * @param content The content to be displayed by the conformant.
24464 * Content will be sized and positioned considering the space required
24465 * to display a virtual keyboard. So it won't fill all the conformant
24466 * size. This way is possible to be sure that content won't resize
24467 * or be re-positioned after the keyboard is displayed.
24469 * Once the content object is set, a previously set one will be deleted.
24470 * If you want to keep that old content object, use the
24471 * elm_object_content_unset() function.
24473 * @see elm_object_content_unset()
24474 * @see elm_object_content_get()
24476 * @ingroup Conformant
24478 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24481 * Get the content of the conformant widget.
24483 * @param obj The conformant object.
24484 * @return The content that is being used.
24486 * Return the content object which is set for this widget.
24487 * It won't be unparent from conformant. For that, use
24488 * elm_object_content_unset().
24490 * @see elm_object_content_set().
24491 * @see elm_object_content_unset()
24493 * @ingroup Conformant
24495 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24498 * Unset the content of the conformant widget.
24500 * @param obj The conformant object.
24501 * @return The content that was being used.
24503 * Unparent and return the content object which was set for this widget.
24505 * @see elm_object_content_set().
24507 * @ingroup Conformant
24509 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24512 * Returns the Evas_Object that represents the content area.
24514 * @param obj The conformant object.
24515 * @return The content area of the widget.
24517 * @ingroup Conformant
24519 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24526 * @defgroup Mapbuf Mapbuf
24527 * @ingroup Elementary
24529 * @image html img/widget/mapbuf/preview-00.png
24530 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24532 * This holds one content object and uses an Evas Map of transformation
24533 * points to be later used with this content. So the content will be
24534 * moved, resized, etc as a single image. So it will improve performance
24535 * when you have a complex interafce, with a lot of elements, and will
24536 * need to resize or move it frequently (the content object and its
24539 * Default contents parts of the mapbuf widget that you can use for are:
24540 * @li "default" - A content of the mapbuf
24542 * To enable map, elm_mapbuf_enabled_set() should be used.
24544 * See how to use this widget in this example:
24545 * @ref mapbuf_example
24549 * @addtogroup Mapbuf
24554 * Add a new mapbuf widget to the given parent Elementary
24555 * (container) object.
24557 * @param parent The parent object.
24558 * @return A new mapbuf widget handle or @c NULL, on errors.
24560 * This function inserts a new mapbuf widget on the canvas.
24564 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24567 * Set the content of the mapbuf.
24569 * @param obj The mapbuf object.
24570 * @param content The content that will be filled in this mapbuf object.
24572 * Once the content object is set, a previously set one will be deleted.
24573 * If you want to keep that old content object, use the
24574 * elm_mapbuf_content_unset() function.
24576 * To enable map, elm_mapbuf_enabled_set() should be used.
24580 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24583 * Get the content of the mapbuf.
24585 * @param obj The mapbuf object.
24586 * @return The content that is being used.
24588 * Return the content object which is set for this widget.
24590 * @see elm_mapbuf_content_set() for details.
24594 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24597 * Unset the content of the mapbuf.
24599 * @param obj The mapbuf object.
24600 * @return The content that was being used.
24602 * Unparent and return the content object which was set for this widget.
24604 * @see elm_mapbuf_content_set() for details.
24608 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24611 * Enable or disable the map.
24613 * @param obj The mapbuf object.
24614 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24616 * This enables the map that is set or disables it. On enable, the object
24617 * geometry will be saved, and the new geometry will change (position and
24618 * size) to reflect the map geometry set.
24620 * Also, when enabled, alpha and smooth states will be used, so if the
24621 * content isn't solid, alpha should be enabled, for example, otherwise
24622 * a black retangle will fill the content.
24624 * When disabled, the stored map will be freed and geometry prior to
24625 * enabling the map will be restored.
24627 * It's disabled by default.
24629 * @see elm_mapbuf_alpha_set()
24630 * @see elm_mapbuf_smooth_set()
24634 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24637 * Get a value whether map is enabled or not.
24639 * @param obj The mapbuf object.
24640 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24641 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24643 * @see elm_mapbuf_enabled_set() for details.
24647 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24650 * Enable or disable smooth map rendering.
24652 * @param obj The mapbuf object.
24653 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24656 * This sets smoothing for map rendering. If the object is a type that has
24657 * its own smoothing settings, then both the smooth settings for this object
24658 * and the map must be turned off.
24660 * By default smooth maps are enabled.
24664 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24667 * Get a value whether smooth map rendering is enabled or not.
24669 * @param obj The mapbuf object.
24670 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24671 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24673 * @see elm_mapbuf_smooth_set() for details.
24677 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24680 * Set or unset alpha flag for map rendering.
24682 * @param obj The mapbuf object.
24683 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24686 * This sets alpha flag for map rendering. If the object is a type that has
24687 * its own alpha settings, then this will take precedence. Only image objects
24688 * have this currently. It stops alpha blending of the map area, and is
24689 * useful if you know the object and/or all sub-objects is 100% solid.
24691 * Alpha is enabled by default.
24695 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24698 * Get a value whether alpha blending is enabled or not.
24700 * @param obj The mapbuf object.
24701 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24702 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24704 * @see elm_mapbuf_alpha_set() for details.
24708 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24715 * @defgroup Flipselector Flip Selector
24717 * @image html img/widget/flipselector/preview-00.png
24718 * @image latex img/widget/flipselector/preview-00.eps
24720 * A flip selector is a widget to show a set of @b text items, one
24721 * at a time, with the same sheet switching style as the @ref Clock
24722 * "clock" widget, when one changes the current displaying sheet
24723 * (thus, the "flip" in the name).
24725 * User clicks to flip sheets which are @b held for some time will
24726 * make the flip selector to flip continuosly and automatically for
24727 * the user. The interval between flips will keep growing in time,
24728 * so that it helps the user to reach an item which is distant from
24729 * the current selection.
24731 * Smart callbacks one can register to:
24732 * - @c "selected" - when the widget's selected text item is changed
24733 * - @c "overflowed" - when the widget's current selection is changed
24734 * from the first item in its list to the last
24735 * - @c "underflowed" - when the widget's current selection is changed
24736 * from the last item in its list to the first
24738 * Available styles for it:
24741 * To set/get the label of the flipselector item, you can use
24742 * elm_object_item_text_set/get APIs.
24743 * Once the text is set, a previously set one will be deleted.
24745 * Here is an example on its usage:
24746 * @li @ref flipselector_example
24750 * @addtogroup Flipselector
24754 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
24757 * Add a new flip selector widget to the given parent Elementary
24758 * (container) widget
24760 * @param parent The parent object
24761 * @return a new flip selector widget handle or @c NULL, on errors
24763 * This function inserts a new flip selector widget on the canvas.
24765 * @ingroup Flipselector
24767 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24770 * Programmatically select the next item of a flip selector widget
24772 * @param obj The flipselector object
24774 * @note The selection will be animated. Also, if it reaches the
24775 * end of its list of member items, it will continue with the first
24778 * @ingroup Flipselector
24780 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24783 * Programmatically select the previous item of a flip selector
24786 * @param obj The flipselector object
24788 * @note The selection will be animated. Also, if it reaches the
24789 * beginning of its list of member items, it will continue with the
24790 * last one backwards.
24792 * @ingroup Flipselector
24794 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24797 * Append a (text) item to a flip selector widget
24799 * @param obj The flipselector object
24800 * @param label The (text) label of the new item
24801 * @param func Convenience callback function to take place when
24803 * @param data Data passed to @p func, above
24804 * @return A handle to the item added or @c NULL, on errors
24806 * The widget's list of labels to show will be appended with the
24807 * given value. If the user wishes so, a callback function pointer
24808 * can be passed, which will get called when this same item is
24811 * @note The current selection @b won't be modified by appending an
24812 * element to the list.
24814 * @note The maximum length of the text label is going to be
24815 * determined <b>by the widget's theme</b>. Strings larger than
24816 * that value are going to be @b truncated.
24818 * @ingroup Flipselector
24820 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24823 * Prepend a (text) item to a flip selector widget
24825 * @param obj The flipselector object
24826 * @param label The (text) label of the new item
24827 * @param func Convenience callback function to take place when
24829 * @param data Data passed to @p func, above
24830 * @return A handle to the item added or @c NULL, on errors
24832 * The widget's list of labels to show will be prepended with the
24833 * given value. If the user wishes so, a callback function pointer
24834 * can be passed, which will get called when this same item is
24837 * @note The current selection @b won't be modified by prepending
24838 * an element to the list.
24840 * @note The maximum length of the text label is going to be
24841 * determined <b>by the widget's theme</b>. Strings larger than
24842 * that value are going to be @b truncated.
24844 * @ingroup Flipselector
24846 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24849 * Get the internal list of items in a given flip selector widget.
24851 * @param obj The flipselector object
24852 * @return The list of items (#Elm_Flipselector_Item as data) or
24853 * @c NULL on errors.
24855 * This list is @b not to be modified in any way and must not be
24856 * freed. Use the list members with functions like
24857 * elm_flipselector_item_label_set(),
24858 * elm_flipselector_item_label_get(),
24859 * elm_flipselector_item_del(),
24860 * elm_flipselector_item_selected_get(),
24861 * elm_flipselector_item_selected_set().
24863 * @warning This list is only valid until @p obj object's internal
24864 * items list is changed. It should be fetched again with another
24865 * call to this function when changes happen.
24867 * @ingroup Flipselector
24869 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24872 * Get the first item in the given flip selector widget's list of
24875 * @param obj The flipselector object
24876 * @return The first item or @c NULL, if it has no items (and on
24879 * @see elm_flipselector_item_append()
24880 * @see elm_flipselector_last_item_get()
24882 * @ingroup Flipselector
24884 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24887 * Get the last item in the given flip selector widget's list of
24890 * @param obj The flipselector object
24891 * @return The last item or @c NULL, if it has no items (and on
24894 * @see elm_flipselector_item_prepend()
24895 * @see elm_flipselector_first_item_get()
24897 * @ingroup Flipselector
24899 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24902 * Get the currently selected item in a flip selector widget.
24904 * @param obj The flipselector object
24905 * @return The selected item or @c NULL, if the widget has no items
24908 * @ingroup Flipselector
24910 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24913 * Set whether a given flip selector widget's item should be the
24914 * currently selected one.
24916 * @param item The flip selector item
24917 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
24919 * This sets whether @p item is or not the selected (thus, under
24920 * display) one. If @p item is different than one under display,
24921 * the latter will be unselected. If the @p item is set to be
24922 * unselected, on the other hand, the @b first item in the widget's
24923 * internal members list will be the new selected one.
24925 * @see elm_flipselector_item_selected_get()
24927 * @ingroup Flipselector
24929 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24932 * Get whether a given flip selector widget's item is the currently
24935 * @param item The flip selector item
24936 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
24939 * @see elm_flipselector_item_selected_set()
24941 * @ingroup Flipselector
24943 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24946 * Delete a given item from a flip selector widget.
24948 * @param item The item to delete
24950 * @ingroup Flipselector
24952 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24955 * Get the label of a given flip selector widget's item.
24957 * @param item The item to get label from
24958 * @return The text label of @p item or @c NULL, on errors
24960 * @see elm_flipselector_item_label_set()
24962 * @ingroup Flipselector
24964 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24967 * Set the label of a given flip selector widget's item.
24969 * @param item The item to set label on
24970 * @param label The text label string, in UTF-8 encoding
24972 * @see elm_flipselector_item_label_get()
24974 * @ingroup Flipselector
24976 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24979 * Gets the item before @p item in a flip selector widget's
24980 * internal list of items.
24982 * @param item The item to fetch previous from
24983 * @return The item before the @p item, in its parent's list. If
24984 * there is no previous item for @p item or there's an
24985 * error, @c NULL is returned.
24987 * @see elm_flipselector_item_next_get()
24989 * @ingroup Flipselector
24991 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24994 * Gets the item after @p item in a flip selector widget's
24995 * internal list of items.
24997 * @param item The item to fetch next from
24998 * @return The item after the @p item, in its parent's list. If
24999 * there is no next item for @p item or there's an
25000 * error, @c NULL is returned.
25002 * @see elm_flipselector_item_next_get()
25004 * @ingroup Flipselector
25006 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25009 * Set the interval on time updates for an user mouse button hold
25010 * on a flip selector widget.
25012 * @param obj The flip selector object
25013 * @param interval The (first) interval value in seconds
25015 * This interval value is @b decreased while the user holds the
25016 * mouse pointer either flipping up or flipping doww a given flip
25019 * This helps the user to get to a given item distant from the
25020 * current one easier/faster, as it will start to flip quicker and
25021 * quicker on mouse button holds.
25023 * The calculation for the next flip interval value, starting from
25024 * the one set with this call, is the previous interval divided by
25025 * 1.05, so it decreases a little bit.
25027 * The default starting interval value for automatic flips is
25030 * @see elm_flipselector_interval_get()
25032 * @ingroup Flipselector
25034 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25037 * Get the interval on time updates for an user mouse button hold
25038 * on a flip selector widget.
25040 * @param obj The flip selector object
25041 * @return The (first) interval value, in seconds, set on it
25043 * @see elm_flipselector_interval_set() for more details
25045 * @ingroup Flipselector
25047 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25053 * @addtogroup Calendar
25058 * @enum _Elm_Calendar_Mark_Repeat
25059 * @typedef Elm_Calendar_Mark_Repeat
25061 * Event periodicity, used to define if a mark should be repeated
25062 * @b beyond event's day. It's set when a mark is added.
25064 * So, for a mark added to 13th May with periodicity set to WEEKLY,
25065 * there will be marks every week after this date. Marks will be displayed
25066 * at 13th, 20th, 27th, 3rd June ...
25068 * Values don't work as bitmask, only one can be choosen.
25070 * @see elm_calendar_mark_add()
25072 * @ingroup Calendar
25074 typedef enum _Elm_Calendar_Mark_Repeat
25076 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25077 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25078 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25079 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*/
25080 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. */
25081 } Elm_Calendar_Mark_Repeat;
25083 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(). */
25086 * Add a new calendar widget to the given parent Elementary
25087 * (container) object.
25089 * @param parent The parent object.
25090 * @return a new calendar widget handle or @c NULL, on errors.
25092 * This function inserts a new calendar widget on the canvas.
25094 * @ref calendar_example_01
25096 * @ingroup Calendar
25098 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25101 * Get weekdays names displayed by the calendar.
25103 * @param obj The calendar object.
25104 * @return Array of seven strings to be used as weekday names.
25106 * By default, weekdays abbreviations get from system are displayed:
25107 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25108 * The first string is related to Sunday, the second to Monday...
25110 * @see elm_calendar_weekdays_name_set()
25112 * @ref calendar_example_05
25114 * @ingroup Calendar
25116 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25119 * Set weekdays names to be displayed by the calendar.
25121 * @param obj The calendar object.
25122 * @param weekdays Array of seven strings to be used as weekday names.
25123 * @warning It must have 7 elements, or it will access invalid memory.
25124 * @warning The strings must be NULL terminated ('@\0').
25126 * By default, weekdays abbreviations get from system are displayed:
25127 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25129 * The first string should be related to Sunday, the second to Monday...
25131 * The usage should be like this:
25133 * const char *weekdays[] =
25135 * "Sunday", "Monday", "Tuesday", "Wednesday",
25136 * "Thursday", "Friday", "Saturday"
25138 * elm_calendar_weekdays_names_set(calendar, weekdays);
25141 * @see elm_calendar_weekdays_name_get()
25143 * @ref calendar_example_02
25145 * @ingroup Calendar
25147 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25150 * Set the minimum and maximum values for the year
25152 * @param obj The calendar object
25153 * @param min The minimum year, greater than 1901;
25154 * @param max The maximum year;
25156 * Maximum must be greater than minimum, except if you don't wan't to set
25158 * Default values are 1902 and -1.
25160 * If the maximum year is a negative value, it will be limited depending
25161 * on the platform architecture (year 2037 for 32 bits);
25163 * @see elm_calendar_min_max_year_get()
25165 * @ref calendar_example_03
25167 * @ingroup Calendar
25169 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25172 * Get the minimum and maximum values for the year
25174 * @param obj The calendar object.
25175 * @param min The minimum year.
25176 * @param max The maximum year.
25178 * Default values are 1902 and -1.
25180 * @see elm_calendar_min_max_year_get() for more details.
25182 * @ref calendar_example_05
25184 * @ingroup Calendar
25186 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25189 * Enable or disable day selection
25191 * @param obj The calendar object.
25192 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25195 * Enabled by default. If disabled, the user still can select months,
25196 * but not days. Selected days are highlighted on calendar.
25197 * It should be used if you won't need such selection for the widget usage.
25199 * When a day is selected, or month is changed, smart callbacks for
25200 * signal "changed" will be called.
25202 * @see elm_calendar_day_selection_enable_get()
25204 * @ref calendar_example_04
25206 * @ingroup Calendar
25208 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25211 * Get a value whether day selection is enabled or not.
25213 * @see elm_calendar_day_selection_enable_set() for details.
25215 * @param obj The calendar object.
25216 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25217 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25219 * @ref calendar_example_05
25221 * @ingroup Calendar
25223 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25227 * Set selected date to be highlighted on calendar.
25229 * @param obj The calendar object.
25230 * @param selected_time A @b tm struct to represent the selected date.
25232 * Set the selected date, changing the displayed month if needed.
25233 * Selected date changes when the user goes to next/previous month or
25234 * select a day pressing over it on calendar.
25236 * @see elm_calendar_selected_time_get()
25238 * @ref calendar_example_04
25240 * @ingroup Calendar
25242 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25245 * Get selected date.
25247 * @param obj The calendar object
25248 * @param selected_time A @b tm struct to point to selected date
25249 * @return EINA_FALSE means an error ocurred and returned time shouldn't
25252 * Get date selected by the user or set by function
25253 * elm_calendar_selected_time_set().
25254 * Selected date changes when the user goes to next/previous month or
25255 * select a day pressing over it on calendar.
25257 * @see elm_calendar_selected_time_get()
25259 * @ref calendar_example_05
25261 * @ingroup Calendar
25263 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25266 * Set a function to format the string that will be used to display
25269 * @param obj The calendar object
25270 * @param format_function Function to set the month-year string given
25271 * the selected date
25273 * By default it uses strftime with "%B %Y" format string.
25274 * It should allocate the memory that will be used by the string,
25275 * that will be freed by the widget after usage.
25276 * A pointer to the string and a pointer to the time struct will be provided.
25281 * _format_month_year(struct tm *selected_time)
25284 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25285 * return strdup(buf);
25288 * elm_calendar_format_function_set(calendar, _format_month_year);
25291 * @ref calendar_example_02
25293 * @ingroup Calendar
25295 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25298 * Add a new mark to the calendar
25300 * @param obj The calendar object
25301 * @param mark_type A string used to define the type of mark. It will be
25302 * emitted to the theme, that should display a related modification on these
25303 * days representation.
25304 * @param mark_time A time struct to represent the date of inclusion of the
25305 * mark. For marks that repeats it will just be displayed after the inclusion
25306 * date in the calendar.
25307 * @param repeat Repeat the event following this periodicity. Can be a unique
25308 * mark (that don't repeat), daily, weekly, monthly or annually.
25309 * @return The created mark or @p NULL upon failure.
25311 * Add a mark that will be drawn in the calendar respecting the insertion
25312 * time and periodicity. It will emit the type as signal to the widget theme.
25313 * Default theme supports "holiday" and "checked", but it can be extended.
25315 * It won't immediately update the calendar, drawing the marks.
25316 * For this, call elm_calendar_marks_draw(). However, when user selects
25317 * next or previous month calendar forces marks drawn.
25319 * Marks created with this method can be deleted with
25320 * elm_calendar_mark_del().
25324 * struct tm selected_time;
25325 * time_t current_time;
25327 * current_time = time(NULL) + 5 * 84600;
25328 * localtime_r(¤t_time, &selected_time);
25329 * elm_calendar_mark_add(cal, "holiday", selected_time,
25330 * ELM_CALENDAR_ANNUALLY);
25332 * current_time = time(NULL) + 1 * 84600;
25333 * localtime_r(¤t_time, &selected_time);
25334 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25336 * elm_calendar_marks_draw(cal);
25339 * @see elm_calendar_marks_draw()
25340 * @see elm_calendar_mark_del()
25342 * @ref calendar_example_06
25344 * @ingroup Calendar
25346 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);
25349 * Delete mark from the calendar.
25351 * @param mark The mark to be deleted.
25353 * If deleting all calendar marks is required, elm_calendar_marks_clear()
25354 * should be used instead of getting marks list and deleting each one.
25356 * @see elm_calendar_mark_add()
25358 * @ref calendar_example_06
25360 * @ingroup Calendar
25362 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25365 * Remove all calendar's marks
25367 * @param obj The calendar object.
25369 * @see elm_calendar_mark_add()
25370 * @see elm_calendar_mark_del()
25372 * @ingroup Calendar
25374 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25378 * Get a list of all the calendar marks.
25380 * @param obj The calendar object.
25381 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25383 * @see elm_calendar_mark_add()
25384 * @see elm_calendar_mark_del()
25385 * @see elm_calendar_marks_clear()
25387 * @ingroup Calendar
25389 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25392 * Draw calendar marks.
25394 * @param obj The calendar object.
25396 * Should be used after adding, removing or clearing marks.
25397 * It will go through the entire marks list updating the calendar.
25398 * If lots of marks will be added, add all the marks and then call
25401 * When the month is changed, i.e. user selects next or previous month,
25402 * marks will be drawed.
25404 * @see elm_calendar_mark_add()
25405 * @see elm_calendar_mark_del()
25406 * @see elm_calendar_marks_clear()
25408 * @ref calendar_example_06
25410 * @ingroup Calendar
25412 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25413 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25414 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25415 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25418 * Set a day text color to the same that represents Saturdays.
25420 * @param obj The calendar object.
25421 * @param pos The text position. Position is the cell counter, from left
25422 * to right, up to down. It starts on 0 and ends on 41.
25424 * @deprecated use elm_calendar_mark_add() instead like:
25427 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25428 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25431 * @see elm_calendar_mark_add()
25433 * @ingroup Calendar
25435 EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25438 * Set a day text color to the same that represents Sundays.
25440 * @param obj The calendar object.
25441 * @param pos The text position. Position is the cell counter, from left
25442 * to right, up to down. It starts on 0 and ends on 41.
25444 * @deprecated use elm_calendar_mark_add() instead like:
25447 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25448 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25451 * @see elm_calendar_mark_add()
25453 * @ingroup Calendar
25455 EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25458 * Set a day text color to the same that represents Weekdays.
25460 * @param obj The calendar object
25461 * @param pos The text position. Position is the cell counter, from left
25462 * to right, up to down. It starts on 0 and ends on 41.
25464 * @deprecated use elm_calendar_mark_add() instead like:
25467 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25469 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25470 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25471 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25472 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25473 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25474 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25475 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25476 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25477 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25480 * @see elm_calendar_mark_add()
25482 * @ingroup Calendar
25484 EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25487 * Set the interval on time updates for an user mouse button hold
25488 * on calendar widgets' month selection.
25490 * @param obj The calendar object
25491 * @param interval The (first) interval value in seconds
25493 * This interval value is @b decreased while the user holds the
25494 * mouse pointer either selecting next or previous month.
25496 * This helps the user to get to a given month distant from the
25497 * current one easier/faster, as it will start to change quicker and
25498 * quicker on mouse button holds.
25500 * The calculation for the next change interval value, starting from
25501 * the one set with this call, is the previous interval divided by
25502 * 1.05, so it decreases a little bit.
25504 * The default starting interval value for automatic changes is
25507 * @see elm_calendar_interval_get()
25509 * @ingroup Calendar
25511 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25514 * Get the interval on time updates for an user mouse button hold
25515 * on calendar widgets' month selection.
25517 * @param obj The calendar object
25518 * @return The (first) interval value, in seconds, set on it
25520 * @see elm_calendar_interval_set() for more details
25522 * @ingroup Calendar
25524 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25531 * @defgroup Diskselector Diskselector
25532 * @ingroup Elementary
25534 * @image html img/widget/diskselector/preview-00.png
25535 * @image latex img/widget/diskselector/preview-00.eps
25537 * A diskselector is a kind of list widget. It scrolls horizontally,
25538 * and can contain label and icon objects. Three items are displayed
25539 * with the selected one in the middle.
25541 * It can act like a circular list with round mode and labels can be
25542 * reduced for a defined length for side items.
25544 * Smart callbacks one can listen to:
25545 * - "selected" - when item is selected, i.e. scroller stops.
25547 * Available styles for it:
25550 * List of examples:
25551 * @li @ref diskselector_example_01
25552 * @li @ref diskselector_example_02
25556 * @addtogroup Diskselector
25560 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(). */
25563 * Add a new diskselector widget to the given parent Elementary
25564 * (container) object.
25566 * @param parent The parent object.
25567 * @return a new diskselector widget handle or @c NULL, on errors.
25569 * This function inserts a new diskselector widget on the canvas.
25571 * @ingroup Diskselector
25573 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25576 * Enable or disable round mode.
25578 * @param obj The diskselector object.
25579 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25582 * Disabled by default. If round mode is enabled the items list will
25583 * work like a circle list, so when the user reaches the last item,
25584 * the first one will popup.
25586 * @see elm_diskselector_round_get()
25588 * @ingroup Diskselector
25590 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25593 * Get a value whether round mode is enabled or not.
25595 * @see elm_diskselector_round_set() for details.
25597 * @param obj The diskselector object.
25598 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25599 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25601 * @ingroup Diskselector
25603 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25606 * Get the side labels max length.
25608 * @deprecated use elm_diskselector_side_label_length_get() instead:
25610 * @param obj The diskselector object.
25611 * @return The max length defined for side labels, or 0 if not a valid
25614 * @ingroup Diskselector
25616 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25619 * Set the side labels max length.
25621 * @deprecated use elm_diskselector_side_label_length_set() instead:
25623 * @param obj The diskselector object.
25624 * @param len The max length defined for side labels.
25626 * @ingroup Diskselector
25628 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25631 * Get the side labels max length.
25633 * @see elm_diskselector_side_label_length_set() for details.
25635 * @param obj The diskselector object.
25636 * @return The max length defined for side labels, or 0 if not a valid
25639 * @ingroup Diskselector
25641 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25644 * Set the side labels max length.
25646 * @param obj The diskselector object.
25647 * @param len The max length defined for side labels.
25649 * Length is the number of characters of items' label that will be
25650 * visible when it's set on side positions. It will just crop
25651 * the string after defined size. E.g.:
25653 * An item with label "January" would be displayed on side position as
25654 * "Jan" if max length is set to 3, or "Janu", if this property
25657 * When it's selected, the entire label will be displayed, except for
25658 * width restrictions. In this case label will be cropped and "..."
25659 * will be concatenated.
25661 * Default side label max length is 3.
25663 * This property will be applyed over all items, included before or
25664 * later this function call.
25666 * @ingroup Diskselector
25668 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25671 * Set the number of items to be displayed.
25673 * @param obj The diskselector object.
25674 * @param num The number of items the diskselector will display.
25676 * Default value is 3, and also it's the minimun. If @p num is less
25677 * than 3, it will be set to 3.
25679 * Also, it can be set on theme, using data item @c display_item_num
25680 * on group "elm/diskselector/item/X", where X is style set.
25683 * group { name: "elm/diskselector/item/X";
25685 * item: "display_item_num" "5";
25688 * @ingroup Diskselector
25690 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25693 * Get the number of items in the diskselector object.
25695 * @param obj The diskselector object.
25697 * @ingroup Diskselector
25699 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25702 * Set bouncing behaviour when the scrolled content reaches an edge.
25704 * Tell the internal scroller object whether it should bounce or not
25705 * when it reaches the respective edges for each axis.
25707 * @param obj The diskselector object.
25708 * @param h_bounce Whether to bounce or not in the horizontal axis.
25709 * @param v_bounce Whether to bounce or not in the vertical axis.
25711 * @see elm_scroller_bounce_set()
25713 * @ingroup Diskselector
25715 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25718 * Get the bouncing behaviour of the internal scroller.
25720 * Get whether the internal scroller should bounce when the edge of each
25721 * axis is reached scrolling.
25723 * @param obj The diskselector object.
25724 * @param h_bounce Pointer where to store the bounce state of the horizontal
25726 * @param v_bounce Pointer where to store the bounce state of the vertical
25729 * @see elm_scroller_bounce_get()
25730 * @see elm_diskselector_bounce_set()
25732 * @ingroup Diskselector
25734 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25737 * Get the scrollbar policy.
25739 * @see elm_diskselector_scroller_policy_get() for details.
25741 * @param obj The diskselector object.
25742 * @param policy_h Pointer where to store horizontal scrollbar policy.
25743 * @param policy_v Pointer where to store vertical scrollbar policy.
25745 * @ingroup Diskselector
25747 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);
25750 * Set the scrollbar policy.
25752 * @param obj The diskselector object.
25753 * @param policy_h Horizontal scrollbar policy.
25754 * @param policy_v Vertical scrollbar policy.
25756 * This sets the scrollbar visibility policy for the given scroller.
25757 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
25758 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
25759 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
25760 * This applies respectively for the horizontal and vertical scrollbars.
25762 * The both are disabled by default, i.e., are set to
25763 * #ELM_SCROLLER_POLICY_OFF.
25765 * @ingroup Diskselector
25767 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
25770 * Remove all diskselector's items.
25772 * @param obj The diskselector object.
25774 * @see elm_diskselector_item_del()
25775 * @see elm_diskselector_item_append()
25777 * @ingroup Diskselector
25779 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25782 * Get a list of all the diskselector items.
25784 * @param obj The diskselector object.
25785 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
25786 * or @c NULL on failure.
25788 * @see elm_diskselector_item_append()
25789 * @see elm_diskselector_item_del()
25790 * @see elm_diskselector_clear()
25792 * @ingroup Diskselector
25794 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25797 * Appends a new item to the diskselector object.
25799 * @param obj The diskselector object.
25800 * @param label The label of the diskselector item.
25801 * @param icon The icon object to use at left side of the item. An
25802 * icon can be any Evas object, but usually it is an icon created
25803 * with elm_icon_add().
25804 * @param func The function to call when the item is selected.
25805 * @param data The data to associate with the item for related callbacks.
25807 * @return The created item or @c NULL upon failure.
25809 * A new item will be created and appended to the diskselector, i.e., will
25810 * be set as last item. Also, if there is no selected item, it will
25811 * be selected. This will always happens for the first appended item.
25813 * If no icon is set, label will be centered on item position, otherwise
25814 * the icon will be placed at left of the label, that will be shifted
25817 * Items created with this method can be deleted with
25818 * elm_diskselector_item_del().
25820 * Associated @p data can be properly freed when item is deleted if a
25821 * callback function is set with elm_diskselector_item_del_cb_set().
25823 * If a function is passed as argument, it will be called everytime this item
25824 * is selected, i.e., the user stops the diskselector with this
25825 * item on center position. If such function isn't needed, just passing
25826 * @c NULL as @p func is enough. The same should be done for @p data.
25828 * Simple example (with no function callback or data associated):
25830 * disk = elm_diskselector_add(win);
25831 * ic = elm_icon_add(win);
25832 * elm_icon_file_set(ic, "path/to/image", NULL);
25833 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25834 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
25837 * @see elm_diskselector_item_del()
25838 * @see elm_diskselector_item_del_cb_set()
25839 * @see elm_diskselector_clear()
25840 * @see elm_icon_add()
25842 * @ingroup Diskselector
25844 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);
25848 * Delete them item from the diskselector.
25850 * @param it The item of diskselector to be deleted.
25852 * If deleting all diskselector items is required, elm_diskselector_clear()
25853 * should be used instead of getting items list and deleting each one.
25855 * @see elm_diskselector_clear()
25856 * @see elm_diskselector_item_append()
25857 * @see elm_diskselector_item_del_cb_set()
25859 * @ingroup Diskselector
25861 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25864 * Set the function called when a diskselector item is freed.
25866 * @param it The item to set the callback on
25867 * @param func The function called
25869 * If there is a @p func, then it will be called prior item's memory release.
25870 * That will be called with the following arguments:
25872 * @li item's Evas object;
25875 * This way, a data associated to a diskselector item could be properly
25878 * @ingroup Diskselector
25880 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
25883 * Get the data associated to the item.
25885 * @param it The diskselector item
25886 * @return The data associated to @p it
25888 * The return value is a pointer to data associated to @p item when it was
25889 * created, with function elm_diskselector_item_append(). If no data
25890 * was passed as argument, it will return @c NULL.
25892 * @see elm_diskselector_item_append()
25894 * @ingroup Diskselector
25896 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25899 * Set the icon associated to the item.
25901 * @param it The diskselector item
25902 * @param icon The icon object to associate with @p it
25904 * 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().
25908 * Once the icon object is set, a previously set one will be deleted.
25909 * @warning Setting the same icon for two items will cause the icon to
25910 * dissapear from the first item.
25912 * If an icon was passed as argument on item creation, with function
25913 * elm_diskselector_item_append(), it will be already
25914 * associated to the item.
25916 * @see elm_diskselector_item_append()
25917 * @see elm_diskselector_item_icon_get()
25919 * @ingroup Diskselector
25921 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
25924 * Get the icon associated to the item.
25926 * @param it The diskselector item
25927 * @return The icon associated to @p it
25929 * The return value is a pointer to the icon associated to @p item when it was
25930 * created, with function elm_diskselector_item_append(), or later
25931 * with function elm_diskselector_item_icon_set. If no icon
25932 * was passed as argument, it will return @c NULL.
25934 * @see elm_diskselector_item_append()
25935 * @see elm_diskselector_item_icon_set()
25937 * @ingroup Diskselector
25939 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25942 * Set the label of item.
25944 * @param it The item of diskselector.
25945 * @param label The label of item.
25947 * The label to be displayed by the item.
25949 * If no icon is set, label will be centered on item position, otherwise
25950 * the icon will be placed at left of the label, that will be shifted
25953 * An item with label "January" would be displayed on side position as
25954 * "Jan" if max length is set to 3 with function
25955 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
25958 * When this @p item is selected, the entire label will be displayed,
25959 * except for width restrictions.
25960 * In this case label will be cropped and "..." will be concatenated,
25961 * but only for display purposes. It will keep the entire string, so
25962 * if diskselector is resized the remaining characters will be displayed.
25964 * If a label was passed as argument on item creation, with function
25965 * elm_diskselector_item_append(), it will be already
25966 * displayed by the item.
25968 * @see elm_diskselector_side_label_lenght_set()
25969 * @see elm_diskselector_item_label_get()
25970 * @see elm_diskselector_item_append()
25972 * @ingroup Diskselector
25974 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
25977 * Get the label of item.
25979 * @param it The item of diskselector.
25980 * @return The label of item.
25982 * The return value is a pointer to the label associated to @p item when it was
25983 * created, with function elm_diskselector_item_append(), or later
25984 * with function elm_diskselector_item_label_set. If no label
25985 * was passed as argument, it will return @c NULL.
25987 * @see elm_diskselector_item_label_set() for more details.
25988 * @see elm_diskselector_item_append()
25990 * @ingroup Diskselector
25992 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25995 * Get the selected item.
25997 * @param obj The diskselector object.
25998 * @return The selected diskselector item.
26000 * The selected item can be unselected with function
26001 * elm_diskselector_item_selected_set(), and the first item of
26002 * diskselector will be selected.
26004 * The selected item always will be centered on diskselector, with
26005 * full label displayed, i.e., max lenght set to side labels won't
26006 * apply on the selected item. More details on
26007 * elm_diskselector_side_label_length_set().
26009 * @ingroup Diskselector
26011 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26014 * Set the selected state of an item.
26016 * @param it The diskselector item
26017 * @param selected The selected state
26019 * This sets the selected state of the given item @p it.
26020 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26022 * If a new item is selected the previosly selected will be unselected.
26023 * Previoulsy selected item can be get with function
26024 * elm_diskselector_selected_item_get().
26026 * If the item @p it is unselected, the first item of diskselector will
26029 * Selected items will be visible on center position of diskselector.
26030 * So if it was on another position before selected, or was invisible,
26031 * diskselector will animate items until the selected item reaches center
26034 * @see elm_diskselector_item_selected_get()
26035 * @see elm_diskselector_selected_item_get()
26037 * @ingroup Diskselector
26039 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26042 * Get whether the @p item is selected or not.
26044 * @param it The diskselector item.
26045 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26046 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26048 * @see elm_diskselector_selected_item_set() for details.
26049 * @see elm_diskselector_item_selected_get()
26051 * @ingroup Diskselector
26053 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26056 * Get the first item of the diskselector.
26058 * @param obj The diskselector object.
26059 * @return The first item, or @c NULL if none.
26061 * The list of items follows append order. So it will return the first
26062 * item appended to the widget that wasn't deleted.
26064 * @see elm_diskselector_item_append()
26065 * @see elm_diskselector_items_get()
26067 * @ingroup Diskselector
26069 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26072 * Get the last item of the diskselector.
26074 * @param obj The diskselector object.
26075 * @return The last item, or @c NULL if none.
26077 * The list of items follows append order. So it will return last first
26078 * item appended to the widget that wasn't deleted.
26080 * @see elm_diskselector_item_append()
26081 * @see elm_diskselector_items_get()
26083 * @ingroup Diskselector
26085 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26088 * Get the item before @p item in diskselector.
26090 * @param it The diskselector item.
26091 * @return The item before @p item, or @c NULL if none or on failure.
26093 * The list of items follows append order. So it will return item appended
26094 * just before @p item and that wasn't deleted.
26096 * If it is the first item, @c NULL will be returned.
26097 * First item can be get by elm_diskselector_first_item_get().
26099 * @see elm_diskselector_item_append()
26100 * @see elm_diskselector_items_get()
26102 * @ingroup Diskselector
26104 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26107 * Get the item after @p item in diskselector.
26109 * @param it The diskselector item.
26110 * @return The item after @p item, or @c NULL if none or on failure.
26112 * The list of items follows append order. So it will return item appended
26113 * just after @p item and that wasn't deleted.
26115 * If it is the last item, @c NULL will be returned.
26116 * Last item can be get by elm_diskselector_last_item_get().
26118 * @see elm_diskselector_item_append()
26119 * @see elm_diskselector_items_get()
26121 * @ingroup Diskselector
26123 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26126 * Set the text to be shown in the diskselector item.
26128 * @param item Target item
26129 * @param text The text to set in the content
26131 * Setup the text as tooltip to object. The item can have only one tooltip,
26132 * so any previous tooltip data is removed.
26134 * @see elm_object_tooltip_text_set() for more details.
26136 * @ingroup Diskselector
26138 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26141 * Set the content to be shown in the tooltip item.
26143 * Setup the tooltip to item. The item can have only one tooltip,
26144 * so any previous tooltip data is removed. @p func(with @p data) will
26145 * be called every time that need show the tooltip and it should
26146 * return a valid Evas_Object. This object is then managed fully by
26147 * tooltip system and is deleted when the tooltip is gone.
26149 * @param item the diskselector item being attached a tooltip.
26150 * @param func the function used to create the tooltip contents.
26151 * @param data what to provide to @a func as callback data/context.
26152 * @param del_cb called when data is not needed anymore, either when
26153 * another callback replaces @p func, the tooltip is unset with
26154 * elm_diskselector_item_tooltip_unset() or the owner @a item
26155 * dies. This callback receives as the first parameter the
26156 * given @a data, and @c event_info is the item.
26158 * @see elm_object_tooltip_content_cb_set() for more details.
26160 * @ingroup Diskselector
26162 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);
26165 * Unset tooltip from item.
26167 * @param item diskselector item to remove previously set tooltip.
26169 * Remove tooltip from item. The callback provided as del_cb to
26170 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26171 * it is not used anymore.
26173 * @see elm_object_tooltip_unset() for more details.
26174 * @see elm_diskselector_item_tooltip_content_cb_set()
26176 * @ingroup Diskselector
26178 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26182 * Sets a different style for this item tooltip.
26184 * @note before you set a style you should define a tooltip with
26185 * elm_diskselector_item_tooltip_content_cb_set() or
26186 * elm_diskselector_item_tooltip_text_set()
26188 * @param item diskselector item with tooltip already set.
26189 * @param style the theme style to use (default, transparent, ...)
26191 * @see elm_object_tooltip_style_set() for more details.
26193 * @ingroup Diskselector
26195 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26198 * Get the style for this item tooltip.
26200 * @param item diskselector item with tooltip already set.
26201 * @return style the theme style in use, defaults to "default". If the
26202 * object does not have a tooltip set, then NULL is returned.
26204 * @see elm_object_tooltip_style_get() for more details.
26205 * @see elm_diskselector_item_tooltip_style_set()
26207 * @ingroup Diskselector
26209 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26212 * Set the cursor to be shown when mouse is over the diskselector item
26214 * @param item Target item
26215 * @param cursor the cursor name to be used.
26217 * @see elm_object_cursor_set() for more details.
26219 * @ingroup Diskselector
26221 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26224 * Get the cursor to be shown when mouse is over the diskselector item
26226 * @param item diskselector item with cursor already set.
26227 * @return the cursor name.
26229 * @see elm_object_cursor_get() for more details.
26230 * @see elm_diskselector_cursor_set()
26232 * @ingroup Diskselector
26234 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26238 * Unset the cursor to be shown when mouse is over the diskselector item
26240 * @param item Target item
26242 * @see elm_object_cursor_unset() for more details.
26243 * @see elm_diskselector_cursor_set()
26245 * @ingroup Diskselector
26247 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26250 * Sets a different style for this item cursor.
26252 * @note before you set a style you should define a cursor with
26253 * elm_diskselector_item_cursor_set()
26255 * @param item diskselector item with cursor already set.
26256 * @param style the theme style to use (default, transparent, ...)
26258 * @see elm_object_cursor_style_set() for more details.
26260 * @ingroup Diskselector
26262 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26266 * Get the style for this item cursor.
26268 * @param item diskselector item with cursor already set.
26269 * @return style the theme style in use, defaults to "default". If the
26270 * object does not have a cursor set, then @c NULL is returned.
26272 * @see elm_object_cursor_style_get() for more details.
26273 * @see elm_diskselector_item_cursor_style_set()
26275 * @ingroup Diskselector
26277 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26281 * Set if the cursor set should be searched on the theme or should use
26282 * the provided by the engine, only.
26284 * @note before you set if should look on theme you should define a cursor
26285 * with elm_diskselector_item_cursor_set().
26286 * By default it will only look for cursors provided by the engine.
26288 * @param item widget item with cursor already set.
26289 * @param engine_only boolean to define if cursors set with
26290 * elm_diskselector_item_cursor_set() should be searched only
26291 * between cursors provided by the engine or searched on widget's
26294 * @see elm_object_cursor_engine_only_set() for more details.
26296 * @ingroup Diskselector
26298 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26301 * Get the cursor engine only usage for this item cursor.
26303 * @param item widget item with cursor already set.
26304 * @return engine_only boolean to define it cursors should be looked only
26305 * between the provided by the engine or searched on widget's theme as well.
26306 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26308 * @see elm_object_cursor_engine_only_get() for more details.
26309 * @see elm_diskselector_item_cursor_engine_only_set()
26311 * @ingroup Diskselector
26313 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26320 * @defgroup Colorselector Colorselector
26324 * @image html img/widget/colorselector/preview-00.png
26325 * @image latex img/widget/colorselector/preview-00.eps
26327 * @brief Widget for user to select a color.
26329 * Signals that you can add callbacks for are:
26330 * "changed" - When the color value changes(event_info is NULL).
26332 * See @ref tutorial_colorselector.
26335 * @brief Add a new colorselector to the parent
26337 * @param parent The parent object
26338 * @return The new object or NULL if it cannot be created
26340 * @ingroup Colorselector
26342 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26344 * Set a color for the colorselector
26346 * @param obj Colorselector object
26347 * @param r r-value of color
26348 * @param g g-value of color
26349 * @param b b-value of color
26350 * @param a a-value of color
26352 * @ingroup Colorselector
26354 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26356 * Get a color from the colorselector
26358 * @param obj Colorselector object
26359 * @param r integer pointer for r-value of color
26360 * @param g integer pointer for g-value of color
26361 * @param b integer pointer for b-value of color
26362 * @param a integer pointer for a-value of color
26364 * @ingroup Colorselector
26366 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26372 * @defgroup Ctxpopup Ctxpopup
26374 * @image html img/widget/ctxpopup/preview-00.png
26375 * @image latex img/widget/ctxpopup/preview-00.eps
26377 * @brief Context popup widet.
26379 * A ctxpopup is a widget that, when shown, pops up a list of items.
26380 * It automatically chooses an area inside its parent object's view
26381 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26382 * optimally fit into it. In the default theme, it will also point an
26383 * arrow to it's top left position at the time one shows it. Ctxpopup
26384 * items have a label and/or an icon. It is intended for a small
26385 * number of items (hence the use of list, not genlist).
26387 * @note Ctxpopup is a especialization of @ref Hover.
26389 * Signals that you can add callbacks for are:
26390 * "dismissed" - the ctxpopup was dismissed
26392 * Default contents parts of the ctxpopup widget that you can use for are:
26393 * @li "default" - A content of the ctxpopup
26395 * Default contents parts of the naviframe items that you can use for are:
26396 * @li "icon" - A icon in the title area
26398 * Default text parts of the naviframe items that you can use for are:
26399 * @li "default" - Title label in the title area
26401 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26404 typedef enum _Elm_Ctxpopup_Direction
26406 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26408 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26409 the clicked area */
26410 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26411 the clicked area */
26412 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26414 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26415 } Elm_Ctxpopup_Direction;
26416 #define Elm_Ctxpopup_Item Elm_Object_Item
26419 * @brief Add a new Ctxpopup object to the parent.
26421 * @param parent Parent object
26422 * @return New object or @c NULL, if it cannot be created
26424 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26426 * @brief Set the Ctxpopup's parent
26428 * @param obj The ctxpopup object
26429 * @param area The parent to use
26431 * Set the parent object.
26433 * @note elm_ctxpopup_add() will automatically call this function
26434 * with its @c parent argument.
26436 * @see elm_ctxpopup_add()
26437 * @see elm_hover_parent_set()
26439 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26441 * @brief Get the Ctxpopup's parent
26443 * @param obj The ctxpopup object
26445 * @see elm_ctxpopup_hover_parent_set() for more information
26447 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26449 * @brief Clear all items in the given ctxpopup object.
26451 * @param obj Ctxpopup object
26453 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26455 * @brief Change the ctxpopup's orientation to horizontal or vertical.
26457 * @param obj Ctxpopup object
26458 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26460 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26462 * @brief Get the value of current ctxpopup object's orientation.
26464 * @param obj Ctxpopup object
26465 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26467 * @see elm_ctxpopup_horizontal_set()
26469 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26471 * @brief Add a new item to a ctxpopup object.
26473 * @param obj Ctxpopup object
26474 * @param icon Icon to be set on new item
26475 * @param label The Label of the new item
26476 * @param func Convenience function called when item selected
26477 * @param data Data passed to @p func
26478 * @return A handle to the item added or @c NULL, on errors
26480 * @warning Ctxpopup can't hold both an item list and a content at the same
26481 * time. When an item is added, any previous content will be removed.
26483 * @see elm_ctxpopup_content_set()
26485 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);
26487 * @brief Delete the given item in a ctxpopup object.
26489 * @param it Ctxpopup item to be deleted
26491 * @see elm_ctxpopup_item_append()
26493 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26495 * @brief Set the ctxpopup item's state as disabled or enabled.
26497 * @param it Ctxpopup item to be enabled/disabled
26498 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26500 * When disabled the item is greyed out to indicate it's state.
26502 EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26504 * @brief Get the ctxpopup item's disabled/enabled state.
26506 * @param it Ctxpopup item to be enabled/disabled
26507 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26509 * @see elm_ctxpopup_item_disabled_set()
26510 * @deprecated use elm_object_item_disabled_get() instead
26512 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26514 * @brief Get the icon object for the given ctxpopup item.
26516 * @param it Ctxpopup item
26517 * @return icon object or @c NULL, if the item does not have icon or an error
26520 * @see elm_ctxpopup_item_append()
26521 * @see elm_ctxpopup_item_icon_set()
26523 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26525 * @brief Sets the side icon associated with the ctxpopup item
26527 * @param it Ctxpopup item
26528 * @param icon Icon object to be set
26530 * Once the icon object is set, a previously set one will be deleted.
26531 * @warning Setting the same icon for two items will cause the icon to
26532 * dissapear from the first item.
26534 * @see elm_ctxpopup_item_append()
26536 EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26538 * @brief Get the label for the given ctxpopup item.
26540 * @param it Ctxpopup item
26541 * @return label string or @c NULL, if the item does not have label or an
26544 * @see elm_ctxpopup_item_append()
26545 * @see elm_ctxpopup_item_label_set()
26547 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26549 * @brief (Re)set the label on the given ctxpopup item.
26551 * @param it Ctxpopup item
26552 * @param label String to set as label
26554 EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26556 * @brief Set an elm widget as the content of the ctxpopup.
26558 * @param obj Ctxpopup object
26559 * @param content Content to be swallowed
26561 * If the content object is already set, a previous one will bedeleted. If
26562 * you want to keep that old content object, use the
26563 * elm_ctxpopup_content_unset() function.
26565 * @deprecated use elm_object_content_set()
26567 * @warning Ctxpopup can't hold both a item list and a content at the same
26568 * time. When a content is set, any previous items will be removed.
26570 EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26572 * @brief Unset the ctxpopup content
26574 * @param obj Ctxpopup object
26575 * @return The content that was being used
26577 * Unparent and return the content object which was set for this widget.
26579 * @deprecated use elm_object_content_unset()
26581 * @see elm_ctxpopup_content_set()
26583 EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26585 * @brief Set the direction priority of a ctxpopup.
26587 * @param obj Ctxpopup object
26588 * @param first 1st priority of direction
26589 * @param second 2nd priority of direction
26590 * @param third 3th priority of direction
26591 * @param fourth 4th priority of direction
26593 * This functions gives a chance to user to set the priority of ctxpopup
26594 * showing direction. This doesn't guarantee the ctxpopup will appear in the
26595 * requested direction.
26597 * @see Elm_Ctxpopup_Direction
26599 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);
26601 * @brief Get the direction priority of a ctxpopup.
26603 * @param obj Ctxpopup object
26604 * @param first 1st priority of direction to be returned
26605 * @param second 2nd priority of direction to be returned
26606 * @param third 3th priority of direction to be returned
26607 * @param fourth 4th priority of direction to be returned
26609 * @see elm_ctxpopup_direction_priority_set() for more information.
26611 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);
26614 * @brief Get the current direction of a ctxpopup.
26616 * @param obj Ctxpopup object
26617 * @return current direction of a ctxpopup
26619 * @warning Once the ctxpopup showed up, the direction would be determined
26621 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26630 * @defgroup Transit Transit
26631 * @ingroup Elementary
26633 * Transit is designed to apply various animated transition effects to @c
26634 * Evas_Object, such like translation, rotation, etc. For using these
26635 * effects, create an @ref Elm_Transit and add the desired transition effects.
26637 * Once the effects are added into transit, they will be automatically
26638 * managed (their callback will be called until the duration is ended, and
26639 * they will be deleted on completion).
26643 * Elm_Transit *trans = elm_transit_add();
26644 * elm_transit_object_add(trans, obj);
26645 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26646 * elm_transit_duration_set(transit, 1);
26647 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26648 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26649 * elm_transit_repeat_times_set(transit, 3);
26652 * Some transition effects are used to change the properties of objects. They
26654 * @li @ref elm_transit_effect_translation_add
26655 * @li @ref elm_transit_effect_color_add
26656 * @li @ref elm_transit_effect_rotation_add
26657 * @li @ref elm_transit_effect_wipe_add
26658 * @li @ref elm_transit_effect_zoom_add
26659 * @li @ref elm_transit_effect_resizing_add
26661 * Other transition effects are used to make one object disappear and another
26662 * object appear on its old place. These effects are:
26664 * @li @ref elm_transit_effect_flip_add
26665 * @li @ref elm_transit_effect_resizable_flip_add
26666 * @li @ref elm_transit_effect_fade_add
26667 * @li @ref elm_transit_effect_blend_add
26669 * It's also possible to make a transition chain with @ref
26670 * elm_transit_chain_transit_add.
26672 * @warning We strongly recommend to use elm_transit just when edje can not do
26673 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26674 * animations can be manipulated inside the theme.
26676 * List of examples:
26677 * @li @ref transit_example_01_explained
26678 * @li @ref transit_example_02_explained
26679 * @li @ref transit_example_03_c
26680 * @li @ref transit_example_04_c
26686 * @enum Elm_Transit_Tween_Mode
26688 * The type of acceleration used in the transition.
26692 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26693 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26694 over time, then decrease again
26696 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26698 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26700 } Elm_Transit_Tween_Mode;
26703 * @enum Elm_Transit_Effect_Flip_Axis
26705 * The axis where flip effect should be applied.
26709 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26710 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26711 } Elm_Transit_Effect_Flip_Axis;
26713 * @enum Elm_Transit_Effect_Wipe_Dir
26715 * The direction where the wipe effect should occur.
26719 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26720 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26721 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26722 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26723 } Elm_Transit_Effect_Wipe_Dir;
26724 /** @enum Elm_Transit_Effect_Wipe_Type
26726 * Whether the wipe effect should show or hide the object.
26730 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26732 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26734 } Elm_Transit_Effect_Wipe_Type;
26737 * @typedef Elm_Transit
26739 * The Transit created with elm_transit_add(). This type has the information
26740 * about the objects which the transition will be applied, and the
26741 * transition effects that will be used. It also contains info about
26742 * duration, number of repetitions, auto-reverse, etc.
26744 typedef struct _Elm_Transit Elm_Transit;
26745 typedef void Elm_Transit_Effect;
26747 * @typedef Elm_Transit_Effect_Transition_Cb
26749 * Transition callback called for this effect on each transition iteration.
26751 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
26753 * Elm_Transit_Effect_End_Cb
26755 * Transition callback called for this effect when the transition is over.
26757 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
26760 * Elm_Transit_Del_Cb
26762 * A callback called when the transit is deleted.
26764 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
26769 * @note Is not necessary to delete the transit object, it will be deleted at
26770 * the end of its operation.
26771 * @note The transit will start playing when the program enter in the main loop, is not
26772 * necessary to give a start to the transit.
26774 * @return The transit object.
26778 EAPI Elm_Transit *elm_transit_add(void);
26781 * Stops the animation and delete the @p transit object.
26783 * Call this function if you wants to stop the animation before the duration
26784 * time. Make sure the @p transit object is still alive with
26785 * elm_transit_del_cb_set() function.
26786 * All added effects will be deleted, calling its repective data_free_cb
26787 * functions. The function setted by elm_transit_del_cb_set() will be called.
26789 * @see elm_transit_del_cb_set()
26791 * @param transit The transit object to be deleted.
26794 * @warning Just call this function if you are sure the transit is alive.
26796 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26799 * Add a new effect to the transit.
26801 * @note The cb function and the data are the key to the effect. If you try to
26802 * add an already added effect, nothing is done.
26803 * @note After the first addition of an effect in @p transit, if its
26804 * effect list become empty again, the @p transit will be killed by
26805 * elm_transit_del(transit) function.
26809 * Elm_Transit *transit = elm_transit_add();
26810 * elm_transit_effect_add(transit,
26811 * elm_transit_effect_blend_op,
26812 * elm_transit_effect_blend_context_new(),
26813 * elm_transit_effect_blend_context_free);
26816 * @param transit The transit object.
26817 * @param transition_cb The operation function. It is called when the
26818 * animation begins, it is the function that actually performs the animation.
26819 * It is called with the @p data, @p transit and the time progression of the
26820 * animation (a double value between 0.0 and 1.0).
26821 * @param effect The context data of the effect.
26822 * @param end_cb The function to free the context data, it will be called
26823 * at the end of the effect, it must finalize the animation and free the
26827 * @warning The transit free the context data at the and of the transition with
26828 * the data_free_cb function, do not use the context data in another transit.
26830 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);
26833 * Delete an added effect.
26835 * This function will remove the effect from the @p transit, calling the
26836 * data_free_cb to free the @p data.
26838 * @see elm_transit_effect_add()
26840 * @note If the effect is not found, nothing is done.
26841 * @note If the effect list become empty, this function will call
26842 * elm_transit_del(transit), that is, it will kill the @p transit.
26844 * @param transit The transit object.
26845 * @param transition_cb The operation function.
26846 * @param effect The context data of the effect.
26850 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);
26853 * Add new object to apply the effects.
26855 * @note After the first addition of an object in @p transit, if its
26856 * object list become empty again, the @p transit will be killed by
26857 * elm_transit_del(transit) function.
26858 * @note If the @p obj belongs to another transit, the @p obj will be
26859 * removed from it and it will only belong to the @p transit. If the old
26860 * transit stays without objects, it will die.
26861 * @note When you add an object into the @p transit, its state from
26862 * evas_object_pass_events_get(obj) is saved, and it is applied when the
26863 * transit ends, if you change this state whith evas_object_pass_events_set()
26864 * after add the object, this state will change again when @p transit stops to
26867 * @param transit The transit object.
26868 * @param obj Object to be animated.
26871 * @warning It is not allowed to add a new object after transit begins to go.
26873 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26876 * Removes an added object from the transit.
26878 * @note If the @p obj is not in the @p transit, nothing is done.
26879 * @note If the list become empty, this function will call
26880 * elm_transit_del(transit), that is, it will kill the @p transit.
26882 * @param transit The transit object.
26883 * @param obj Object to be removed from @p transit.
26886 * @warning It is not allowed to remove objects after transit begins to go.
26888 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26891 * Get the objects of the transit.
26893 * @param transit The transit object.
26894 * @return a Eina_List with the objects from the transit.
26898 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26901 * Enable/disable keeping up the objects states.
26902 * If it is not kept, the objects states will be reset when transition ends.
26904 * @note @p transit can not be NULL.
26905 * @note One state includes geometry, color, map data.
26907 * @param transit The transit object.
26908 * @param state_keep Keeping or Non Keeping.
26912 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
26915 * Get a value whether the objects states will be reset or not.
26917 * @note @p transit can not be NULL
26919 * @see elm_transit_objects_final_state_keep_set()
26921 * @param transit The transit object.
26922 * @return EINA_TRUE means the states of the objects will be reset.
26923 * If @p transit is NULL, EINA_FALSE is returned
26927 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26930 * Set the event enabled when transit is operating.
26932 * If @p enabled is EINA_TRUE, the objects of the transit will receives
26933 * events from mouse and keyboard during the animation.
26934 * @note When you add an object with elm_transit_object_add(), its state from
26935 * evas_object_pass_events_get(obj) is saved, and it is applied when the
26936 * transit ends, if you change this state with evas_object_pass_events_set()
26937 * after adding the object, this state will change again when @p transit stops
26940 * @param transit The transit object.
26941 * @param enabled Events are received when enabled is @c EINA_TRUE, and
26942 * ignored otherwise.
26946 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26949 * Get the value of event enabled status.
26951 * @see elm_transit_event_enabled_set()
26953 * @param transit The Transit object
26954 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
26955 * EINA_FALSE is returned
26959 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26962 * Set the user-callback function when the transit is deleted.
26964 * @note Using this function twice will overwrite the first function setted.
26965 * @note the @p transit object will be deleted after call @p cb function.
26967 * @param transit The transit object.
26968 * @param cb Callback function pointer. This function will be called before
26969 * the deletion of the transit.
26970 * @param data Callback funtion user data. It is the @p op parameter.
26974 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
26977 * Set reverse effect automatically.
26979 * If auto reverse is setted, after running the effects with the progress
26980 * parameter from 0 to 1, it will call the effecs again with the progress
26981 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
26982 * where the duration was setted with the function elm_transit_add and
26983 * the repeat with the function elm_transit_repeat_times_set().
26985 * @param transit The transit object.
26986 * @param reverse EINA_TRUE means the auto_reverse is on.
26990 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
26993 * Get if the auto reverse is on.
26995 * @see elm_transit_auto_reverse_set()
26997 * @param transit The transit object.
26998 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
26999 * EINA_FALSE is returned
27003 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27006 * Set the transit repeat count. Effect will be repeated by repeat count.
27008 * This function sets the number of repetition the transit will run after
27009 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27010 * If the @p repeat is a negative number, it will repeat infinite times.
27012 * @note If this function is called during the transit execution, the transit
27013 * will run @p repeat times, ignoring the times it already performed.
27015 * @param transit The transit object
27016 * @param repeat Repeat count
27020 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27023 * Get the transit repeat count.
27025 * @see elm_transit_repeat_times_set()
27027 * @param transit The Transit object.
27028 * @return The repeat count. If @p transit is NULL
27033 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27036 * Set the transit animation acceleration type.
27038 * This function sets the tween mode of the transit that can be:
27039 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27040 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27041 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27042 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27044 * @param transit The transit object.
27045 * @param tween_mode The tween type.
27049 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27052 * Get the transit animation acceleration type.
27054 * @note @p transit can not be NULL
27056 * @param transit The transit object.
27057 * @return The tween type. If @p transit is NULL
27058 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27062 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27065 * Set the transit animation time
27067 * @note @p transit can not be NULL
27069 * @param transit The transit object.
27070 * @param duration The animation time.
27074 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27077 * Get the transit animation time
27079 * @note @p transit can not be NULL
27081 * @param transit The transit object.
27083 * @return The transit animation time.
27087 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27090 * Starts the transition.
27091 * Once this API is called, the transit begins to measure the time.
27093 * @note @p transit can not be NULL
27095 * @param transit The transit object.
27099 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27102 * Pause/Resume the transition.
27104 * If you call elm_transit_go again, the transit will be started from the
27105 * beginning, and will be unpaused.
27107 * @note @p transit can not be NULL
27109 * @param transit The transit object.
27110 * @param paused Whether the transition should be paused or not.
27114 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27117 * Get the value of paused status.
27119 * @see elm_transit_paused_set()
27121 * @note @p transit can not be NULL
27123 * @param transit The transit object.
27124 * @return EINA_TRUE means transition is paused. If @p transit is NULL
27125 * EINA_FALSE is returned
27129 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27132 * Get the time progression of the animation (a double value between 0.0 and 1.0).
27134 * The value returned is a fraction (current time / total time). It
27135 * represents the progression position relative to the total.
27137 * @note @p transit can not be NULL
27139 * @param transit The transit object.
27141 * @return The time progression value. If @p transit is NULL
27146 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27149 * Makes the chain relationship between two transits.
27151 * @note @p transit can not be NULL. Transit would have multiple chain transits.
27152 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27154 * @param transit The transit object.
27155 * @param chain_transit The chain transit object. This transit will be operated
27156 * after transit is done.
27158 * This function adds @p chain_transit transition to a chain after the @p
27159 * transit, and will be started as soon as @p transit ends. See @ref
27160 * transit_example_02_explained for a full example.
27164 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27167 * Cut off the chain relationship between two transits.
27169 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27170 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27172 * @param transit The transit object.
27173 * @param chain_transit The chain transit object.
27175 * This function remove the @p chain_transit transition from the @p transit.
27179 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27182 * Get the current chain transit list.
27184 * @note @p transit can not be NULL.
27186 * @param transit The transit object.
27187 * @return chain transit list.
27191 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
27194 * Add the Resizing Effect to Elm_Transit.
27196 * @note This API is one of the facades. It creates resizing effect context
27197 * and add it's required APIs to elm_transit_effect_add.
27199 * @see elm_transit_effect_add()
27201 * @param transit Transit object.
27202 * @param from_w Object width size when effect begins.
27203 * @param from_h Object height size when effect begins.
27204 * @param to_w Object width size when effect ends.
27205 * @param to_h Object height size when effect ends.
27206 * @return Resizing effect context data.
27210 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);
27213 * Add the Translation Effect to Elm_Transit.
27215 * @note This API is one of the facades. It creates translation effect context
27216 * and add it's required APIs to elm_transit_effect_add.
27218 * @see elm_transit_effect_add()
27220 * @param transit Transit object.
27221 * @param from_dx X Position variation when effect begins.
27222 * @param from_dy Y Position variation when effect begins.
27223 * @param to_dx X Position variation when effect ends.
27224 * @param to_dy Y Position variation when effect ends.
27225 * @return Translation effect context data.
27228 * @warning It is highly recommended just create a transit with this effect when
27229 * the window that the objects of the transit belongs has already been created.
27230 * This is because this effect needs the geometry information about the objects,
27231 * and if the window was not created yet, it can get a wrong information.
27233 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);
27236 * Add the Zoom Effect to Elm_Transit.
27238 * @note This API is one of the facades. It creates zoom effect context
27239 * and add it's required APIs to elm_transit_effect_add.
27241 * @see elm_transit_effect_add()
27243 * @param transit Transit object.
27244 * @param from_rate Scale rate when effect begins (1 is current rate).
27245 * @param to_rate Scale rate when effect ends.
27246 * @return Zoom effect context data.
27249 * @warning It is highly recommended just create a transit with this effect when
27250 * the window that the objects of the transit belongs has already been created.
27251 * This is because this effect needs the geometry information about the objects,
27252 * and if the window was not created yet, it can get a wrong information.
27254 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27257 * Add the Flip Effect to Elm_Transit.
27259 * @note This API is one of the facades. It creates flip effect context
27260 * and add it's required APIs to elm_transit_effect_add.
27261 * @note This effect is applied to each pair of objects in the order they are listed
27262 * in the transit list of objects. The first object in the pair will be the
27263 * "front" object and the second will be the "back" object.
27265 * @see elm_transit_effect_add()
27267 * @param transit Transit object.
27268 * @param axis Flipping Axis(X or Y).
27269 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27270 * @return Flip effect context data.
27273 * @warning It is highly recommended just create a transit with this effect when
27274 * the window that the objects of the transit belongs has already been created.
27275 * This is because this effect needs the geometry information about the objects,
27276 * and if the window was not created yet, it can get a wrong information.
27278 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27281 * Add the Resizable Flip Effect to Elm_Transit.
27283 * @note This API is one of the facades. It creates resizable flip effect context
27284 * and add it's required APIs to elm_transit_effect_add.
27285 * @note This effect is applied to each pair of objects in the order they are listed
27286 * in the transit list of objects. The first object in the pair will be the
27287 * "front" object and the second will be the "back" object.
27289 * @see elm_transit_effect_add()
27291 * @param transit Transit object.
27292 * @param axis Flipping Axis(X or Y).
27293 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27294 * @return Resizable flip effect context data.
27297 * @warning It is highly recommended just create a transit with this effect when
27298 * the window that the objects of the transit belongs has already been created.
27299 * This is because this effect needs the geometry information about the objects,
27300 * and if the window was not created yet, it can get a wrong information.
27302 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27305 * Add the Wipe Effect to Elm_Transit.
27307 * @note This API is one of the facades. It creates wipe effect context
27308 * and add it's required APIs to elm_transit_effect_add.
27310 * @see elm_transit_effect_add()
27312 * @param transit Transit object.
27313 * @param type Wipe type. Hide or show.
27314 * @param dir Wipe Direction.
27315 * @return Wipe effect context data.
27318 * @warning It is highly recommended just create a transit with this effect when
27319 * the window that the objects of the transit belongs has already been created.
27320 * This is because this effect needs the geometry information about the objects,
27321 * and if the window was not created yet, it can get a wrong information.
27323 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27326 * Add the Color Effect to Elm_Transit.
27328 * @note This API is one of the facades. It creates color effect context
27329 * and add it's required APIs to elm_transit_effect_add.
27331 * @see elm_transit_effect_add()
27333 * @param transit Transit object.
27334 * @param from_r RGB R when effect begins.
27335 * @param from_g RGB G when effect begins.
27336 * @param from_b RGB B when effect begins.
27337 * @param from_a RGB A when effect begins.
27338 * @param to_r RGB R when effect ends.
27339 * @param to_g RGB G when effect ends.
27340 * @param to_b RGB B when effect ends.
27341 * @param to_a RGB A when effect ends.
27342 * @return Color effect context data.
27346 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);
27349 * Add the Fade Effect to Elm_Transit.
27351 * @note This API is one of the facades. It creates fade effect context
27352 * and add it's required APIs to elm_transit_effect_add.
27353 * @note This effect is applied to each pair of objects in the order they are listed
27354 * in the transit list of objects. The first object in the pair will be the
27355 * "before" object and the second will be the "after" object.
27357 * @see elm_transit_effect_add()
27359 * @param transit Transit object.
27360 * @return Fade effect context data.
27363 * @warning It is highly recommended just create a transit with this effect when
27364 * the window that the objects of the transit belongs has already been created.
27365 * This is because this effect needs the color information about the objects,
27366 * and if the window was not created yet, it can get a wrong information.
27368 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27371 * Add the Blend Effect to Elm_Transit.
27373 * @note This API is one of the facades. It creates blend effect context
27374 * and add it's required APIs to elm_transit_effect_add.
27375 * @note This effect is applied to each pair of objects in the order they are listed
27376 * in the transit list of objects. The first object in the pair will be the
27377 * "before" object and the second will be the "after" object.
27379 * @see elm_transit_effect_add()
27381 * @param transit Transit object.
27382 * @return Blend effect context data.
27385 * @warning It is highly recommended just create a transit with this effect when
27386 * the window that the objects of the transit belongs has already been created.
27387 * This is because this effect needs the color information about the objects,
27388 * and if the window was not created yet, it can get a wrong information.
27390 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27393 * Add the Rotation Effect to Elm_Transit.
27395 * @note This API is one of the facades. It creates rotation effect context
27396 * and add it's required APIs to elm_transit_effect_add.
27398 * @see elm_transit_effect_add()
27400 * @param transit Transit object.
27401 * @param from_degree Degree when effect begins.
27402 * @param to_degree Degree when effect is ends.
27403 * @return Rotation effect context data.
27406 * @warning It is highly recommended just create a transit with this effect when
27407 * the window that the objects of the transit belongs has already been created.
27408 * This is because this effect needs the geometry information about the objects,
27409 * and if the window was not created yet, it can get a wrong information.
27411 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27414 * Add the ImageAnimation Effect to Elm_Transit.
27416 * @note This API is one of the facades. It creates image animation effect context
27417 * and add it's required APIs to elm_transit_effect_add.
27418 * The @p images parameter is a list images paths. This list and
27419 * its contents will be deleted at the end of the effect by
27420 * elm_transit_effect_image_animation_context_free() function.
27424 * char buf[PATH_MAX];
27425 * Eina_List *images = NULL;
27426 * Elm_Transit *transi = elm_transit_add();
27428 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27429 * images = eina_list_append(images, eina_stringshare_add(buf));
27431 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27432 * images = eina_list_append(images, eina_stringshare_add(buf));
27433 * elm_transit_effect_image_animation_add(transi, images);
27437 * @see elm_transit_effect_add()
27439 * @param transit Transit object.
27440 * @param images Eina_List of images file paths. This list and
27441 * its contents will be deleted at the end of the effect by
27442 * elm_transit_effect_image_animation_context_free() function.
27443 * @return Image Animation effect context data.
27447 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27453 typedef struct _Elm_Store Elm_Store;
27454 typedef struct _Elm_Store_DBsystem Elm_Store_DBsystem;
27455 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
27456 typedef struct _Elm_Store_Item Elm_Store_Item;
27457 typedef struct _Elm_Store_Item_DBsystem Elm_Store_Item_DBsystem;
27458 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
27459 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
27460 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27461 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
27462 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
27463 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
27464 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
27465 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
27467 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27468 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27469 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27470 typedef void (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
27471 typedef int (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
27472 typedef void (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
27473 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27477 ELM_STORE_ITEM_MAPPING_NONE = 0,
27478 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27479 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27480 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27481 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27482 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27483 // can add more here as needed by common apps
27484 ELM_STORE_ITEM_MAPPING_LAST
27485 } Elm_Store_Item_Mapping_Type;
27487 struct _Elm_Store_Item_Mapping_Icon
27489 // FIXME: allow edje file icons
27491 Elm_Icon_Lookup_Order lookup_order;
27492 Eina_Bool standard_name : 1;
27493 Eina_Bool no_scale : 1;
27494 Eina_Bool smooth : 1;
27495 Eina_Bool scale_up : 1;
27496 Eina_Bool scale_down : 1;
27499 struct _Elm_Store_Item_Mapping_Empty
27504 struct _Elm_Store_Item_Mapping_Photo
27509 struct _Elm_Store_Item_Mapping_Custom
27511 Elm_Store_Item_Mapping_Cb func;
27514 struct _Elm_Store_Item_Mapping
27516 Elm_Store_Item_Mapping_Type type;
27521 Elm_Store_Item_Mapping_Empty empty;
27522 Elm_Store_Item_Mapping_Icon icon;
27523 Elm_Store_Item_Mapping_Photo photo;
27524 Elm_Store_Item_Mapping_Custom custom;
27525 // add more types here
27529 struct _Elm_Store_Item_Info
27534 Eina_Bool rec_item;
27535 int pre_group_index;
27537 Elm_Genlist_Item_Class *item_class;
27538 const Elm_Store_Item_Mapping *mapping;
27543 struct _Elm_Store_Item_Info_Filesystem
27545 Elm_Store_Item_Info base;
27549 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27550 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27552 EAPI Elm_Store *elm_store_dbsystem_new(void);
27553 EAPI void elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
27554 EAPI void elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
27555 EAPI void elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
27556 EAPI void elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
27557 EAPI int elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27558 EAPI void *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27559 EAPI void elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
27560 EAPI int elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27561 EAPI Elm_Store_Item *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
27562 EAPI void elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27563 EAPI void elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
27564 EAPI void elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27565 EAPI void elm_store_free(Elm_Store *st);
27566 EAPI Elm_Store *elm_store_filesystem_new(void);
27567 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27568 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27569 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27571 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27573 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27574 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27575 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27576 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27577 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27578 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27580 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27581 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27582 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27583 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27584 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27585 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27586 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27589 * @defgroup SegmentControl SegmentControl
27590 * @ingroup Elementary
27592 * @image html img/widget/segment_control/preview-00.png
27593 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27595 * @image html img/segment_control.png
27596 * @image latex img/segment_control.eps width=\textwidth
27598 * Segment control widget is a horizontal control made of multiple segment
27599 * items, each segment item functioning similar to discrete two state button.
27600 * A segment control groups the items together and provides compact
27601 * single button with multiple equal size segments.
27603 * Segment item size is determined by base widget
27604 * size and the number of items added.
27605 * Only one segment item can be at selected state. A segment item can display
27606 * combination of Text and any Evas_Object like Images or other widget.
27608 * Smart callbacks one can listen to:
27609 * - "changed" - When the user clicks on a segment item which is not
27610 * previously selected and get selected. The event_info parameter is the
27611 * segment item pointer.
27613 * Available styles for it:
27616 * Here is an example on its usage:
27617 * @li @ref segment_control_example
27621 * @addtogroup SegmentControl
27625 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27628 * Add a new segment control widget to the given parent Elementary
27629 * (container) object.
27631 * @param parent The parent object.
27632 * @return a new segment control widget handle or @c NULL, on errors.
27634 * This function inserts a new segment control widget on the canvas.
27636 * @ingroup SegmentControl
27638 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27641 * Append a new item to the segment control object.
27643 * @param obj The segment control object.
27644 * @param icon The icon object to use for the left side of the item. An
27645 * icon can be any Evas object, but usually it is an icon created
27646 * with elm_icon_add().
27647 * @param label The label of the item.
27648 * Note that, NULL is different from empty string "".
27649 * @return The created item or @c NULL upon failure.
27651 * A new item will be created and appended to the segment control, i.e., will
27652 * be set as @b last item.
27654 * If it should be inserted at another position,
27655 * elm_segment_control_item_insert_at() should be used instead.
27657 * Items created with this function can be deleted with function
27658 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27660 * @note @p label set to @c NULL is different from empty string "".
27662 * only has icon, it will be displayed bigger and centered. If it has
27663 * icon and label, even that an empty string, icon will be smaller and
27664 * positioned at left.
27668 * sc = elm_segment_control_add(win);
27669 * ic = elm_icon_add(win);
27670 * elm_icon_file_set(ic, "path/to/image", NULL);
27671 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27672 * elm_segment_control_item_add(sc, ic, "label");
27673 * evas_object_show(sc);
27676 * @see elm_segment_control_item_insert_at()
27677 * @see elm_segment_control_item_del()
27679 * @ingroup SegmentControl
27681 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27684 * Insert a new item to the segment control object at specified position.
27686 * @param obj The segment control object.
27687 * @param icon The icon object to use for the left side of the item. An
27688 * icon can be any Evas object, but usually it is an icon created
27689 * with elm_icon_add().
27690 * @param label The label of the item.
27691 * @param index Item position. Value should be between 0 and items count.
27692 * @return The created item or @c NULL upon failure.
27694 * Index values must be between @c 0, when item will be prepended to
27695 * segment control, and items count, that can be get with
27696 * elm_segment_control_item_count_get(), case when item will be appended
27697 * to segment control, just like elm_segment_control_item_add().
27699 * Items created with this function can be deleted with function
27700 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27702 * @note @p label set to @c NULL is different from empty string "".
27704 * only has icon, it will be displayed bigger and centered. If it has
27705 * icon and label, even that an empty string, icon will be smaller and
27706 * positioned at left.
27708 * @see elm_segment_control_item_add()
27709 * @see elm_segment_control_item_count_get()
27710 * @see elm_segment_control_item_del()
27712 * @ingroup SegmentControl
27714 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);
27717 * Remove a segment control item from its parent, deleting it.
27719 * @param it The item to be removed.
27721 * Items can be added with elm_segment_control_item_add() or
27722 * elm_segment_control_item_insert_at().
27724 * @ingroup SegmentControl
27726 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27729 * Remove a segment control item at given index from its parent,
27732 * @param obj The segment control object.
27733 * @param index The position of the segment control item to be deleted.
27735 * Items can be added with elm_segment_control_item_add() or
27736 * elm_segment_control_item_insert_at().
27738 * @ingroup SegmentControl
27740 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27743 * Get the Segment items count from segment control.
27745 * @param obj The segment control object.
27746 * @return Segment items count.
27748 * It will just return the number of items added to segment control @p obj.
27750 * @ingroup SegmentControl
27752 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27755 * Get the item placed at specified index.
27757 * @param obj The segment control object.
27758 * @param index The index of the segment item.
27759 * @return The segment control item or @c NULL on failure.
27761 * Index is the position of an item in segment control widget. Its
27762 * range is from @c 0 to <tt> count - 1 </tt>.
27763 * Count is the number of items, that can be get with
27764 * elm_segment_control_item_count_get().
27766 * @ingroup SegmentControl
27768 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27771 * Get the label of item.
27773 * @param obj The segment control object.
27774 * @param index The index of the segment item.
27775 * @return The label of the item at @p index.
27777 * The return value is a pointer to the label associated to the item when
27778 * it was created, with function elm_segment_control_item_add(), or later
27779 * with function elm_segment_control_item_label_set. If no label
27780 * was passed as argument, it will return @c NULL.
27782 * @see elm_segment_control_item_label_set() for more details.
27783 * @see elm_segment_control_item_add()
27785 * @ingroup SegmentControl
27787 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27790 * Set the label of item.
27792 * @param it The item of segment control.
27793 * @param text The label of item.
27795 * The label to be displayed by the item.
27796 * Label will be at right of the icon (if set).
27798 * If a label was passed as argument on item creation, with function
27799 * elm_control_segment_item_add(), it will be already
27800 * displayed by the item.
27802 * @see elm_segment_control_item_label_get()
27803 * @see elm_segment_control_item_add()
27805 * @ingroup SegmentControl
27807 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
27810 * Get the icon associated to the item.
27812 * @param obj The segment control object.
27813 * @param index The index of the segment item.
27814 * @return The left side icon associated to the item at @p index.
27816 * The return value is a pointer to the icon associated to the item when
27817 * it was created, with function elm_segment_control_item_add(), or later
27818 * with function elm_segment_control_item_icon_set(). If no icon
27819 * was passed as argument, it will return @c NULL.
27821 * @see elm_segment_control_item_add()
27822 * @see elm_segment_control_item_icon_set()
27824 * @ingroup SegmentControl
27826 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27829 * Set the icon associated to the item.
27831 * @param it The segment control item.
27832 * @param icon The icon object to associate with @p it.
27834 * The icon object to use at left side of the item. An
27835 * icon can be any Evas object, but usually it is an icon created
27836 * with elm_icon_add().
27838 * Once the icon object is set, a previously set one will be deleted.
27839 * @warning Setting the same icon for two items will cause the icon to
27840 * dissapear from the first item.
27842 * If an icon was passed as argument on item creation, with function
27843 * elm_segment_control_item_add(), it will be already
27844 * associated to the item.
27846 * @see elm_segment_control_item_add()
27847 * @see elm_segment_control_item_icon_get()
27849 * @ingroup SegmentControl
27851 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27854 * Get the index of an item.
27856 * @param it The segment control item.
27857 * @return The position of item in segment control widget.
27859 * Index is the position of an item in segment control widget. Its
27860 * range is from @c 0 to <tt> count - 1 </tt>.
27861 * Count is the number of items, that can be get with
27862 * elm_segment_control_item_count_get().
27864 * @ingroup SegmentControl
27866 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27869 * Get the base object of the item.
27871 * @param it The segment control item.
27872 * @return The base object associated with @p it.
27874 * Base object is the @c Evas_Object that represents that item.
27876 * @ingroup SegmentControl
27878 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27881 * Get the selected item.
27883 * @param obj The segment control object.
27884 * @return The selected item or @c NULL if none of segment items is
27887 * The selected item can be unselected with function
27888 * elm_segment_control_item_selected_set().
27890 * The selected item always will be highlighted on segment control.
27892 * @ingroup SegmentControl
27894 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27897 * Set the selected state of an item.
27899 * @param it The segment control item
27900 * @param select The selected state
27902 * This sets the selected state of the given item @p it.
27903 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27905 * If a new item is selected the previosly selected will be unselected.
27906 * Previoulsy selected item can be get with function
27907 * elm_segment_control_item_selected_get().
27909 * The selected item always will be highlighted on segment control.
27911 * @see elm_segment_control_item_selected_get()
27913 * @ingroup SegmentControl
27915 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
27922 * @defgroup Grid Grid
27924 * The grid is a grid layout widget that lays out a series of children as a
27925 * fixed "grid" of widgets using a given percentage of the grid width and
27926 * height each using the child object.
27928 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
27929 * widgets size itself. The default is 100 x 100, so that means the
27930 * position and sizes of children will effectively be percentages (0 to 100)
27931 * of the width or height of the grid widget
27937 * Add a new grid to the parent
27939 * @param parent The parent object
27940 * @return The new object or NULL if it cannot be created
27944 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
27947 * Set the virtual size of the grid
27949 * @param obj The grid object
27950 * @param w The virtual width of the grid
27951 * @param h The virtual height of the grid
27955 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
27958 * Get the virtual size of the grid
27960 * @param obj The grid object
27961 * @param w Pointer to integer to store the virtual width of the grid
27962 * @param h Pointer to integer to store the virtual height of the grid
27966 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
27969 * Pack child at given position and size
27971 * @param obj The grid object
27972 * @param subobj The child to pack
27973 * @param x The virtual x coord at which to pack it
27974 * @param y The virtual y coord at which to pack it
27975 * @param w The virtual width at which to pack it
27976 * @param h The virtual height at which to pack it
27980 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
27983 * Unpack a child from a grid object
27985 * @param obj The grid object
27986 * @param subobj The child to unpack
27990 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
27993 * Faster way to remove all child objects from a grid object.
27995 * @param obj The grid object
27996 * @param clear If true, it will delete just removed children
28000 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28003 * Set packing of an existing child at to position and size
28005 * @param subobj The child to set packing of
28006 * @param x The virtual x coord at which to pack it
28007 * @param y The virtual y coord at which to pack it
28008 * @param w The virtual width at which to pack it
28009 * @param h The virtual height at which to pack it
28013 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28016 * get packing of a child
28018 * @param subobj The child to query
28019 * @param x Pointer to integer to store the virtual x coord
28020 * @param y Pointer to integer to store the virtual y coord
28021 * @param w Pointer to integer to store the virtual width
28022 * @param h Pointer to integer to store the virtual height
28026 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28032 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28033 EINA_DEPRECATED EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28034 EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28035 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28036 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
28037 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
28040 * @defgroup Video Video
28042 * @addtogroup Video
28045 * Elementary comes with two object that help design application that need
28046 * to display video. The main one, Elm_Video, display a video by using Emotion.
28047 * It does embedded the video inside an Edje object, so you can do some
28048 * animation depending on the video state change. It does also implement a
28049 * ressource management policy to remove this burden from the application writer.
28051 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28052 * It take care of updating its content according to Emotion event and provide a
28053 * way to theme itself. It also does automatically raise the priority of the
28054 * linked Elm_Video so it will use the video decoder if available. It also does
28055 * activate the remember function on the linked Elm_Video object.
28057 * Signals that you can add callback for are :
28059 * "forward,clicked" - the user clicked the forward button.
28060 * "info,clicked" - the user clicked the info button.
28061 * "next,clicked" - the user clicked the next button.
28062 * "pause,clicked" - the user clicked the pause button.
28063 * "play,clicked" - the user clicked the play button.
28064 * "prev,clicked" - the user clicked the prev button.
28065 * "rewind,clicked" - the user clicked the rewind button.
28066 * "stop,clicked" - the user clicked the stop button.
28068 * Default contents parts of the player widget that you can use for are:
28069 * @li "video" - A video of the player
28074 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28076 * @param parent The parent object
28077 * @return a new player widget handle or @c NULL, on errors.
28079 * This function inserts a new player widget on the canvas.
28081 * @see elm_object_part_content_set()
28085 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28088 * @brief Link a Elm_Payer with an Elm_Video object.
28090 * @param player the Elm_Player object.
28091 * @param video The Elm_Video object.
28093 * This mean that action on the player widget will affect the
28094 * video object and the state of the video will be reflected in
28095 * the player itself.
28097 * @see elm_player_add()
28098 * @see elm_video_add()
28099 * @deprecated use elm_object_part_content_set() instead
28103 EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28106 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28108 * @param parent The parent object
28109 * @return a new video widget handle or @c NULL, on errors.
28111 * This function inserts a new video widget on the canvas.
28113 * @seeelm_video_file_set()
28114 * @see elm_video_uri_set()
28118 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28121 * @brief Define the file that will be the video source.
28123 * @param video The video object to define the file for.
28124 * @param filename The file to target.
28126 * This function will explicitly define a filename as a source
28127 * for the video of the Elm_Video object.
28129 * @see elm_video_uri_set()
28130 * @see elm_video_add()
28131 * @see elm_player_add()
28135 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28138 * @brief Define the uri that will be the video source.
28140 * @param video The video object to define the file for.
28141 * @param uri The uri to target.
28143 * This function will define an uri as a source for the video of the
28144 * Elm_Video object. URI could be remote source of video, like http:// or local source
28145 * like for example WebCam who are most of the time v4l2:// (but that depend and
28146 * you should use Emotion API to request and list the available Webcam on your system).
28148 * @see elm_video_file_set()
28149 * @see elm_video_add()
28150 * @see elm_player_add()
28154 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28157 * @brief Get the underlying Emotion object.
28159 * @param video The video object to proceed the request on.
28160 * @return the underlying Emotion object.
28164 EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28167 * @brief Start to play the video
28169 * @param video The video object to proceed the request on.
28171 * Start to play the video and cancel all suspend state.
28175 EAPI void elm_video_play(Evas_Object *video);
28178 * @brief Pause the video
28180 * @param video The video object to proceed the request on.
28182 * Pause the video and start a timer to trigger suspend mode.
28186 EAPI void elm_video_pause(Evas_Object *video);
28189 * @brief Stop the video
28191 * @param video The video object to proceed the request on.
28193 * Stop the video and put the emotion in deep sleep mode.
28197 EAPI void elm_video_stop(Evas_Object *video);
28200 * @brief Is the video actually playing.
28202 * @param video The video object to proceed the request on.
28203 * @return EINA_TRUE if the video is actually playing.
28205 * You should consider watching event on the object instead of polling
28206 * the object state.
28210 EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28213 * @brief Is it possible to seek inside the video.
28215 * @param video The video object to proceed the request on.
28216 * @return EINA_TRUE if is possible to seek inside the video.
28220 EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28223 * @brief Is the audio muted.
28225 * @param video The video object to proceed the request on.
28226 * @return EINA_TRUE if the audio is muted.
28230 EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28233 * @brief Change the mute state of the Elm_Video object.
28235 * @param video The video object to proceed the request on.
28236 * @param mute The new mute state.
28240 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28243 * @brief Get the audio level of the current video.
28245 * @param video The video object to proceed the request on.
28246 * @return the current audio level.
28250 EAPI double elm_video_audio_level_get(const Evas_Object *video);
28253 * @brief Set the audio level of anElm_Video object.
28255 * @param video The video object to proceed the request on.
28256 * @param volume The new audio volume.
28260 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28262 EAPI double elm_video_play_position_get(const Evas_Object *video);
28263 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28264 EAPI double elm_video_play_length_get(const Evas_Object *video);
28265 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28266 EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28267 EAPI const char *elm_video_title_get(const Evas_Object *video);
28272 // FIXME: incomplete - carousel. don't use this until this comment is removed
28273 typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
28274 EAPI Evas_Object *elm_carousel_add(Evas_Object *parent);
28275 EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
28276 EAPI void elm_carousel_item_del(Elm_Carousel_Item *item);
28277 EAPI void elm_carousel_item_select(Elm_Carousel_Item *item);
28278 /* smart callbacks called:
28279 * "clicked" - when the user clicks on a carousel item and becomes selected
28284 typedef enum _Elm_Datefield_ItemType
28286 ELM_DATEFIELD_YEAR = 0,
28287 ELM_DATEFIELD_MONTH,
28288 ELM_DATEFIELD_DATE,
28289 ELM_DATEFIELD_HOUR,
28290 ELM_DATEFIELD_MINUTE,
28292 } Elm_Datefield_ItemType;
28294 EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
28295 EAPI void elm_datefield_format_set(Evas_Object *obj, const char *fmt);
28296 EAPI char *elm_datefield_format_get(const Evas_Object *obj);
28297 EAPI void elm_datefield_item_enabled_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, Eina_Bool enable);
28298 EAPI Eina_Bool elm_datefield_item_enabled_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28299 EAPI void elm_datefield_item_value_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value);
28300 EAPI int elm_datefield_item_value_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28301 EAPI void elm_datefield_item_min_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28302 EAPI int elm_datefield_item_min_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28303 EAPI Eina_Bool elm_datefield_item_min_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28304 EAPI void elm_datefield_item_max_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28305 EAPI int elm_datefield_item_max_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28306 EAPI Eina_Bool elm_datefield_item_max_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28308 /* smart callbacks called:
28309 * "changed" - when datefield value is changed, this signal is sent.
28312 ////////////////////// DEPRECATED ///////////////////////////////////
28314 typedef enum _Elm_Datefield_Layout
28316 ELM_DATEFIELD_LAYOUT_TIME,
28317 ELM_DATEFIELD_LAYOUT_DATE,
28318 ELM_DATEFIELD_LAYOUT_DATEANDTIME
28319 } Elm_Datefield_Layout;
28321 EINA_DEPRECATED EAPI void elm_datefield_layout_set(Evas_Object *obj, Elm_Datefield_Layout layout);
28322 EINA_DEPRECATED EAPI Elm_Datefield_Layout elm_datefield_layout_get(const Evas_Object *obj);
28323 EINA_DEPRECATED EAPI void elm_datefield_date_format_set(Evas_Object *obj, const char *fmt);
28324 EINA_DEPRECATED EAPI const char *elm_datefield_date_format_get(const Evas_Object *obj);
28325 EINA_DEPRECATED EAPI void elm_datefield_time_mode_set(Evas_Object *obj, Eina_Bool mode);
28326 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_time_mode_get(const Evas_Object *obj);
28327 EINA_DEPRECATED EAPI void elm_datefield_date_set(Evas_Object *obj, int year, int month, int day, int hour, int min);
28328 EINA_DEPRECATED EAPI void elm_datefield_date_get(const Evas_Object *obj, int *year, int *month, int *day, int *hour, int *min);
28329 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_max_set(Evas_Object *obj, int year, int month, int day);
28330 EINA_DEPRECATED EAPI void elm_datefield_date_max_get(const Evas_Object *obj, int *year, int *month, int *day);
28331 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_min_set(Evas_Object *obj, int year, int month, int day);
28332 EINA_DEPRECATED EAPI void elm_datefield_date_min_get(const Evas_Object *obj, int *year, int *month, int *day);
28333 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);
28334 EINA_DEPRECATED EAPI void elm_datefield_input_panel_state_callback_del(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value));
28335 /////////////////////////////////////////////////////////////////////
28338 typedef enum _Elm_Popup_Response
28340 ELM_POPUP_RESPONSE_NONE = -1,
28341 ELM_POPUP_RESPONSE_TIMEOUT = -2,
28342 ELM_POPUP_RESPONSE_OK = -3,
28343 ELM_POPUP_RESPONSE_CANCEL = -4,
28344 ELM_POPUP_RESPONSE_CLOSE = -5
28345 } Elm_Popup_Response;
28347 typedef enum _Elm_Popup_Mode
28349 ELM_POPUP_TYPE_NONE = 0,
28350 ELM_POPUP_TYPE_ALERT = (1 << 0)
28353 typedef enum _Elm_Popup_Orient
28355 ELM_POPUP_ORIENT_TOP,
28356 ELM_POPUP_ORIENT_CENTER,
28357 ELM_POPUP_ORIENT_BOTTOM,
28358 ELM_POPUP_ORIENT_LEFT,
28359 ELM_POPUP_ORIENT_RIGHT,
28360 ELM_POPUP_ORIENT_TOP_LEFT,
28361 ELM_POPUP_ORIENT_TOP_RIGHT,
28362 ELM_POPUP_ORIENT_BOTTOM_LEFT,
28363 ELM_POPUP_ORIENT_BOTTOM_RIGHT
28364 } Elm_Popup_Orient;
28366 /* smart callbacks called:
28367 * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
28370 EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
28371 EAPI void elm_popup_desc_set(Evas_Object *obj, const char *text);
28372 EAPI const char *elm_popup_desc_get(Evas_Object *obj);
28373 EAPI void elm_popup_title_label_set(Evas_Object *obj, const char *text);
28374 EAPI const char *elm_popup_title_label_get(Evas_Object *obj);
28375 EAPI void elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
28376 EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
28377 EAPI void elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
28378 EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
28379 EAPI void elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text, ...);
28380 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, ... );
28381 EAPI void elm_popup_timeout_set(Evas_Object *obj, double timeout);
28382 EAPI void elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
28383 EAPI void elm_popup_response(Evas_Object *obj, int response_id);
28384 EAPI void elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
28385 EAPI int elm_popup_run(Evas_Object *obj);
28387 /* NavigationBar */
28388 #define NAVIBAR_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28389 #define NAVIBAR_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28393 ELM_NAVIGATIONBAR_FUNCTION_BUTTON1,
28394 ELM_NAVIGATIONBAR_FUNCTION_BUTTON2,
28395 ELM_NAVIGATIONBAR_FUNCTION_BUTTON3,
28396 ELM_NAVIGATIONBAR_BACK_BUTTON
28397 } Elm_Navi_Button_Type;
28399 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_add(Evas_Object *parent);
28400 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);
28401 EINA_DEPRECATED EAPI void elm_navigationbar_pop(Evas_Object *obj);
28402 EINA_DEPRECATED EAPI void elm_navigationbar_to_content_pop(Evas_Object *obj, Evas_Object *content);
28403 EINA_DEPRECATED EAPI void elm_navigationbar_title_label_set(Evas_Object *obj, Evas_Object *content, const char *title);
28404 EINA_DEPRECATED EAPI const char *elm_navigationbar_title_label_get(Evas_Object *obj, Evas_Object *content);
28405 EINA_DEPRECATED EAPI void elm_navigationbar_title_object_add(Evas_Object *obj, Evas_Object *content, Evas_Object *title_obj);
28406 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_title_object_get(Evas_Object *obj, Evas_Object *content);
28407 EINA_DEPRECATED EAPI Eina_List *elm_navigationbar_title_object_list_get(Evas_Object *obj, Evas_Object *content);
28408 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_content_top_get(Evas_Object *obj);
28409 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_content_bottom_get(Evas_Object *obj);
28410 EINA_DEPRECATED EAPI void elm_navigationbar_hidden_set(Evas_Object *obj, Eina_Bool hidden);
28411 EINA_DEPRECATED EAPI void elm_navigationbar_title_button_set(Evas_Object *obj, Evas_Object *content, Evas_Object *button, Elm_Navi_Button_Type button_type);
28412 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_title_button_get(Evas_Object *obj, Evas_Object *content, Elm_Navi_Button_Type button_type);
28413 EINA_DEPRECATED EAPI const char *elm_navigationbar_subtitle_label_get(Evas_Object *obj, Evas_Object *content);
28414 EINA_DEPRECATED EAPI void elm_navigationbar_subtitle_label_set(Evas_Object *obj, Evas_Object *content, const char *subtitle);
28415 EINA_DEPRECATED EAPI void elm_navigationbar_title_object_list_unset(Evas_Object *obj, Evas_Object *content, Eina_List **list);
28416 EINA_DEPRECATED EAPI void elm_navigationbar_animation_disabled_set(Evas_Object *obj, Eina_Bool disable);
28417 EINA_DEPRECATED EAPI void elm_navigationbar_title_object_visible_set(Evas_Object *obj, Evas_Object *content, Eina_Bool visible);
28418 EINA_DEPRECATED Eina_Bool elm_navigationbar_title_object_visible_get(Evas_Object *obj, Evas_Object *content);
28419 EINA_DEPRECATED EAPI void elm_navigationbar_title_icon_set(Evas_Object *obj, Evas_Object *content, Evas_Object *icon);
28420 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_title_icon_get(Evas_Object *obj, Evas_Object *content);
28422 /* NavigationBar */
28423 #define NAVIBAR_EX_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28424 #define NAVIBAR_EX_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28428 ELM_NAVIGATIONBAR_EX_BACK_BUTTON,
28429 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON1,
28430 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON2,
28431 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON3,
28432 ELM_NAVIGATIONBAR_EX_MAX
28433 } Elm_Navi_ex_Button_Type;
28434 typedef struct _Elm_Navigationbar_ex_Item Elm_Navigationbar_ex_Item;
28436 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_add(Evas_Object *parent);
28437 EINA_DEPRECATED EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_push(Evas_Object *obj, Evas_Object *content, const char *item_style);
28438 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_pop(Evas_Object *obj);
28439 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_promote(Elm_Navigationbar_ex_Item* item);
28440 EINA_DEPRECATED EAPI void elm_navigationbar_ex_to_item_pop(Elm_Navigationbar_ex_Item* item);
28441 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_title_label_set(Elm_Navigationbar_ex_Item *item, const char *title);
28442 EINA_DEPRECATED EAPI const char *elm_navigationbar_ex_item_title_label_get(Elm_Navigationbar_ex_Item* item);
28443 EINA_DEPRECATED EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_top_get(const Evas_Object *obj);
28444 EINA_DEPRECATED EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_bottom_get(const Evas_Object *obj);
28445 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);
28446 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_title_button_get(Elm_Navigationbar_ex_Item* item, int button_type);
28447 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_title_object_set(Elm_Navigationbar_ex_Item* item, Evas_Object *title_obj);
28448 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_title_object_unset(Elm_Navigationbar_ex_Item* item);
28449 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_title_hidden_set(Elm_Navigationbar_ex_Item* item, Eina_Bool hidden);
28450 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_title_object_get(Elm_Navigationbar_ex_Item* item);
28451 EINA_DEPRECATED EAPI const char *elm_navigationbar_ex_item_subtitle_label_get(Elm_Navigationbar_ex_Item* item);
28452 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_subtitle_label_set( Elm_Navigationbar_ex_Item* item, const char *subtitle);
28453 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_style_set(Elm_Navigationbar_ex_Item* item, const char* item_style);
28454 EINA_DEPRECATED EAPI const char *elm_navigationbar_ex_item_style_get(Elm_Navigationbar_ex_Item* item);
28455 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_content_unset(Elm_Navigationbar_ex_Item* item);
28456 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_content_get(Elm_Navigationbar_ex_Item* item);
28457 EINA_DEPRECATED EAPI void elm_navigationbar_ex_delete_on_pop_set(Evas_Object *obj, Eina_Bool del_on_pop);
28458 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_icon_get(Elm_Navigationbar_ex_Item* item);
28459 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_icon_set(Elm_Navigationbar_ex_Item* item, Evas_Object *icon);
28460 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_title_button_unset(Elm_Navigationbar_ex_Item* item, int button_type);
28461 EINA_DEPRECATED EAPI void elm_navigationbar_ex_animation_disable_set(Evas_Object *obj, Eina_Bool disable);
28462 EINA_DEPRECATED EAPI void elm_navigationbar_ex_title_object_visible_set(Elm_Navigationbar_ex_Item* item, Eina_Bool visible);
28463 EINA_DEPRECATED Eina_Bool elm_navigationbar_ex_title_object_visible_get(Elm_Navigationbar_ex_Item* item);
28466 * @defgroup Naviframe Naviframe
28467 * @ingroup Elementary
28469 * @brief Naviframe is a kind of view manager for the applications.
28471 * Naviframe provides functions to switch different pages with stack
28472 * mechanism. It means if one page(item) needs to be changed to the new one,
28473 * then naviframe would push the new page to it's internal stack. Of course,
28474 * it can be back to the previous page by popping the top page. Naviframe
28475 * provides some transition effect while the pages are switching (same as
28478 * Since each item could keep the different styles, users could keep the
28479 * same look & feel for the pages or different styles for the items in it's
28482 * Signals that you can add callback for are:
28483 * @li "transition,finished" - When the transition is finished in changing
28485 * @li "title,clicked" - User clicked title area
28487 * Default contents parts of the naviframe items that you can use for are:
28488 * @li "elm.swallow.content" - A main content of the page
28489 * @li "elm.swallow.icon" - A icon in the title area
28490 * @li "elm.swallow.prev_btn" - A button to go to the previous page
28491 * @li "elm.swallow.next_btn" - A button to go to the next page
28493 * Default text parts of the naviframe items that you can use for are:
28494 * @li "elm.text.title" - Title label in the title area
28495 * @li "elm.text.subtitle" - Sub-title label in the title area
28497 * @ref tutorial_naviframe gives a good overview of the usage of the API.
28500 //Available commonly
28501 #define ELM_NAVIFRAME_ITEM_CONTENT "elm.swallow.content"
28502 #define ELM_NAVIFRAME_ITEM_ICON "elm.swallow.icon"
28503 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER "elm.swallow.optionheader"
28504 #define ELM_NAVIFRAME_ITEM_TITLE_LABEL "elm.text.title"
28505 #define ELM_NAVIFRAME_ITEM_PREV_BTN "elm.swallow.prev_btn"
28506 #define ELM_NAVIFRAME_ITEM_TITLE_LEFT_BTN "elm.swallow.left_btn"
28507 #define ELM_NAVIFRAME_ITEM_TITLE_RIGHT_BTN "elm.swallow.right_btn"
28508 #define ELM_NAVIFRAME_ITEM_TITLE_MORE_BTN "elm.swallow.more_btn"
28509 #define ELM_NAVIFRAME_ITEM_CONTROLBAR "elm.swallow.controlbar"
28510 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_CLOSE "elm,state,optionheader,close", ""
28511 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_OPEN "elm,state,optionheader,open", ""
28512 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_CLOSE "elm,state,optionheader,instant_close", ""
28513 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_OPEN "elm,state,optionheader,instant_open", ""
28515 //Available only in a style - "2line"
28516 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER2 "elm.swallow.optionheader2"
28518 //Available only in a style - "segment"
28519 #define ELM_NAVIFRAME_ITEM_SEGMENT2 "elm.swallow.segment2"
28520 #define ELM_NAVIFRAME_ITEM_SEGMENT3 "elm.swallow.segment3"
28523 * @addtogroup Naviframe
28528 * @brief Add a new Naviframe object to the parent.
28530 * @param parent Parent object
28531 * @return New object or @c NULL, if it cannot be created
28533 * @ingroup Naviframe
28535 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28537 * @brief Push a new item to the top of the naviframe stack (and show it).
28539 * @param obj The naviframe object
28540 * @param title_label The label in the title area. The name of the title
28541 * label part is "elm.text.title"
28542 * @param prev_btn The button to go to the previous item. If it is NULL,
28543 * then naviframe will create a back button automatically. The name of
28544 * the prev_btn part is "elm.swallow.prev_btn"
28545 * @param next_btn The button to go to the next item. Or It could be just an
28546 * extra function button. The name of the next_btn part is
28547 * "elm.swallow.next_btn"
28548 * @param content The main content object. The name of content part is
28549 * "elm.swallow.content"
28550 * @param item_style The current item style name. @c NULL would be default.
28551 * @return The created item or @c NULL upon failure.
28553 * The item pushed becomes one page of the naviframe, this item will be
28554 * deleted when it is popped.
28556 * @see also elm_naviframe_item_style_set()
28557 * @see also elm_naviframe_item_insert_before()
28558 * @see also elm_naviframe_item_insert_after()
28560 * The following styles are available for this item:
28563 * @ingroup Naviframe
28565 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);
28567 * @brief Insert a new item into the naviframe before item @p before.
28569 * @param before The naviframe item to insert before.
28570 * @param title_label The label in the title area. The name of the title
28571 * label part is "elm.text.title"
28572 * @param prev_btn The button to go to the previous item. If it is NULL,
28573 * then naviframe will create a back button automatically. The name of
28574 * the prev_btn part is "elm.swallow.prev_btn"
28575 * @param next_btn The button to go to the next item. Or It could be just an
28576 * extra function button. The name of the next_btn part is
28577 * "elm.swallow.next_btn"
28578 * @param content The main content object. The name of content part is
28579 * "elm.swallow.content"
28580 * @param item_style The current item style name. @c NULL would be default.
28581 * @return The created item or @c NULL upon failure.
28583 * The item is inserted into the naviframe straight away without any
28584 * transition operations. This item will be deleted when it is popped.
28586 * @see also elm_naviframe_item_style_set()
28587 * @see also elm_naviframe_item_push()
28588 * @see also elm_naviframe_item_insert_after()
28590 * The following styles are available for this item:
28593 * @ingroup Naviframe
28595 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);
28597 * @brief Insert a new item into the naviframe after item @p after.
28599 * @param after The naviframe item to insert after.
28600 * @param title_label The label in the title area. The name of the title
28601 * label part is "elm.text.title"
28602 * @param prev_btn The button to go to the previous item. If it is NULL,
28603 * then naviframe will create a back button automatically. The name of
28604 * the prev_btn part is "elm.swallow.prev_btn"
28605 * @param next_btn The button to go to the next item. Or It could be just an
28606 * extra function button. The name of the next_btn part is
28607 * "elm.swallow.next_btn"
28608 * @param content The main content object. The name of content part is
28609 * "elm.swallow.content"
28610 * @param item_style The current item style name. @c NULL would be default.
28611 * @return The created item or @c NULL upon failure.
28613 * The item is inserted into the naviframe straight away without any
28614 * transition operations. This item will be deleted when it is popped.
28616 * @see also elm_naviframe_item_style_set()
28617 * @see also elm_naviframe_item_push()
28618 * @see also elm_naviframe_item_insert_before()
28620 * The following styles are available for this item:
28623 * @ingroup Naviframe
28625 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);
28627 * @brief Pop an item that is on top of the stack
28629 * @param obj The naviframe object
28630 * @return @c NULL or the content object(if the
28631 * elm_naviframe_content_preserve_on_pop_get is true).
28633 * This pops an item that is on the top(visible) of the naviframe, makes it
28634 * disappear, then deletes the item. The item that was underneath it on the
28635 * stack will become visible.
28637 * @see also elm_naviframe_content_preserve_on_pop_get()
28639 * @ingroup Naviframe
28641 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28643 * @brief Pop the items between the top and the above one on the given item.
28645 * @param it The naviframe item
28647 * @ingroup Naviframe
28649 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28651 * Promote an item already in the naviframe stack to the top of the stack
28653 * @param it The naviframe item
28655 * This will take the indicated item and promote it to the top of the stack
28656 * as if it had been pushed there. The item must already be inside the
28657 * naviframe stack to work.
28660 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28662 * @brief Delete the given item instantly.
28664 * @param it The naviframe item
28666 * This just deletes the given item from the naviframe item list instantly.
28667 * So this would not emit any signals for view transitions but just change
28668 * the current view if the given item is a top one.
28670 * @ingroup Naviframe
28672 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28674 * @brief preserve the content objects when items are popped.
28676 * @param obj The naviframe object
28677 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28679 * @see also elm_naviframe_content_preserve_on_pop_get()
28681 * @ingroup Naviframe
28683 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28685 * @brief Get a value whether preserve mode is enabled or not.
28687 * @param obj The naviframe object
28688 * @return If @c EINA_TRUE, preserve mode is enabled
28690 * @see also elm_naviframe_content_preserve_on_pop_set()
28692 * @ingroup Naviframe
28694 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28696 * @brief Get a top item on the naviframe stack
28698 * @param obj The naviframe object
28699 * @return The top item on the naviframe stack or @c NULL, if the stack is
28702 * @ingroup Naviframe
28704 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28706 * @brief Get a bottom item on the naviframe stack
28708 * @param obj The naviframe object
28709 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28712 * @ingroup Naviframe
28714 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28716 * @brief Set an item style
28718 * @param obj The naviframe item
28719 * @param item_style The current item style name. @c NULL would be default
28721 * The following styles are available for this item:
28724 * @see also elm_naviframe_item_style_get()
28726 * @ingroup Naviframe
28728 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28730 * @brief Get an item style
28732 * @param obj The naviframe item
28733 * @return The current item style name
28735 * @see also elm_naviframe_item_style_set()
28737 * @ingroup Naviframe
28739 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28741 * @brief Show/Hide the title area
28743 * @param it The naviframe item
28744 * @param visible If @c EINA_TRUE, title area will be visible, hidden
28747 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
28749 * @see also elm_naviframe_item_title_visible_get()
28751 * @ingroup Naviframe
28753 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28755 * @brief Get a value whether title area is visible or not.
28757 * @param it The naviframe item
28758 * @return If @c EINA_TRUE, title area is visible
28760 * @see also elm_naviframe_item_title_visible_set()
28762 * @ingroup Naviframe
28764 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28767 * @brief Set creating prev button automatically or not
28769 * @param obj The naviframe object
28770 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28771 * be created internally when you pass the @c NULL to the prev_btn
28772 * parameter in elm_naviframe_item_push
28774 * @see also elm_naviframe_item_push()
28776 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28778 * @brief Get a value whether prev button(back button) will be auto pushed or
28781 * @param obj The naviframe object
28782 * @return If @c EINA_TRUE, prev button will be auto pushed.
28784 * @see also elm_naviframe_item_push()
28785 * elm_naviframe_prev_btn_auto_pushed_set()
28787 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28789 * @brief Get a list of all the naviframe items.
28791 * @param obj The naviframe object
28792 * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
28793 * or @c NULL on failure.
28795 EAPI Eina_Inlist *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28802 #define CONTROLBAR_SYSTEM_ICON_ALBUMS "controlbar_albums"
28803 #define CONTROLBAR_SYSTEM_ICON_ARTISTS "controlbar_artists"
28804 #define CONTROLBAR_SYSTEM_ICON_SONGS "controlbar_songs"
28805 #define CONTROLBAR_SYSTEM_ICON_PLAYLIST "controlbar_playlist"
28806 #define CONTROLBAR_SYSTEM_ICON_MORE "controlbar_more"
28807 #define CONTROLBAR_SYSTEM_ICON_CONTACTS "controlbar_contacts"
28808 #define CONTROLBAR_SYSTEM_ICON_DIALER "controlbar_dialer"
28809 #define CONTROLBAR_SYSTEM_ICON_FAVORITES "controlbar_favorites"
28810 #define CONTROLBAR_SYSTEM_ICON_LOGS "controlbar_logs"
28812 typedef enum _Elm_Controlbar_Mode_Type
28814 ELM_CONTROLBAR_MODE_DEFAULT = 0,
28815 ELM_CONTROLBAR_MODE_TRANSLUCENCE,
28816 ELM_CONTROLBAR_MODE_TRANSPARENCY,
28817 ELM_CONTROLBAR_MODE_LARGE,
28818 ELM_CONTROLBAR_MODE_SMALL,
28819 ELM_CONTROLBAR_MODE_LEFT,
28820 ELM_CONTROLBAR_MODE_RIGHT
28821 } Elm_Controlbar_Mode_Type;
28823 typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
28824 EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
28825 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
28826 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
28827 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);
28828 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);
28829 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);
28830 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);
28831 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);
28832 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);
28833 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
28834 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
28835 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
28836 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
28837 EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
28838 EAPI void elm_controlbar_item_del(Elm_Controlbar_Item *it);
28839 EAPI void elm_controlbar_item_select(Elm_Controlbar_Item *it);
28840 EAPI void elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
28841 EAPI Eina_Bool elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
28842 EAPI void elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
28843 EAPI Eina_Bool elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
28844 EAPI void elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
28845 EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
28846 EAPI void elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
28847 EAPI const char *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
28848 EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
28849 EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
28850 EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
28851 EAPI const Eina_List *elm_controlbar_items_get(const Evas_Object *obj);
28852 EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
28853 EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
28854 EAPI void elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
28855 EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
28856 EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
28857 EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
28858 EAPI void elm_controlbar_mode_set(Evas_Object *obj, int mode);
28859 EAPI void elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
28860 EAPI void elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
28861 EAPI void elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
28864 EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
28865 EAPI void elm_searchbar_text_set(Evas_Object *obj, const char *entry);
28866 EAPI const char *elm_searchbar_text_get(Evas_Object *obj);
28867 EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
28868 EAPI Evas_Object *elm_searchbar_editfield_get(Evas_Object *obj);
28869 EAPI void elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
28870 EAPI void elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
28871 EAPI void elm_searchbar_clear(Evas_Object *obj);
28872 EAPI void elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);
28874 EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
28875 EAPI void elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
28876 EAPI void elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
28877 EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
28880 EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
28881 EAPI void elm_nocontents_label_set(Evas_Object *obj, const char *label);
28882 EAPI const char *elm_nocontents_label_get(const Evas_Object *obj);
28883 EAPI void elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
28884 EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
28889 ELM_TICKERNOTI_ORIENT_TOP = 0,
28890 ELM_TICKERNOTI_ORIENT_BOTTOM,
28891 ELM_TICKERNOTI_ORIENT_LAST
28892 } Elm_Tickernoti_Orient;
28894 EAPI Evas_Object *elm_tickernoti_add (Evas_Object *parent);
28895 EAPI void elm_tickernoti_orient_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
28896 EAPI Elm_Tickernoti_Orient elm_tickernoti_orient_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28897 EAPI int elm_tickernoti_rotation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28898 EAPI void elm_tickernoti_rotation_set (Evas_Object *obj, int angle) EINA_ARG_NONNULL(1);
28899 EAPI Evas_Object *elm_tickernoti_win_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28900 /* #### Below APIs and data structures are going to be deprecated, announcment will be made soon ####*/
28903 ELM_TICKERNOTI_DEFAULT,
28904 ELM_TICKERNOTI_DETAILVIEW
28905 } Elm_Tickernoti_Mode;
28906 EAPI void elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
28907 EAPI const char *elm_tickernoti_detailview_label_get (const Evas_Object *obj)EINA_ARG_NONNULL(1);
28908 EAPI void elm_tickernoti_detailview_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(2);
28909 EAPI Evas_Object *elm_tickernoti_detailview_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28910 EAPI void elm_tickernoti_detailview_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
28911 EAPI Evas_Object *elm_tickernoti_detailview_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28912 EAPI Evas_Object *elm_tickernoti_detailview_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28913 EAPI void elm_tickernoti_mode_set (Evas_Object *obj, Elm_Tickernoti_Mode mode) EINA_ARG_NONNULL(1);
28914 EAPI Elm_Tickernoti_Mode elm_tickernoti_mode_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28915 EAPI void elm_tickernoti_orientation_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
28916 EAPI Elm_Tickernoti_Orient elm_tickernoti_orientation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28917 EAPI void elm_tickernoti_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
28918 EAPI const char *elm_tickernoti_label_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28919 EAPI void elm_tickernoti_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
28920 EAPI Evas_Object *elm_tickernoti_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28921 EAPI void elm_tickernoti_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(1);
28922 EAPI Evas_Object *elm_tickernoti_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28923 /* ############################################################################### */
28925 * Parts which can be used with elm_object_text_part_set() and
28926 * elm_object_text_part_get():
28928 * @li NULL/"default" - Operates on tickernoti content-text
28930 * Parts which can be used with elm_object_content_part_set(),
28931 * elm_object_content_part_get() and elm_object_content_part_unset():
28933 * @li "icon" - Operates on tickernoti's icon
28934 * @li "button" - Operates on tickernoti's button
28936 * smart callbacks called:
28937 * @li "clicked" - emitted when tickernoti is clicked, except at the
28938 * swallow/button region, if any.
28939 * @li "hide" - emitted when the tickernoti is completely hidden. In case of
28940 * any hide animation, this signal is emitted after the animation.
28944 typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
28946 struct _Colorpalette_Color
28948 unsigned int r, g, b;
28951 EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
28952 EAPI void elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
28953 EAPI void elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
28954 /* smart callbacks called:
28955 * "clicked" - when image clicked
28959 EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
28960 EAPI void elm_editfield_label_set(Evas_Object *obj, const char *label);
28961 EAPI const char *elm_editfield_label_get(Evas_Object *obj);
28962 EAPI void elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
28963 EAPI const char *elm_editfield_guide_text_get(Evas_Object *obj);
28964 EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
28965 // EAPI Evas_Object *elm_editfield_clear_button_show(Evas_Object *obj, Eina_Bool show);
28966 EAPI void elm_editfield_right_icon_set(Evas_Object *obj, Evas_Object *icon);
28967 EAPI Evas_Object *elm_editfield_right_icon_get(Evas_Object *obj);
28968 EAPI void elm_editfield_left_icon_set(Evas_Object *obj, Evas_Object *icon);
28969 EAPI Evas_Object *elm_editfield_left_icon_get(Evas_Object *obj);
28970 EAPI void elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
28971 EAPI Eina_Bool elm_editfield_entry_single_line_get(Evas_Object *obj);
28972 EAPI void elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
28973 EAPI Eina_Bool elm_editfield_eraser_get(Evas_Object *obj);
28974 /* smart callbacks called:
28975 * "clicked" - when an editfield is clicked
28976 * "unfocused" - when an editfield is unfocused
28980 /* Sliding Drawer */
28981 typedef enum _Elm_SlidingDrawer_Pos
28983 ELM_SLIDINGDRAWER_BOTTOM,
28984 ELM_SLIDINGDRAWER_LEFT,
28985 ELM_SLIDINGDRAWER_RIGHT,
28986 ELM_SLIDINGDRAWER_TOP
28987 } Elm_SlidingDrawer_Pos;
28989 typedef struct _Elm_SlidingDrawer_Drag_Value
28992 } Elm_SlidingDrawer_Drag_Value;
28994 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_add(Evas_Object *parent);
28995 EINA_DEPRECATED EAPI void elm_slidingdrawer_content_set (Evas_Object *obj, Evas_Object *content);
28996 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_content_unset(Evas_Object *obj);
28997 EINA_DEPRECATED EAPI void elm_slidingdrawer_pos_set(Evas_Object *obj, Elm_SlidingDrawer_Pos pos);
28998 EINA_DEPRECATED EAPI void elm_slidingdrawer_max_drag_value_set(Evas_Object *obj, double dw, double dh);
28999 EINA_DEPRECATED EAPI void elm_slidingdrawer_drag_value_set(Evas_Object *obj, double dx, double dy);
29001 /* multibuttonentry */
29002 typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
29003 typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
29004 EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent);
29005 EAPI const char *elm_multibuttonentry_label_get(const Evas_Object *obj);
29006 EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
29007 EAPI Evas_Object *elm_multibuttonentry_entry_get(const Evas_Object *obj);
29008 EAPI const char * elm_multibuttonentry_guide_text_get(const Evas_Object *obj);
29009 EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
29010 EAPI int elm_multibuttonentry_contracted_state_get(const Evas_Object *obj);
29011 EAPI void elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
29012 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
29013 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
29014 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
29015 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
29016 EAPI const Eina_List *elm_multibuttonentry_items_get(const Evas_Object *obj);
29017 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(const Evas_Object *obj);
29018 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(const Evas_Object *obj);
29019 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(const Evas_Object *obj);
29020 EAPI void elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
29021 EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
29022 EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
29023 EAPI void elm_multibuttonentry_items_del(Evas_Object *obj);
29024 EAPI const char *elm_multibuttonentry_item_label_get(const Elm_Multibuttonentry_Item *item);
29025 EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
29026 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
29027 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
29028 EAPI void *elm_multibuttonentry_item_data_get(const Elm_Multibuttonentry_Item *item);
29029 EAPI void elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
29030 EAPI void elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
29031 /* smart callback called:
29032 * "selected" - This signal is emitted when the selected item of multibuttonentry is changed.
29033 * "added" - This signal is emitted when a new multibuttonentry item is added.
29034 * "deleted" - This signal is emitted when a multibuttonentry item is deleted.
29035 * "expanded" - This signal is emitted when a multibuttonentry is expanded.
29036 * "contracted" - This signal is emitted when a multibuttonentry is contracted.
29037 * "contracted,state,changed" - This signal is emitted when the contracted state of multibuttonentry is changed.
29038 * "item,selected" - This signal is emitted when the selected item of multibuttonentry is changed.
29039 * "item,added" - This signal is emitted when a new multibuttonentry item is added.
29040 * "item,deleted" - This signal is emitted when a multibuttonentry item is deleted.
29041 * "item,clicked" - This signal is emitted when a multibuttonentry item is clicked.
29042 * "clicked" - This signal is emitted when a multibuttonentry is clicked.
29043 * "unfocused" - This signal is emitted when a multibuttonentry is unfocused.
29045 /* available styles:
29050 typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
29051 EAPI Evas_Object *elm_stackedicon_add(Evas_Object *parent);
29052 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
29053 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
29054 EAPI void elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
29055 EAPI Eina_List *elm_stackedicon_item_list_get(Evas_Object *obj);
29056 /* smart callback called:
29057 * "expanded" - This signal is emitted when a stackedicon is expanded.
29058 * "clicked" - This signal is emitted when a stackedicon is clicked.
29060 /* available styles:
29064 /* dialoguegroup */
29065 typedef struct _Dialogue_Item Dialogue_Item;
29067 typedef enum _Elm_Dialoguegourp_Item_Style
29069 ELM_DIALOGUEGROUP_ITEM_STYLE_DEFAULT = 0,
29070 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD = (1 << 0),
29071 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD_WITH_TITLE = (1 << 1),
29072 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_TITLE = (1 << 2),
29073 ELM_DIALOGUEGROUP_ITEM_STYLE_HIDDEN = (1 << 3),
29074 ELM_DIALOGUEGROUP_ITEM_STYLE_DATAVIEW = (1 << 4),
29075 ELM_DIALOGUEGROUP_ITEM_STYLE_NO_BG = (1 << 5),
29076 ELM_DIALOGUEGROUP_ITEM_STYLE_SUB = (1 << 6),
29077 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT = (1 << 7),
29078 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_MERGE = (1 << 8),
29079 ELM_DIALOGUEGROUP_ITEM_STYLE_LAST = (1 << 9)
29080 } Elm_Dialoguegroup_Item_Style;
29082 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_add(Evas_Object *parent);
29083 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_append(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
29084 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_prepend(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
29085 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_after(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *after, Elm_Dialoguegroup_Item_Style style);
29086 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_before(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *before, Elm_Dialoguegroup_Item_Style style);
29087 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove(Dialogue_Item *item);
29088 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove_all(Evas_Object *obj);
29089 EINA_DEPRECATED EAPI void elm_dialoguegroup_title_set(Evas_Object *obj, const char *title);
29090 EINA_DEPRECATED EAPI const char *elm_dialoguegroup_title_get(Evas_Object *obj);
29091 EINA_DEPRECATED EAPI void elm_dialoguegroup_press_effect_set(Dialogue_Item *item, Eina_Bool press);
29092 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_press_effect_get(Dialogue_Item *item);
29093 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_item_content_get(Dialogue_Item *item);
29094 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_style_set(Dialogue_Item *item, Elm_Dialoguegroup_Item_Style style);
29095 EINA_DEPRECATED EAPI Elm_Dialoguegroup_Item_Style elm_dialoguegroup_item_style_get(Dialogue_Item *item);
29096 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_disabled_set(Dialogue_Item *item, Eina_Bool disabled);
29097 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_item_disabled_get(Dialogue_Item *item);
29102 ELM_DAYSELECTOR_SUN,
29103 ELM_DAYSELECTOR_MON,
29104 ELM_DAYSELECTOR_TUE,
29105 ELM_DAYSELECTOR_WED,
29106 ELM_DAYSELECTOR_THU,
29107 ELM_DAYSELECTOR_FRI,
29108 ELM_DAYSELECTOR_SAT
29109 } Elm_DaySelector_Day;
29111 EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
29112 EAPI Eina_Bool elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
29113 EAPI void elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
29116 typedef struct _Imageslider_Item Elm_Imageslider_Item;
29117 typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
29118 EAPI Evas_Object *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
29119 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);
29120 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);
29121 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);
29122 EAPI void elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29123 EAPI Elm_Imageslider_Item *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
29124 EAPI Eina_Bool elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29125 EAPI void elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29126 EAPI const char *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29127 EAPI Elm_Imageslider_Item *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29128 EAPI Elm_Imageslider_Item *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29129 EAPI void elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
29130 EAPI void elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
29131 EAPI void elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
29132 EAPI void elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);