3 * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
8 @brief Elementary Widget Library
13 @image html elementary.png
17 @section intro What is Elementary?
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
22 It is meant to make the programmers work almost brainless but give them lots
25 @li @ref Start - Go here to quickly get started with writing Apps
27 @section organization Organization
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers which hold the widgets.
34 @section license License
36 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
37 all files in the source tree.
39 @section ack Acknowledgements
40 There is a lot that goes into making a widget set, and they don't happen out of
41 nothing. It's like trying to make everyone everywhere happy, regardless of age,
42 gender, race or nationality - and that is really tough. So thanks to people and
43 organisations behind this, as listed in the @ref authors page.
48 * @defgroup Start Getting Started
50 * To write an Elementary app, you can get started with the following:
53 #include <Elementary.h>
55 elm_main(int argc, char **argv)
57 // create window(s) here and do any application init
58 elm_run(); // run main loop
59 elm_shutdown(); // after mainloop finishes running, shutdown
60 return 0; // exit 0 for exit code
65 * To use autotools (which helps in many ways in the long run, like being able
66 * to immediately create releases of your software directly from your tree
67 * and ensure everything needed to build it is there) you will need a
68 * configure.ac, Makefile.am and autogen.sh file.
73 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
75 AC_CONFIG_SRCDIR(configure.ac)
76 AM_CONFIG_HEADER(config.h)
78 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
79 PKG_CHECK_MODULES([ELEMENTARY], elementary)
86 AUTOMAKE_OPTIONS = 1.4 foreign
87 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
89 INCLUDES = -I$(top_srcdir)
93 myapp_SOURCES = main.c
94 myapp_LDADD = @ELEMENTARY_LIBS@
95 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
102 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
103 echo "Running autoheader..." ; autoheader || exit 1
104 echo "Running autoconf..." ; autoconf || exit 1
105 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
109 * To generate all the things needed to bootstrap just run:
115 * This will generate Makefile.in's, the confgure script and everything else.
116 * After this it works like all normal autotools projects:
123 * Note sudo was assumed to get root permissions, as this would install in
124 * /usr/local which is system-owned. Use any way you like to gain root, or
125 * specify a different prefix with configure:
128 ./confiugre --prefix=$HOME/mysoftware
131 * Also remember that autotools buys you some useful commands like:
136 * This uninstalls the software after it was installed with "make install".
137 * It is very useful to clear up what you built if you wish to clean the
144 * This firstly checks if your build tree is "clean" and ready for
145 * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
146 * ready to upload and distribute to the world, that contains the generated
147 * Makefile.in's and configure script. The users do not need to run
148 * autogen.sh - just configure and on. They don't need autotools installed.
149 * This tarball also builds cleanly, has all the sources it needs to build
150 * included (that is sources for your application, not libraries it depends
151 * on like Elementary). It builds cleanly in a buildroot and does not
152 * contain any files that are temporarily generated like binaries and other
153 * build-generated files, so the tarball is clean, and no need to worry
154 * about cleaning up your tree before packaging.
160 * This cleans up all build files (binaries, objects etc.) from the tree.
166 * This cleans out all files from the build and from configure's output too.
169 make maintainer-clean
172 * This deletes all the files autogen.sh will produce so the tree is clean
173 * to be put into a revision-control system (like CVS, SVN or GIT for example).
175 * There is a more advanced way of making use of the quicklaunch infrastructure
176 * in Elementary (which will not be covered here due to its more advanced
179 * Now let's actually create an interactive "Hello World" gui that you can
180 * click the ok button to exit. It's more code because this now does something
181 * much more significant, but it's still very simple:
184 #include <Elementary.h>
187 on_done(void *data, Evas_Object *obj, void *event_info)
189 // quit the mainloop (elm_run function will return)
194 elm_main(int argc, char **argv)
196 Evas_Object *win, *bg, *box, *lab, *btn;
198 // new window - do the usual and give it a name (hello) and title (Hello)
199 win = elm_win_util_standard_add("hello", "Hello");
200 // when the user clicks "close" on a window there is a request to delete
201 evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
203 // add a box object - default is vertical. a box holds children in a row,
204 // either horizontally or vertically. nothing more.
205 box = elm_box_add(win);
206 // make the box hotizontal
207 elm_box_horizontal_set(box, EINA_TRUE);
208 // add object as a resize object for the window (controls window minimum
209 // size as well as gets resized if window is resized)
210 elm_win_resize_object_add(win, box);
211 evas_object_show(box);
213 // add a label widget, set the text and put it in the pad frame
214 lab = elm_label_add(win);
215 // set default text of the label
216 elm_object_text_set(lab, "Hello out there world!");
217 // pack the label at the end of the box
218 elm_box_pack_end(box, lab);
219 evas_object_show(lab);
222 btn = elm_button_add(win);
223 // set default text of button to "OK"
224 elm_object_text_set(btn, "OK");
225 // pack the button at the end of the box
226 elm_box_pack_end(box, btn);
227 evas_object_show(btn);
228 // call on_done when button is clicked
229 evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
231 // now we are done, show the window
232 evas_object_show(win);
234 // run the mainloop and process events and callbacks
244 @page authors Authors
245 @author Carsten Haitzler <raster@@rasterman.com>
246 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
247 @author Cedric Bail <cedric.bail@@free.fr>
248 @author Vincent Torri <vtorri@@univ-evry.fr>
249 @author Daniel Kolesa <quaker66@@gmail.com>
250 @author Jaime Thomas <avi.thomas@@gmail.com>
251 @author Swisscom - http://www.swisscom.ch/
252 @author Christopher Michael <devilhorns@@comcast.net>
253 @author Marco Trevisan (TreviƱo) <mail@@3v1n0.net>
254 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
255 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
256 @author Brian Wang <brian.wang.0721@@gmail.com>
257 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
258 @author Samsung Electronics <tbd>
259 @author Samsung SAIT <tbd>
260 @author Brett Nash <nash@@nash.id.au>
261 @author Bruno Dilly <bdilly@@profusion.mobi>
262 @author Rafael Fonseca <rfonseca@@profusion.mobi>
263 @author Chuneon Park <hermet@@hermet.pe.kr>
264 @author Woohyun Jung <wh0705.jung@@samsung.com>
265 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
266 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
267 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
268 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
269 @author Gustavo Lima Chaves <glima@@profusion.mobi>
270 @author Fabiano FidĆŖncio <fidencio@@profusion.mobi>
271 @author Tiago FalcĆ£o <tiago@@profusion.mobi>
272 @author Otavio Pontes <otavio@@profusion.mobi>
273 @author Viktor Kojouharov <vkojouharov@@gmail.com>
274 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
275 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
276 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
277 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
278 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
279 @author Jihoon Kim <jihoon48.kim@@samsung.com>
280 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
281 @author Tom Hacohen <tom@@stosb.com>
282 @author Aharon Hillel <a.hillel@@partner.samsung.com>
283 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
284 @author Shinwoo Kim <kimcinoo@@gmail.com>
285 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
286 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
287 @author Sung W. Park <sungwoo@gmail.com>
288 @author Thierry el Borgi <thierry@substantiel.fr>
289 @author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
290 @author Chanwook Jung <joey.jung@samsung.com>
291 @author Hyoyoung Chang <hyoyoung.chang@samsung.com>
292 @author Guillaume "Kuri" Friloux <guillaume.friloux@asp64.com>
293 @author Kim Yunhan <spbear@gmail.com>
295 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
296 contact with the developers and maintainers.
304 * @brief Elementary's API
309 @ELM_UNIX_DEF@ ELM_UNIX
310 @ELM_WIN32_DEF@ ELM_WIN32
311 @ELM_WINCE_DEF@ ELM_WINCE
312 @ELM_EDBUS_DEF@ ELM_EDBUS
313 @ELM_EFREET_DEF@ ELM_EFREET
314 @ELM_ETHUMB_DEF@ ELM_ETHUMB
315 @ELM_WEB_DEF@ ELM_WEB
316 @ELM_EMAP_DEF@ ELM_EMAP
317 @ELM_DEBUG_DEF@ ELM_DEBUG
318 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
319 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
321 /* Standard headers for standard system calls etc. */
326 #include <sys/types.h>
327 #include <sys/stat.h>
328 #include <sys/time.h>
329 #include <sys/param.h>
342 # ifdef ELM_LIBINTL_H
343 # include <libintl.h>
354 #if defined (ELM_WIN32) || defined (ELM_WINCE)
357 # define alloca _alloca
368 #include <Ecore_Evas.h>
369 #include <Ecore_File.h>
370 #include <Ecore_IMF.h>
371 #include <Ecore_Con.h>
380 # include <Efreet_Mime.h>
381 # include <Efreet_Trash.h>
385 # include <Ethumb_Client.h>
397 # ifdef ELEMENTARY_BUILD
399 # define EAPI __declspec(dllexport)
402 # endif /* ! DLL_EXPORT */
404 # define EAPI __declspec(dllimport)
405 # endif /* ! EFL_EVAS_BUILD */
409 # define EAPI __attribute__ ((visibility("default")))
416 #endif /* ! _WIN32 */
421 # define EAPI_MAIN EAPI
424 /* allow usage from c++ */
429 #define ELM_VERSION_MAJOR @VMAJ@
430 #define ELM_VERSION_MINOR @VMIN@
432 typedef struct _Elm_Version
440 EAPI extern Elm_Version *elm_version;
443 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
444 #define ELM_PI 3.14159265358979323846
447 * @defgroup General General
449 * @brief General Elementary API. Functions that don't relate to
450 * Elementary objects specifically.
452 * Here are documented functions which init/shutdown the library,
453 * that apply to generic Elementary objects, that deal with
454 * configuration, et cetera.
456 * @ref general_functions_example_page "This" example contemplates
457 * some of these functions.
461 * @addtogroup General
466 * Defines couple of standard Evas_Object layers to be used
467 * with evas_object_layer_set().
469 * @note whenever extending with new values, try to keep some padding
470 * to siblings so there is room for further extensions.
472 typedef enum _Elm_Object_Layer
474 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
475 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
476 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
477 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
478 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
479 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
482 /**************************************************************************/
483 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
486 * Emitted when any Elementary's policy value is changed.
488 EAPI extern int ELM_EVENT_POLICY_CHANGED;
491 * @typedef Elm_Event_Policy_Changed
493 * Data on the event when an Elementary policy has changed
495 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
498 * @struct _Elm_Event_Policy_Changed
500 * Data on the event when an Elementary policy has changed
502 struct _Elm_Event_Policy_Changed
504 unsigned int policy; /**< the policy identifier */
505 int new_value; /**< value the policy had before the change */
506 int old_value; /**< new value the policy got */
510 * Policy identifiers.
512 typedef enum _Elm_Policy
514 ELM_POLICY_QUIT, /**< under which circumstances the application
515 * should quit automatically. @see
519 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
522 typedef enum _Elm_Policy_Quit
524 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
526 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
528 * window is closed */
529 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
531 typedef enum _Elm_Focus_Direction
535 } Elm_Focus_Direction;
537 typedef enum _Elm_Text_Format
539 ELM_TEXT_FORMAT_PLAIN_UTF8,
540 ELM_TEXT_FORMAT_MARKUP_UTF8
544 * Line wrapping types.
546 typedef enum _Elm_Wrap_Type
548 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
549 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
550 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
551 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
557 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
558 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
559 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
560 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
561 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
562 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
563 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
564 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
565 ELM_INPUT_PANEL_LAYOUT_INVALID
566 } Elm_Input_Panel_Layout;
570 ELM_AUTOCAPITAL_TYPE_NONE,
571 ELM_AUTOCAPITAL_TYPE_WORD,
572 ELM_AUTOCAPITAL_TYPE_SENTENCE,
573 ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
574 } Elm_Autocapital_Type;
577 * @typedef Elm_Object_Item
578 * An Elementary Object item handle.
581 typedef struct _Elm_Object_Item Elm_Object_Item;
585 * Called back when a widget's tooltip is activated and needs content.
586 * @param data user-data given to elm_object_tooltip_content_cb_set()
587 * @param obj owner widget.
589 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj);
592 * Called back when a widget's item tooltip is activated and needs content.
593 * @param data user-data given to elm_object_tooltip_content_cb_set()
594 * @param obj owner widget.
595 * @param item context dependent item. As an example, if tooltip was
596 * set on Elm_List_Item, then it is of this type.
598 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, void *item);
600 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
602 #ifndef ELM_LIB_QUICKLAUNCH
603 #define ELM_MAIN() int main(int argc, char **argv) {elm_init(argc, argv); return elm_main(argc, argv);} /**< macro to be used after the elm_main() function */
605 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
608 /**************************************************************************/
612 * Initialize Elementary
614 * @param[in] argc System's argument count value
615 * @param[in] argv System's pointer to array of argument strings
616 * @return The init counter value.
618 * This function initializes Elementary and increments a counter of
619 * the number of calls to it. It returns the new counter's value.
621 * @warning This call is exported only for use by the @c ELM_MAIN()
622 * macro. There is no need to use this if you use this macro (which
623 * is highly advisable). An elm_main() should contain the entry
624 * point code for your application, having the same prototype as
625 * elm_init(), and @b not being static (putting the @c EAPI symbol
626 * in front of its type declaration is advisable). The @c
627 * ELM_MAIN() call should be placed just after it.
630 * @dontinclude bg_example_01.c
634 * See the full @ref bg_example_01_c "example".
636 * @see elm_shutdown().
639 EAPI int elm_init(int argc, char **argv);
642 * Shut down Elementary
644 * @return The init counter value.
646 * This should be called at the end of your application, just
647 * before it ceases to do any more processing. This will clean up
648 * any permanent resources your application may have allocated via
649 * Elementary that would otherwise persist.
651 * @see elm_init() for an example
655 EAPI int elm_shutdown(void);
658 * Run Elementary's main loop
660 * This call should be issued just after all initialization is
661 * completed. This function will not return until elm_exit() is
662 * called. It will keep looping, running the main
663 * (event/processing) loop for Elementary.
665 * @see elm_init() for an example
669 EAPI void elm_run(void);
672 * Exit Elementary's main loop
674 * If this call is issued, it will flag the main loop to cease
675 * processing and return back to its parent function (usually your
676 * elm_main() function).
678 * @see elm_init() for an example. There, just after a request to
679 * close the window comes, the main loop will be left.
681 * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
682 * applications, you'll be able to get this function called automatically for you.
686 EAPI void elm_exit(void);
689 * Provide information in order to make Elementary determine the @b
690 * run time location of the software in question, so other data files
691 * such as images, sound files, executable utilities, libraries,
692 * modules and locale files can be found.
694 * @param mainfunc This is your application's main function name,
695 * whose binary's location is to be found. Providing @c NULL
696 * will make Elementary not to use it
697 * @param dom This will be used as the application's "domain", in the
698 * form of a prefix to any environment variables that may
699 * override prefix detection and the directory name, inside the
700 * standard share or data directories, where the software's
701 * data files will be looked for.
702 * @param checkfile This is an (optional) magic file's path to check
703 * for existence (and it must be located in the data directory,
704 * under the share directory provided above). Its presence will
705 * help determine the prefix found was correct. Pass @c NULL if
706 * the check is not to be done.
708 * This function allows one to re-locate the application somewhere
709 * else after compilation, if the developer wishes for easier
710 * distribution of pre-compiled binaries.
712 * The prefix system is designed to locate where the given software is
713 * installed (under a common path prefix) at run time and then report
714 * specific locations of this prefix and common directories inside
715 * this prefix like the binary, library, data and locale directories,
716 * through the @c elm_app_*_get() family of functions.
718 * Call elm_app_info_set() early on before you change working
719 * directory or anything about @c argv[0], so it gets accurate
722 * It will then try and trace back which file @p mainfunc comes from,
723 * if provided, to determine the application's prefix directory.
725 * The @p dom parameter provides a string prefix to prepend before
726 * environment variables, allowing a fallback to @b specific
727 * environment variables to locate the software. You would most
728 * probably provide a lowercase string there, because it will also
729 * serve as directory domain, explained next. For environment
730 * variables purposes, this string is made uppercase. For example if
731 * @c "myapp" is provided as the prefix, then the program would expect
732 * @c "MYAPP_PREFIX" as a master environment variable to specify the
733 * exact install prefix for the software, or more specific environment
734 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
735 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
736 * the user or scripts before launching. If not provided (@c NULL),
737 * environment variables will not be used to override compiled-in
738 * defaults or auto detections.
740 * The @p dom string also provides a subdirectory inside the system
741 * shared data directory for data files. For example, if the system
742 * directory is @c /usr/local/share, then this directory name is
743 * appended, creating @c /usr/local/share/myapp, if it @p was @c
744 * "myapp". It is expected that the application installs data files in
747 * The @p checkfile is a file name or path of something inside the
748 * share or data directory to be used to test that the prefix
749 * detection worked. For example, your app will install a wallpaper
750 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
751 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
754 * @see elm_app_compile_bin_dir_set()
755 * @see elm_app_compile_lib_dir_set()
756 * @see elm_app_compile_data_dir_set()
757 * @see elm_app_compile_locale_set()
758 * @see elm_app_prefix_dir_get()
759 * @see elm_app_bin_dir_get()
760 * @see elm_app_lib_dir_get()
761 * @see elm_app_data_dir_get()
762 * @see elm_app_locale_dir_get()
764 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
767 * Provide information on the @b fallback application's binaries
768 * directory, in scenarios where they get overriden by
769 * elm_app_info_set().
771 * @param dir The path to the default binaries directory (compile time
774 * @note Elementary will as well use this path to determine actual
775 * names of binaries' directory paths, maybe changing it to be @c
776 * something/local/bin instead of @c something/bin, only, for
779 * @warning You should call this function @b before
780 * elm_app_info_set().
782 EAPI void elm_app_compile_bin_dir_set(const char *dir);
785 * Provide information on the @b fallback application's libraries
786 * directory, on scenarios where they get overriden by
787 * elm_app_info_set().
789 * @param dir The path to the default libraries directory (compile
792 * @note Elementary will as well use this path to determine actual
793 * names of libraries' directory paths, maybe changing it to be @c
794 * something/lib32 or @c something/lib64 instead of @c something/lib,
797 * @warning You should call this function @b before
798 * elm_app_info_set().
800 EAPI void elm_app_compile_lib_dir_set(const char *dir);
803 * Provide information on the @b fallback application's data
804 * directory, on scenarios where they get overriden by
805 * elm_app_info_set().
807 * @param dir The path to the default data directory (compile time
810 * @note Elementary will as well use this path to determine actual
811 * names of data directory paths, maybe changing it to be @c
812 * something/local/share instead of @c something/share, only, for
815 * @warning You should call this function @b before
816 * elm_app_info_set().
818 EAPI void elm_app_compile_data_dir_set(const char *dir);
821 * Provide information on the @b fallback application's locale
822 * directory, on scenarios where they get overriden by
823 * elm_app_info_set().
825 * @param dir The path to the default locale directory (compile time
828 * @warning You should call this function @b before
829 * elm_app_info_set().
831 EAPI void elm_app_compile_locale_set(const char *dir);
834 * Retrieve the application's run time prefix directory, as set by
835 * elm_app_info_set() and the way (environment) the application was
838 * @return The directory prefix the application is actually using.
840 EAPI const char *elm_app_prefix_dir_get(void);
843 * Retrieve the application's run time binaries prefix directory, as
844 * set by elm_app_info_set() and the way (environment) the application
847 * @return The binaries directory prefix the application is actually
850 EAPI const char *elm_app_bin_dir_get(void);
853 * Retrieve the application's run time libraries prefix directory, as
854 * set by elm_app_info_set() and the way (environment) the application
857 * @return The libraries directory prefix the application is actually
860 EAPI const char *elm_app_lib_dir_get(void);
863 * Retrieve the application's run time data prefix directory, as
864 * set by elm_app_info_set() and the way (environment) the application
867 * @return The data directory prefix the application is actually
870 EAPI const char *elm_app_data_dir_get(void);
873 * Retrieve the application's run time locale prefix directory, as
874 * set by elm_app_info_set() and the way (environment) the application
877 * @return The locale directory prefix the application is actually
880 EAPI const char *elm_app_locale_dir_get(void);
882 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
883 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
884 EAPI int elm_quicklaunch_init(int argc, char **argv);
885 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
886 EAPI int elm_quicklaunch_sub_shutdown(void);
887 EAPI int elm_quicklaunch_shutdown(void);
888 EAPI void elm_quicklaunch_seed(void);
889 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
890 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
891 EAPI void elm_quicklaunch_cleanup(void);
892 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
893 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
895 EAPI Eina_Bool elm_need_efreet(void);
896 EAPI Eina_Bool elm_need_e_dbus(void);
899 * This must be called before any other function that deals with
900 * elm_thumb objects or ethumb_client instances.
904 EAPI Eina_Bool elm_need_ethumb(void);
907 * This must be called before any other function that deals with
908 * elm_web objects or ewk_view instances.
912 EAPI Eina_Bool elm_need_web(void);
915 * Set a new policy's value (for a given policy group/identifier).
917 * @param policy policy identifier, as in @ref Elm_Policy.
918 * @param value policy value, which depends on the identifier
920 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
922 * Elementary policies define applications' behavior,
923 * somehow. These behaviors are divided in policy groups (see
924 * #Elm_Policy enumeration). This call will emit the Ecore event
925 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
926 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
929 * @note Currently, we have only one policy identifier/group
930 * (#ELM_POLICY_QUIT), which has two possible values.
934 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
937 * Gets the policy value for given policy identifier.
939 * @param policy policy identifier, as in #Elm_Policy.
940 * @return The currently set policy value, for that
941 * identifier. Will be @c 0 if @p policy passed is invalid.
945 EAPI int elm_policy_get(unsigned int policy);
948 * Change the language of the current application
950 * The @p lang passed must be the full name of the locale to use, for
951 * example "en_US.utf8" or "es_ES@euro".
953 * Changing language with this function will make Elementary run through
954 * all its widgets, translating strings set with
955 * elm_object_domain_translatable_text_part_set(). This way, an entire
956 * UI can have its language changed without having to restart the program.
958 * For more complex cases, like having formatted strings that need
959 * translation, widgets will also emit a "language,changed" signal that
960 * the user can listen to to manually translate the text.
962 * @param lang Language to set, must be the full name of the locale
966 EAPI void elm_language_set(const char *lang);
969 * Set a label of an object
971 * @param obj The Elementary object
972 * @param part The text part name to set (NULL for the default label)
973 * @param label The new text of the label
975 * @note Elementary objects may have many labels (e.g. Action Slider)
979 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
981 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
984 * Get a label of an object
986 * @param obj The Elementary object
987 * @param part The text part name to get (NULL for the default label)
988 * @return text of the label or NULL for any error
990 * @note Elementary objects may have many labels (e.g. Action Slider)
994 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
996 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
999 * Set the text for an objects' part, marking it as translatable.
1001 * The string to set as @p text must be the original one. Do not pass the
1002 * return of @c gettext() here. Elementary will translate the string
1003 * internally and set it on the object using elm_object_text_part_set(),
1004 * also storing the original string so that it can be automatically
1005 * translated when the language is changed with elm_language_set().
1007 * The @p domain will be stored along to find the translation in the
1008 * correct catalog. It can be NULL, in which case it will use whatever
1009 * domain was set by the application with @c textdomain(). This is useful
1010 * in case you are building a library on top of Elementary that will have
1011 * its own translatable strings, that should not be mixed with those of
1012 * programs using the library.
1014 * @param obj The object containing the text part
1015 * @param part The name of the part to set
1016 * @param domain The translation domain to use
1017 * @param text The original, non-translated text to set
1021 EAPI void elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1023 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1025 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1028 * Gets the original string set as translatable for an object
1030 * When setting translated strings, the function elm_object_text_part_get()
1031 * will return the translation returned by @c gettext(). To get the
1032 * original string use this function.
1034 * @param obj The object
1035 * @param part The name of the part that was set
1037 * @return The original, untranslated string
1041 EAPI const char *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1043 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1046 * Set a content of an object
1048 * @param obj The Elementary object
1049 * @param part The content part name to set (NULL for the default content)
1050 * @param content The new content of the object
1052 * @note Elementary objects may have many contents
1056 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1058 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
1061 * Get a content of an object
1063 * @param obj The Elementary object
1064 * @param item The content part name to get (NULL for the default content)
1065 * @return content of the object or NULL for any error
1067 * @note Elementary objects may have many contents
1071 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1073 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
1076 * Unset a content of an object
1078 * @param obj The Elementary object
1079 * @param item The content part name to unset (NULL for the default content)
1081 * @note Elementary objects may have many contents
1085 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1087 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1090 * Get the widget object's handle which contains a given item
1092 * @param item The Elementary object item
1093 * @return The widget object
1095 * @note This returns the widget object itself that an item belongs to.
1099 EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1102 * Set a content of an object item
1104 * @param it The Elementary object item
1105 * @param part The content part name to set (NULL for the default content)
1106 * @param content The new content of the object item
1108 * @note Elementary object items may have many contents
1112 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1114 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1117 * Get a content of an object item
1119 * @param it The Elementary object item
1120 * @param part The content part name to unset (NULL for the default content)
1121 * @return content of the object item or NULL for any error
1123 * @note Elementary object items may have many contents
1127 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1129 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1132 * Unset a content of an object item
1134 * @param it The Elementary object item
1135 * @param part The content part name to unset (NULL for the default content)
1137 * @note Elementary object items may have many contents
1141 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1143 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1146 * Set a label of an object item
1148 * @param it The Elementary object item
1149 * @param part The text part name to set (NULL for the default label)
1150 * @param label The new text of the label
1152 * @note Elementary object items may have many labels
1156 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1158 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1161 * Get a label of an object item
1163 * @param it The Elementary object item
1164 * @param part The text part name to get (NULL for the default label)
1165 * @return text of the label or NULL for any error
1167 * @note Elementary object items may have many labels
1171 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1173 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1176 * Set the text to read out when in accessibility mode
1178 * @param obj The object which is to be described
1179 * @param txt The text that describes the widget to people with poor or no vision
1183 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1186 * Set the text to read out when in accessibility mode
1188 * @param it The object item which is to be described
1189 * @param txt The text that describes the widget to people with poor or no vision
1193 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1196 * Get the data associated with an object item
1197 * @param it The object item
1198 * @return The data associated with @p it
1202 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1205 * Set the data associated with an object item
1206 * @param it The object item
1207 * @param data The data to be associated with @p it
1211 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1214 * Send a signal to the edje object of the widget item.
1216 * This function sends a signal to the edje object of the obj item. An
1217 * edje program can respond to a signal by specifying matching
1218 * 'signal' and 'source' fields.
1220 * @param it The Elementary object item
1221 * @param emission The signal's name.
1222 * @param source The signal's source.
1225 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1232 * @defgroup Caches Caches
1234 * These are functions which let one fine-tune some cache values for
1235 * Elementary applications, thus allowing for performance adjustments.
1241 * @brief Flush all caches.
1243 * Frees all data that was in cache and is not currently being used to reduce
1244 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1245 * to calling all of the following functions:
1246 * @li edje_file_cache_flush()
1247 * @li edje_collection_cache_flush()
1248 * @li eet_clearcache()
1249 * @li evas_image_cache_flush()
1250 * @li evas_font_cache_flush()
1251 * @li evas_render_dump()
1252 * @note Evas caches are flushed for every canvas associated with a window.
1256 EAPI void elm_all_flush(void);
1259 * Get the configured cache flush interval time
1261 * This gets the globally configured cache flush interval time, in
1264 * @return The cache flush interval time
1267 * @see elm_all_flush()
1269 EAPI int elm_cache_flush_interval_get(void);
1272 * Set the configured cache flush interval time
1274 * This sets the globally configured cache flush interval time, in ticks
1276 * @param size The cache flush interval time
1279 * @see elm_all_flush()
1281 EAPI void elm_cache_flush_interval_set(int size);
1284 * Set the configured cache flush interval time for all applications on the
1287 * This sets the globally configured cache flush interval time -- in ticks
1288 * -- for all applications on the display.
1290 * @param size The cache flush interval time
1293 EAPI void elm_cache_flush_interval_all_set(int size);
1296 * Get the configured cache flush enabled state
1298 * This gets the globally configured cache flush state - if it is enabled
1299 * or not. When cache flushing is enabled, elementary will regularly
1300 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1301 * memory and allow usage to re-seed caches and data in memory where it
1302 * can do so. An idle application will thus minimise its memory usage as
1303 * data will be freed from memory and not be re-loaded as it is idle and
1304 * not rendering or doing anything graphically right now.
1306 * @return The cache flush state
1309 * @see elm_all_flush()
1311 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1314 * Set the configured cache flush enabled state
1316 * This sets the globally configured cache flush enabled state.
1318 * @param size The cache flush enabled state
1321 * @see elm_all_flush()
1323 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1326 * Set the configured cache flush enabled state for all applications on the
1329 * This sets the globally configured cache flush enabled state for all
1330 * applications on the display.
1332 * @param size The cache flush enabled state
1335 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1338 * Get the configured font cache size
1340 * This gets the globally configured font cache size, in bytes.
1342 * @return The font cache size
1345 EAPI int elm_font_cache_get(void);
1348 * Set the configured font cache size
1350 * This sets the globally configured font cache size, in bytes
1352 * @param size The font cache size
1355 EAPI void elm_font_cache_set(int size);
1358 * Set the configured font cache size for all applications on the
1361 * This sets the globally configured font cache size -- in bytes
1362 * -- for all applications on the display.
1364 * @param size The font cache size
1367 EAPI void elm_font_cache_all_set(int size);
1370 * Get the configured image cache size
1372 * This gets the globally configured image cache size, in bytes
1374 * @return The image cache size
1377 EAPI int elm_image_cache_get(void);
1380 * Set the configured image cache size
1382 * This sets the globally configured image cache size, in bytes
1384 * @param size The image cache size
1387 EAPI void elm_image_cache_set(int size);
1390 * Set the configured image cache size for all applications on the
1393 * This sets the globally configured image cache size -- in bytes
1394 * -- for all applications on the display.
1396 * @param size The image cache size
1399 EAPI void elm_image_cache_all_set(int size);
1402 * Get the configured edje file cache size.
1404 * This gets the globally configured edje file cache size, in number
1407 * @return The edje file cache size
1410 EAPI int elm_edje_file_cache_get(void);
1413 * Set the configured edje file cache size
1415 * This sets the globally configured edje file cache size, in number
1418 * @param size The edje file cache size
1421 EAPI void elm_edje_file_cache_set(int size);
1424 * Set the configured edje file cache size for all applications on the
1427 * This sets the globally configured edje file cache size -- in number
1428 * of files -- for all applications on the display.
1430 * @param size The edje file cache size
1433 EAPI void elm_edje_file_cache_all_set(int size);
1436 * Get the configured edje collections (groups) cache size.
1438 * This gets the globally configured edje collections cache size, in
1439 * number of collections.
1441 * @return The edje collections cache size
1444 EAPI int elm_edje_collection_cache_get(void);
1447 * Set the configured edje collections (groups) cache size
1449 * This sets the globally configured edje collections cache size, in
1450 * number of collections.
1452 * @param size The edje collections cache size
1455 EAPI void elm_edje_collection_cache_set(int size);
1458 * Set the configured edje collections (groups) cache size for all
1459 * applications on the display
1461 * This sets the globally configured edje collections cache size -- in
1462 * number of collections -- for all applications on the display.
1464 * @param size The edje collections cache size
1467 EAPI void elm_edje_collection_cache_all_set(int size);
1474 * @defgroup Scaling Widget Scaling
1476 * Different widgets can be scaled independently. These functions
1477 * allow you to manipulate this scaling on a per-widget basis. The
1478 * object and all its children get their scaling factors multiplied
1479 * by the scale factor set. This is multiplicative, in that if a
1480 * child also has a scale size set it is in turn multiplied by its
1481 * parent's scale size. @c 1.0 means ādon't scaleā, @c 2.0 is
1482 * double size, @c 0.5 is half, etc.
1484 * @ref general_functions_example_page "This" example contemplates
1485 * some of these functions.
1489 * Get the global scaling factor
1491 * This gets the globally configured scaling factor that is applied to all
1494 * @return The scaling factor
1497 EAPI double elm_scale_get(void);
1500 * Set the global scaling factor
1502 * This sets the globally configured scaling factor that is applied to all
1505 * @param scale The scaling factor to set
1508 EAPI void elm_scale_set(double scale);
1511 * Set the global scaling factor for all applications on the display
1513 * This sets the globally configured scaling factor that is applied to all
1514 * objects for all applications.
1515 * @param scale The scaling factor to set
1518 EAPI void elm_scale_all_set(double scale);
1521 * Set the scaling factor for a given Elementary object
1523 * @param obj The Elementary to operate on
1524 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1529 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1532 * Get the scaling factor for a given Elementary object
1534 * @param obj The object
1535 * @return The scaling factor set by elm_object_scale_set()
1539 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1542 * @defgroup Password_last_show Password last input show
1544 * Last show feature of password mode enables user to view
1545 * the last input entered for few seconds before masking it.
1546 * These functions allow to set this feature in password mode
1547 * of entry widget and also allow to manipulate the duration
1548 * for which the input has to be visible.
1554 * Get show last setting of password mode.
1556 * This gets the show last input setting of password mode which might be
1557 * enabled or disabled.
1559 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1561 * @ingroup Password_last_show
1563 EAPI Eina_Bool elm_password_show_last_get(void);
1566 * Set show last setting in password mode.
1568 * This enables or disables show last setting of password mode.
1570 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1571 * @see elm_password_show_last_timeout_set()
1572 * @ingroup Password_last_show
1574 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1577 * Get's the timeout value in last show password mode.
1579 * This gets the time out value for which the last input entered in password
1580 * mode will be visible.
1582 * @return The timeout value of last show password mode.
1583 * @ingroup Password_last_show
1585 EAPI double elm_password_show_last_timeout_get(void);
1588 * Set's the timeout value in last show password mode.
1590 * This sets the time out value for which the last input entered in password
1591 * mode will be visible.
1593 * @param password_show_last_timeout The timeout value.
1594 * @see elm_password_show_last_set()
1595 * @ingroup Password_last_show
1597 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1604 * @defgroup UI-Mirroring Selective Widget mirroring
1606 * These functions allow you to set ui-mirroring on specific
1607 * widgets or the whole interface. Widgets can be in one of two
1608 * modes, automatic and manual. Automatic means they'll be changed
1609 * according to the system mirroring mode and manual means only
1610 * explicit changes will matter. You are not supposed to change
1611 * mirroring state of a widget set to automatic, will mostly work,
1612 * but the behavior is not really defined.
1617 EAPI Eina_Bool elm_mirrored_get(void);
1618 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1621 * Get the system mirrored mode. This determines the default mirrored mode
1624 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1626 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1629 * Set the system mirrored mode. This determines the default mirrored mode
1632 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1634 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1637 * Returns the widget's mirrored mode setting.
1639 * @param obj The widget.
1640 * @return mirrored mode setting of the object.
1643 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1646 * Sets the widget's mirrored mode setting.
1647 * When widget in automatic mode, it follows the system mirrored mode set by
1648 * elm_mirrored_set().
1649 * @param obj The widget.
1650 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1652 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1659 * Set the style to use by a widget
1661 * Sets the style name that will define the appearance of a widget. Styles
1662 * vary from widget to widget and may also be defined by other themes
1663 * by means of extensions and overlays.
1665 * @param obj The Elementary widget to style
1666 * @param style The style name to use
1668 * @see elm_theme_extension_add()
1669 * @see elm_theme_extension_del()
1670 * @see elm_theme_overlay_add()
1671 * @see elm_theme_overlay_del()
1675 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1677 * Get the style used by the widget
1679 * This gets the style being used for that widget. Note that the string
1680 * pointer is only valid as longas the object is valid and the style doesn't
1683 * @param obj The Elementary widget to query for its style
1684 * @return The style name used
1686 * @see elm_object_style_set()
1690 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1693 * @defgroup Styles Styles
1695 * Widgets can have different styles of look. These generic API's
1696 * set styles of widgets, if they support them (and if the theme(s)
1699 * @ref general_functions_example_page "This" example contemplates
1700 * some of these functions.
1704 * Set the disabled state of an Elementary object.
1706 * @param obj The Elementary object to operate on
1707 * @param disabled The state to put in in: @c EINA_TRUE for
1708 * disabled, @c EINA_FALSE for enabled
1710 * Elementary objects can be @b disabled, in which state they won't
1711 * receive input and, in general, will be themed differently from
1712 * their normal state, usually greyed out. Useful for contexts
1713 * where you don't want your users to interact with some of the
1714 * parts of you interface.
1716 * This sets the state for the widget, either disabling it or
1721 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1724 * Get the disabled state of an Elementary object.
1726 * @param obj The Elementary object to operate on
1727 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1728 * if it's enabled (or on errors)
1730 * This gets the state of the widget, which might be enabled or disabled.
1734 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1737 * @defgroup WidgetNavigation Widget Tree Navigation.
1739 * How to check if an Evas Object is an Elementary widget? How to
1740 * get the first elementary widget that is parent of the given
1741 * object? These are all covered in widget tree navigation.
1743 * @ref general_functions_example_page "This" example contemplates
1744 * some of these functions.
1748 * Check if the given Evas Object is an Elementary widget.
1750 * @param obj the object to query.
1751 * @return @c EINA_TRUE if it is an elementary widget variant,
1752 * @c EINA_FALSE otherwise
1753 * @ingroup WidgetNavigation
1755 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1758 * Get the first parent of the given object that is an Elementary
1761 * @param obj the Elementary object to query parent from.
1762 * @return the parent object that is an Elementary widget, or @c
1763 * NULL, if it was not found.
1765 * Use this to query for an object's parent widget.
1767 * @note Most of Elementary users wouldn't be mixing non-Elementary
1768 * smart objects in the objects tree of an application, as this is
1769 * an advanced usage of Elementary with Evas. So, except for the
1770 * application's window, which is the root of that tree, all other
1771 * objects would have valid Elementary widget parents.
1773 * @ingroup WidgetNavigation
1775 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1778 * Get the top level parent of an Elementary widget.
1780 * @param obj The object to query.
1781 * @return The top level Elementary widget, or @c NULL if parent cannot be
1783 * @ingroup WidgetNavigation
1785 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1788 * Get the string that represents this Elementary widget.
1790 * @note Elementary is weird and exposes itself as a single
1791 * Evas_Object_Smart_Class of type "elm_widget", so
1792 * evas_object_type_get() always return that, making debug and
1793 * language bindings hard. This function tries to mitigate this
1794 * problem, but the solution is to change Elementary to use
1795 * proper inheritance.
1797 * @param obj the object to query.
1798 * @return Elementary widget name, or @c NULL if not a valid widget.
1799 * @ingroup WidgetNavigation
1801 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1804 * @defgroup Config Elementary Config
1806 * Elementary configuration is formed by a set options bounded to a
1807 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1808 * "finger size", etc. These are functions with which one syncronizes
1809 * changes made to those values to the configuration storing files, de
1810 * facto. You most probably don't want to use the functions in this
1811 * group unlees you're writing an elementary configuration manager.
1817 * Save back Elementary's configuration, so that it will persist on
1820 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1823 * This function will take effect -- thus, do I/O -- immediately. Use
1824 * it when you want to apply all configuration changes at once. The
1825 * current configuration set will get saved onto the current profile
1826 * configuration file.
1829 EAPI Eina_Bool elm_config_save(void);
1832 * Reload Elementary's configuration, bounded to current selected
1835 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1838 * Useful when you want to force reloading of configuration values for
1839 * a profile. If one removes user custom configuration directories,
1840 * for example, it will force a reload with system values insted.
1843 EAPI void elm_config_reload(void);
1850 * @defgroup Profile Elementary Profile
1852 * Profiles are pre-set options that affect the whole look-and-feel of
1853 * Elementary-based applications. There are, for example, profiles
1854 * aimed at desktop computer applications and others aimed at mobile,
1855 * touchscreen-based ones. You most probably don't want to use the
1856 * functions in this group unlees you're writing an elementary
1857 * configuration manager.
1863 * Get Elementary's profile in use.
1865 * This gets the global profile that is applied to all Elementary
1868 * @return The profile's name
1871 EAPI const char *elm_profile_current_get(void);
1874 * Get an Elementary's profile directory path in the filesystem. One
1875 * may want to fetch a system profile's dir or an user one (fetched
1878 * @param profile The profile's name
1879 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1880 * or a system one (@c EINA_FALSE)
1881 * @return The profile's directory path.
1884 * @note You must free it with elm_profile_dir_free().
1886 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1889 * Free an Elementary's profile directory path, as returned by
1890 * elm_profile_dir_get().
1892 * @param p_dir The profile's path
1896 EAPI void elm_profile_dir_free(const char *p_dir);
1899 * Get Elementary's list of available profiles.
1901 * @return The profiles list. List node data are the profile name
1905 * @note One must free this list, after usage, with the function
1906 * elm_profile_list_free().
1908 EAPI Eina_List *elm_profile_list_get(void);
1911 * Free Elementary's list of available profiles.
1913 * @param l The profiles list, as returned by elm_profile_list_get().
1917 EAPI void elm_profile_list_free(Eina_List *l);
1920 * Set Elementary's profile.
1922 * This sets the global profile that is applied to Elementary
1923 * applications. Just the process the call comes from will be
1926 * @param profile The profile's name
1930 EAPI void elm_profile_set(const char *profile);
1933 * Set Elementary's profile.
1935 * This sets the global profile that is applied to all Elementary
1936 * applications. All running Elementary windows will be affected.
1938 * @param profile The profile's name
1942 EAPI void elm_profile_all_set(const char *profile);
1949 * @defgroup Engine Elementary Engine
1951 * These are functions setting and querying which rendering engine
1952 * Elementary will use for drawing its windows' pixels.
1954 * The following are the available engines:
1955 * @li "software_x11"
1958 * @li "software_16_x11"
1959 * @li "software_8_x11"
1962 * @li "software_gdi"
1963 * @li "software_16_wince_gdi"
1965 * @li "software_16_sdl"
1969 * @li "opengl_cocoa"
1976 * @brief Get Elementary's rendering engine in use.
1978 * @return The rendering engine's name
1979 * @note there's no need to free the returned string, here.
1981 * This gets the global rendering engine that is applied to all Elementary
1984 * @see elm_engine_set()
1986 EAPI const char *elm_engine_current_get(void);
1989 * @brief Set Elementary's rendering engine for use.
1991 * @param engine The rendering engine's name
1993 * This sets global rendering engine that is applied to all Elementary
1994 * applications. Note that it will take effect only to Elementary windows
1995 * created after this is called.
1997 * @see elm_win_add()
1999 EAPI void elm_engine_set(const char *engine);
2006 * @defgroup Fonts Elementary Fonts
2008 * These are functions dealing with font rendering, selection and the
2009 * like for Elementary applications. One might fetch which system
2010 * fonts are there to use and set custom fonts for individual classes
2011 * of UI items containing text (text classes).
2016 typedef struct _Elm_Text_Class
2022 typedef struct _Elm_Font_Overlay
2024 const char *text_class;
2026 Evas_Font_Size size;
2029 typedef struct _Elm_Font_Properties
2033 } Elm_Font_Properties;
2036 * Get Elementary's list of supported text classes.
2038 * @return The text classes list, with @c Elm_Text_Class blobs as data.
2041 * Release the list with elm_text_classes_list_free().
2043 EAPI const Eina_List *elm_text_classes_list_get(void);
2046 * Free Elementary's list of supported text classes.
2050 * @see elm_text_classes_list_get().
2052 EAPI void elm_text_classes_list_free(const Eina_List *list);
2055 * Get Elementary's list of font overlays, set with
2056 * elm_font_overlay_set().
2058 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2063 * For each text class, one can set a <b>font overlay</b> for it,
2064 * overriding the default font properties for that class coming from
2065 * the theme in use. There is no need to free this list.
2067 * @see elm_font_overlay_set() and elm_font_overlay_unset().
2069 EAPI const Eina_List *elm_font_overlay_list_get(void);
2072 * Set a font overlay for a given Elementary text class.
2074 * @param text_class Text class name
2075 * @param font Font name and style string
2076 * @param size Font size
2080 * @p font has to be in the format returned by
2081 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2082 * and elm_font_overlay_unset().
2084 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2087 * Unset a font overlay for a given Elementary text class.
2089 * @param text_class Text class name
2093 * This will bring back text elements belonging to text class
2094 * @p text_class back to their default font settings.
2096 EAPI void elm_font_overlay_unset(const char *text_class);
2099 * Apply the changes made with elm_font_overlay_set() and
2100 * elm_font_overlay_unset() on the current Elementary window.
2104 * This applies all font overlays set to all objects in the UI.
2106 EAPI void elm_font_overlay_apply(void);
2109 * Apply the changes made with elm_font_overlay_set() and
2110 * elm_font_overlay_unset() on all Elementary application windows.
2114 * This applies all font overlays set to all objects in the UI.
2116 EAPI void elm_font_overlay_all_apply(void);
2119 * Translate a font (family) name string in fontconfig's font names
2120 * syntax into an @c Elm_Font_Properties struct.
2122 * @param font The font name and styles string
2123 * @return the font properties struct
2127 * @note The reverse translation can be achived with
2128 * elm_font_fontconfig_name_get(), for one style only (single font
2129 * instance, not family).
2131 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2134 * Free font properties return by elm_font_properties_get().
2136 * @param efp the font properties struct
2140 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2143 * Translate a font name, bound to a style, into fontconfig's font names
2146 * @param name The font (family) name
2147 * @param style The given style (may be @c NULL)
2149 * @return the font name and style string
2153 * @note The reverse translation can be achived with
2154 * elm_font_properties_get(), for one style only (single font
2155 * instance, not family).
2157 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2160 * Free the font string return by elm_font_fontconfig_name_get().
2162 * @param efp the font properties struct
2166 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2169 * Create a font hash table of available system fonts.
2171 * One must call it with @p list being the return value of
2172 * evas_font_available_list(). The hash will be indexed by font
2173 * (family) names, being its values @c Elm_Font_Properties blobs.
2175 * @param list The list of available system fonts, as returned by
2176 * evas_font_available_list().
2177 * @return the font hash.
2181 * @note The user is supposed to get it populated at least with 3
2182 * default font families (Sans, Serif, Monospace), which should be
2183 * present on most systems.
2185 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2188 * Free the hash return by elm_font_available_hash_add().
2190 * @param hash the hash to be freed.
2194 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2201 * @defgroup Fingers Fingers
2203 * Elementary is designed to be finger-friendly for touchscreens,
2204 * and so in addition to scaling for display resolution, it can
2205 * also scale based on finger "resolution" (or size). You can then
2206 * customize the granularity of the areas meant to receive clicks
2209 * Different profiles may have pre-set values for finger sizes.
2211 * @ref general_functions_example_page "This" example contemplates
2212 * some of these functions.
2218 * Get the configured "finger size"
2220 * @return The finger size
2222 * This gets the globally configured finger size, <b>in pixels</b>
2226 EAPI Evas_Coord elm_finger_size_get(void);
2229 * Set the configured finger size
2231 * This sets the globally configured finger size in pixels
2233 * @param size The finger size
2236 EAPI void elm_finger_size_set(Evas_Coord size);
2239 * Set the configured finger size for all applications on the display
2241 * This sets the globally configured finger size in pixels for all
2242 * applications on the display
2244 * @param size The finger size
2247 EAPI void elm_finger_size_all_set(Evas_Coord size);
2254 * @defgroup Focus Focus
2256 * An Elementary application has, at all times, one (and only one)
2257 * @b focused object. This is what determines where the input
2258 * events go to within the application's window. Also, focused
2259 * objects can be decorated differently, in order to signal to the
2260 * user where the input is, at a given moment.
2262 * Elementary applications also have the concept of <b>focus
2263 * chain</b>: one can cycle through all the windows' focusable
2264 * objects by input (tab key) or programmatically. The default
2265 * focus chain for an application is the one define by the order in
2266 * which the widgets where added in code. One will cycle through
2267 * top level widgets, and, for each one containg sub-objects, cycle
2268 * through them all, before returning to the level
2269 * above. Elementary also allows one to set @b custom focus chains
2270 * for their applications.
2272 * Besides the focused decoration a widget may exhibit, when it
2273 * gets focus, Elementary has a @b global focus highlight object
2274 * that can be enabled for a window. If one chooses to do so, this
2275 * extra highlight effect will surround the current focused object,
2278 * @note Some Elementary widgets are @b unfocusable, after
2279 * creation, by their very nature: they are not meant to be
2280 * interacted with input events, but are there just for visual
2283 * @ref general_functions_example_page "This" example contemplates
2284 * some of these functions.
2288 * Get the enable status of the focus highlight
2290 * This gets whether the highlight on focused objects is enabled or not
2293 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2296 * Set the enable status of the focus highlight
2298 * Set whether to show or not the highlight on focused objects
2299 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2302 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2305 * Get the enable status of the highlight animation
2307 * Get whether the focus highlight, if enabled, will animate its switch from
2308 * one object to the next
2311 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2314 * Set the enable status of the highlight animation
2316 * Set whether the focus highlight, if enabled, will animate its switch from
2317 * one object to the next
2318 * @param animate Enable animation if EINA_TRUE, disable otherwise
2321 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2324 * Get the whether an Elementary object has the focus or not.
2326 * @param obj The Elementary object to get the information from
2327 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2328 * not (and on errors).
2330 * @see elm_object_focus_set()
2334 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2337 * Set/unset focus to a given Elementary object.
2339 * @param obj The Elementary object to operate on.
2340 * @param enable @c EINA_TRUE Set focus to a given object,
2341 * @c EINA_FALSE Unset focus to a given object.
2343 * @note When you set focus to this object, if it can handle focus, will
2344 * take the focus away from the one who had it previously and will, for
2345 * now on, be the one receiving input events. Unsetting focus will remove
2346 * the focus from @p obj, passing it back to the previous element in the
2349 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2353 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2356 * Make a given Elementary object the focused one.
2358 * @param obj The Elementary object to make focused.
2360 * @note This object, if it can handle focus, will take the focus
2361 * away from the one who had it previously and will, for now on, be
2362 * the one receiving input events.
2364 * @see elm_object_focus_get()
2368 EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2371 * Remove the focus from an Elementary object
2373 * @param obj The Elementary to take focus from
2375 * This removes the focus from @p obj, passing it back to the
2376 * previous element in the focus chain list.
2378 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2382 EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2385 * Set the ability for an Element object to be focused
2387 * @param obj The Elementary object to operate on
2388 * @param enable @c EINA_TRUE if the object can be focused, @c
2389 * EINA_FALSE if not (and on errors)
2391 * This sets whether the object @p obj is able to take focus or
2392 * not. Unfocusable objects do nothing when programmatically
2393 * focused, being the nearest focusable parent object the one
2394 * really getting focus. Also, when they receive mouse input, they
2395 * will get the event, but not take away the focus from where it
2400 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2403 * Get whether an Elementary object is focusable or not
2405 * @param obj The Elementary object to operate on
2406 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2407 * EINA_FALSE if not (and on errors)
2409 * @note Objects which are meant to be interacted with by input
2410 * events are created able to be focused, by default. All the
2415 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2418 * Set custom focus chain.
2420 * This function overwrites any previous custom focus chain within
2421 * the list of objects. The previous list will be deleted and this list
2422 * will be managed by elementary. After it is set, don't modify it.
2424 * @note On focus cycle, only will be evaluated children of this container.
2426 * @param obj The container object
2427 * @param objs Chain of objects to pass focus
2430 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2433 * Unset a custom focus chain on a given Elementary widget
2435 * @param obj The container object to remove focus chain from
2437 * Any focus chain previously set on @p obj (for its child objects)
2438 * is removed entirely after this call.
2442 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2445 * Get custom focus chain
2447 * @param obj The container object
2450 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2453 * Append object to custom focus chain.
2455 * @note If relative_child equal to NULL or not in custom chain, the object
2456 * will be added in end.
2458 * @note On focus cycle, only will be evaluated children of this container.
2460 * @param obj The container object
2461 * @param child The child to be added in custom chain
2462 * @param relative_child The relative object to position the child
2465 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2468 * Prepend object to custom focus chain.
2470 * @note If relative_child equal to NULL or not in custom chain, the object
2471 * will be added in begin.
2473 * @note On focus cycle, only will be evaluated children of this container.
2475 * @param obj The container object
2476 * @param child The child to be added in custom chain
2477 * @param relative_child The relative object to position the child
2480 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2483 * Give focus to next object in object tree.
2485 * Give focus to next object in focus chain of one object sub-tree.
2486 * If the last object of chain already have focus, the focus will go to the
2487 * first object of chain.
2489 * @param obj The object root of sub-tree
2490 * @param dir Direction to cycle the focus
2494 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2497 * Give focus to near object in one direction.
2499 * Give focus to near object in direction of one object.
2500 * If none focusable object in given direction, the focus will not change.
2502 * @param obj The reference object
2503 * @param x Horizontal component of direction to focus
2504 * @param y Vertical component of direction to focus
2508 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2511 * Make the elementary object and its children to be unfocusable
2514 * @param obj The Elementary object to operate on
2515 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2516 * @c EINA_FALSE for focusable.
2518 * This sets whether the object @p obj and its children objects
2519 * are able to take focus or not. If the tree is set as unfocusable,
2520 * newest focused object which is not in this tree will get focus.
2521 * This API can be helpful for an object to be deleted.
2522 * When an object will be deleted soon, it and its children may not
2523 * want to get focus (by focus reverting or by other focus controls).
2524 * Then, just use this API before deleting.
2526 * @see elm_object_tree_unfocusable_get()
2530 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2533 * Get whether an Elementary object and its children are unfocusable or not.
2535 * @param obj The Elementary object to get the information from
2536 * @return @c EINA_TRUE, if the tree is unfocussable,
2537 * @c EINA_FALSE if not (and on errors).
2539 * @see elm_object_tree_unfocusable_set()
2543 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2546 * @defgroup Scrolling Scrolling
2548 * These are functions setting how scrollable views in Elementary
2549 * widgets should behave on user interaction.
2555 * Get whether scrollers should bounce when they reach their
2556 * viewport's edge during a scroll.
2558 * @return the thumb scroll bouncing state
2560 * This is the default behavior for touch screens, in general.
2561 * @ingroup Scrolling
2563 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2566 * Set whether scrollers should bounce when they reach their
2567 * viewport's edge during a scroll.
2569 * @param enabled the thumb scroll bouncing state
2571 * @see elm_thumbscroll_bounce_enabled_get()
2572 * @ingroup Scrolling
2574 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2577 * Set whether scrollers should bounce when they reach their
2578 * viewport's edge during a scroll, for all Elementary application
2581 * @param enabled the thumb scroll bouncing state
2583 * @see elm_thumbscroll_bounce_enabled_get()
2584 * @ingroup Scrolling
2586 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2589 * Get the amount of inertia a scroller will impose at bounce
2592 * @return the thumb scroll bounce friction
2594 * @ingroup Scrolling
2596 EAPI double elm_scroll_bounce_friction_get(void);
2599 * Set the amount of inertia a scroller will impose at bounce
2602 * @param friction the thumb scroll bounce friction
2604 * @see elm_thumbscroll_bounce_friction_get()
2605 * @ingroup Scrolling
2607 EAPI void elm_scroll_bounce_friction_set(double friction);
2610 * Set the amount of inertia a scroller will impose at bounce
2611 * animations, for all Elementary application windows.
2613 * @param friction the thumb scroll bounce friction
2615 * @see elm_thumbscroll_bounce_friction_get()
2616 * @ingroup Scrolling
2618 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2621 * Get the amount of inertia a <b>paged</b> scroller will impose at
2622 * page fitting animations.
2624 * @return the page scroll friction
2626 * @ingroup Scrolling
2628 EAPI double elm_scroll_page_scroll_friction_get(void);
2631 * Set the amount of inertia a <b>paged</b> scroller will impose at
2632 * page fitting animations.
2634 * @param friction the page scroll friction
2636 * @see elm_thumbscroll_page_scroll_friction_get()
2637 * @ingroup Scrolling
2639 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2642 * Set the amount of inertia a <b>paged</b> scroller will impose at
2643 * page fitting animations, for all Elementary application windows.
2645 * @param friction the page scroll friction
2647 * @see elm_thumbscroll_page_scroll_friction_get()
2648 * @ingroup Scrolling
2650 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2653 * Get the amount of inertia a scroller will impose at region bring
2656 * @return the bring in scroll friction
2658 * @ingroup Scrolling
2660 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2663 * Set the amount of inertia a scroller will impose at region bring
2666 * @param friction the bring in scroll friction
2668 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2669 * @ingroup Scrolling
2671 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2674 * Set the amount of inertia a scroller will impose at region bring
2675 * animations, for all Elementary application windows.
2677 * @param friction the bring in scroll friction
2679 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2680 * @ingroup Scrolling
2682 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2685 * Get the amount of inertia scrollers will impose at animations
2686 * triggered by Elementary widgets' zooming API.
2688 * @return the zoom friction
2690 * @ingroup Scrolling
2692 EAPI double elm_scroll_zoom_friction_get(void);
2695 * Set the amount of inertia scrollers will impose at animations
2696 * triggered by Elementary widgets' zooming API.
2698 * @param friction the zoom friction
2700 * @see elm_thumbscroll_zoom_friction_get()
2701 * @ingroup Scrolling
2703 EAPI void elm_scroll_zoom_friction_set(double friction);
2706 * Set the amount of inertia scrollers will impose at animations
2707 * triggered by Elementary widgets' zooming API, for all Elementary
2708 * application windows.
2710 * @param friction the zoom friction
2712 * @see elm_thumbscroll_zoom_friction_get()
2713 * @ingroup Scrolling
2715 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2718 * Get whether scrollers should be draggable from any point in their
2721 * @return the thumb scroll state
2723 * @note This is the default behavior for touch screens, in general.
2724 * @note All other functions namespaced with "thumbscroll" will only
2725 * have effect if this mode is enabled.
2727 * @ingroup Scrolling
2729 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2732 * Set whether scrollers should be draggable from any point in their
2735 * @param enabled the thumb scroll state
2737 * @see elm_thumbscroll_enabled_get()
2738 * @ingroup Scrolling
2740 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2743 * Set whether scrollers should be draggable from any point in their
2744 * views, for all Elementary application windows.
2746 * @param enabled the thumb scroll state
2748 * @see elm_thumbscroll_enabled_get()
2749 * @ingroup Scrolling
2751 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2754 * Get the number of pixels one should travel while dragging a
2755 * scroller's view to actually trigger scrolling.
2757 * @return the thumb scroll threshould
2759 * One would use higher values for touch screens, in general, because
2760 * of their inherent imprecision.
2761 * @ingroup Scrolling
2763 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2766 * Set the number of pixels one should travel while dragging a
2767 * scroller's view to actually trigger scrolling.
2769 * @param threshold the thumb scroll threshould
2771 * @see elm_thumbscroll_threshould_get()
2772 * @ingroup Scrolling
2774 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2777 * Set the number of pixels one should travel while dragging a
2778 * scroller's view to actually trigger scrolling, for all Elementary
2779 * application windows.
2781 * @param threshold the thumb scroll threshould
2783 * @see elm_thumbscroll_threshould_get()
2784 * @ingroup Scrolling
2786 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2789 * Get the minimum speed of mouse cursor movement which will trigger
2790 * list self scrolling animation after a mouse up event
2793 * @return the thumb scroll momentum threshould
2795 * @ingroup Scrolling
2797 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2800 * Set the minimum speed of mouse cursor movement which will trigger
2801 * list self scrolling animation after a mouse up event
2804 * @param threshold the thumb scroll momentum threshould
2806 * @see elm_thumbscroll_momentum_threshould_get()
2807 * @ingroup Scrolling
2809 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2812 * Set the minimum speed of mouse cursor movement which will trigger
2813 * list self scrolling animation after a mouse up event
2814 * (pixels/second), for all Elementary application windows.
2816 * @param threshold the thumb scroll momentum threshould
2818 * @see elm_thumbscroll_momentum_threshould_get()
2819 * @ingroup Scrolling
2821 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2824 * Get the amount of inertia a scroller will impose at self scrolling
2827 * @return the thumb scroll friction
2829 * @ingroup Scrolling
2831 EAPI double elm_scroll_thumbscroll_friction_get(void);
2834 * Set the amount of inertia a scroller will impose at self scrolling
2837 * @param friction the thumb scroll friction
2839 * @see elm_thumbscroll_friction_get()
2840 * @ingroup Scrolling
2842 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
2845 * Set the amount of inertia a scroller will impose at self scrolling
2846 * animations, for all Elementary application windows.
2848 * @param friction the thumb scroll friction
2850 * @see elm_thumbscroll_friction_get()
2851 * @ingroup Scrolling
2853 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
2856 * Get the amount of lag between your actual mouse cursor dragging
2857 * movement and a scroller's view movement itself, while pushing it
2858 * into bounce state manually.
2860 * @return the thumb scroll border friction
2862 * @ingroup Scrolling
2864 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
2867 * Set the amount of lag between your actual mouse cursor dragging
2868 * movement and a scroller's view movement itself, while pushing it
2869 * into bounce state manually.
2871 * @param friction the thumb scroll border friction. @c 0.0 for
2872 * perfect synchrony between two movements, @c 1.0 for maximum
2875 * @see elm_thumbscroll_border_friction_get()
2876 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2878 * @ingroup Scrolling
2880 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
2883 * Set the amount of lag between your actual mouse cursor dragging
2884 * movement and a scroller's view movement itself, while pushing it
2885 * into bounce state manually, for all Elementary application windows.
2887 * @param friction the thumb scroll border friction. @c 0.0 for
2888 * perfect synchrony between two movements, @c 1.0 for maximum
2891 * @see elm_thumbscroll_border_friction_get()
2892 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2894 * @ingroup Scrolling
2896 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
2899 * Get the sensitivity amount which is be multiplied by the length of
2902 * @return the thumb scroll sensitivity friction
2904 * @ingroup Scrolling
2906 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
2909 * Set the sensitivity amount which is be multiplied by the length of
2912 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2913 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2916 * @see elm_thumbscroll_sensitivity_friction_get()
2917 * @note parameter value will get bound to 0.1 - 1.0 interval, always
2919 * @ingroup Scrolling
2921 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
2924 * Set the sensitivity amount which is be multiplied by the length of
2925 * mouse dragging, for all Elementary application windows.
2927 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2928 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2931 * @see elm_thumbscroll_sensitivity_friction_get()
2932 * @note parameter value will get bound to 0.1 - 1.0 interval, always
2934 * @ingroup Scrolling
2936 EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
2943 * @defgroup Scrollhints Scrollhints
2945 * Objects when inside a scroller can scroll, but this may not always be
2946 * desirable in certain situations. This allows an object to hint to itself
2947 * and parents to "not scroll" in one of 2 ways. If any child object of a
2948 * scroller has pushed a scroll freeze or hold then it affects all parent
2949 * scrollers until all children have released them.
2951 * 1. To hold on scrolling. This means just flicking and dragging may no
2952 * longer scroll, but pressing/dragging near an edge of the scroller will
2953 * still scroll. This is automatically used by the entry object when
2956 * 2. To totally freeze scrolling. This means it stops. until
2963 * Push the scroll hold by 1
2965 * This increments the scroll hold count by one. If it is more than 0 it will
2966 * take effect on the parents of the indicated object.
2968 * @param obj The object
2969 * @ingroup Scrollhints
2971 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2974 * Pop the scroll hold by 1
2976 * This decrements the scroll hold count by one. If it is more than 0 it will
2977 * take effect on the parents of the indicated object.
2979 * @param obj The object
2980 * @ingroup Scrollhints
2982 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2985 * Push the scroll freeze by 1
2987 * This increments the scroll freeze count by one. If it is more
2988 * than 0 it will take effect on the parents of the indicated
2991 * @param obj The object
2992 * @ingroup Scrollhints
2994 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2997 * Pop the scroll freeze by 1
2999 * This decrements the scroll freeze count by one. If it is more
3000 * than 0 it will take effect on the parents of the indicated
3003 * @param obj The object
3004 * @ingroup Scrollhints
3006 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3009 * Lock the scrolling of the given widget (and thus all parents)
3011 * This locks the given object from scrolling in the X axis (and implicitly
3012 * also locks all parent scrollers too from doing the same).
3014 * @param obj The object
3015 * @param lock The lock state (1 == locked, 0 == unlocked)
3016 * @ingroup Scrollhints
3018 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3021 * Lock the scrolling of the given widget (and thus all parents)
3023 * This locks the given object from scrolling in the Y axis (and implicitly
3024 * also locks all parent scrollers too from doing the same).
3026 * @param obj The object
3027 * @param lock The lock state (1 == locked, 0 == unlocked)
3028 * @ingroup Scrollhints
3030 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3033 * Get the scrolling lock of the given widget
3035 * This gets the lock for X axis scrolling.
3037 * @param obj The object
3038 * @ingroup Scrollhints
3040 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3043 * Get the scrolling lock of the given widget
3045 * This gets the lock for X axis scrolling.
3047 * @param obj The object
3048 * @ingroup Scrollhints
3050 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3057 * Send a signal to the widget edje object.
3059 * This function sends a signal to the edje object of the obj. An
3060 * edje program can respond to a signal by specifying matching
3061 * 'signal' and 'source' fields.
3063 * @param obj The object
3064 * @param emission The signal's name.
3065 * @param source The signal's source.
3068 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3071 * Add a callback for a signal emitted by widget edje object.
3073 * This function connects a callback function to a signal emitted by the
3074 * edje object of the obj.
3075 * Globs can occur in either the emission or source name.
3077 * @param obj The object
3078 * @param emission The signal's name.
3079 * @param source The signal's source.
3080 * @param func The callback function to be executed when the signal is
3082 * @param data A pointer to data to pass in to the callback function.
3085 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);
3088 * Remove a signal-triggered callback from a widget edje object.
3090 * This function removes a callback, previoulsy attached to a
3091 * signal emitted by the edje object of the obj. The parameters
3092 * emission, source and func must match exactly those passed to a
3093 * previous call to elm_object_signal_callback_add(). The data
3094 * pointer that was passed to this call will be returned.
3096 * @param obj The object
3097 * @param emission The signal's name.
3098 * @param source The signal's source.
3099 * @param func The callback function to be executed when the signal is
3101 * @return The data pointer
3104 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);
3107 * Add a callback for input events (key up, key down, mouse wheel)
3108 * on a given Elementary widget
3110 * @param obj The widget to add an event callback on
3111 * @param func The callback function to be executed when the event
3113 * @param data Data to pass in to @p func
3115 * Every widget in an Elementary interface set to receive focus,
3116 * with elm_object_focus_allow_set(), will propagate @b all of its
3117 * key up, key down and mouse wheel input events up to its parent
3118 * object, and so on. All of the focusable ones in this chain which
3119 * had an event callback set, with this call, will be able to treat
3120 * those events. There are two ways of making the propagation of
3121 * these event upwards in the tree of widgets to @b cease:
3122 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3123 * the event was @b not processed, so the propagation will go on.
3124 * - The @c event_info pointer passed to @p func will contain the
3125 * event's structure and, if you OR its @c event_flags inner
3126 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3127 * one has already handled it, thus killing the event's
3130 * @note Your event callback will be issued on those events taking
3131 * place only if no other child widget of @obj has consumed the
3134 * @note Not to be confused with @c
3135 * evas_object_event_callback_add(), which will add event callbacks
3136 * per type on general Evas objects (no event propagation
3137 * infrastructure taken in account).
3139 * @note Not to be confused with @c
3140 * elm_object_signal_callback_add(), which will add callbacks to @b
3141 * signals coming from a widget's theme, not input events.
3143 * @note Not to be confused with @c
3144 * edje_object_signal_callback_add(), which does the same as
3145 * elm_object_signal_callback_add(), but directly on an Edje
3148 * @note Not to be confused with @c
3149 * evas_object_smart_callback_add(), which adds callbacks to smart
3150 * objects' <b>smart events</b>, and not input events.
3152 * @see elm_object_event_callback_del()
3156 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3159 * Remove an event callback from a widget.
3161 * This function removes a callback, previoulsy attached to event emission
3163 * The parameters func and data must match exactly those passed to
3164 * a previous call to elm_object_event_callback_add(). The data pointer that
3165 * was passed to this call will be returned.
3167 * @param obj The object
3168 * @param func The callback function to be executed when the event is
3170 * @param data Data to pass in to the callback function.
3171 * @return The data pointer
3174 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3177 * Adjust size of an element for finger usage.
3179 * @param times_w How many fingers should fit horizontally
3180 * @param w Pointer to the width size to adjust
3181 * @param times_h How many fingers should fit vertically
3182 * @param h Pointer to the height size to adjust
3184 * This takes width and height sizes (in pixels) as input and a
3185 * size multiple (which is how many fingers you want to place
3186 * within the area, being "finger" the size set by
3187 * elm_finger_size_set()), and adjusts the size to be large enough
3188 * to accommodate the resulting size -- if it doesn't already
3189 * accommodate it. On return the @p w and @p h sizes pointed to by
3190 * these parameters will be modified, on those conditions.
3192 * @note This is kind of a low level Elementary call, most useful
3193 * on size evaluation times for widgets. An external user wouldn't
3194 * be calling, most of the time.
3198 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3201 * Get the duration for occuring long press event.
3203 * @return Timeout for long press event
3204 * @ingroup Longpress
3206 EAPI double elm_longpress_timeout_get(void);
3209 * Set the duration for occuring long press event.
3211 * @param lonpress_timeout Timeout for long press event
3212 * @ingroup Longpress
3214 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3217 * @defgroup Debug Debug
3218 * don't use it unless you are sure
3224 * Print Tree object hierarchy in stdout
3226 * @param obj The root object
3229 EAPI void elm_object_tree_dump(const Evas_Object *top);
3230 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3232 EAPI void elm_autocapitalization_allow_all_set(Eina_Bool autocap);
3233 EAPI void elm_autoperiod_allow_all_set(Eina_Bool autoperiod);
3235 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3237 * @param obj The root object
3238 * @param file The path of output file
3241 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3248 * @defgroup Theme Theme
3250 * Elementary uses Edje to theme its widgets, naturally. But for the most
3251 * part this is hidden behind a simpler interface that lets the user set
3252 * extensions and choose the style of widgets in a much easier way.
3254 * Instead of thinking in terms of paths to Edje files and their groups
3255 * each time you want to change the appearance of a widget, Elementary
3256 * works so you can add any theme file with extensions or replace the
3257 * main theme at one point in the application, and then just set the style
3258 * of widgets with elm_object_style_set() and related functions. Elementary
3259 * will then look in its list of themes for a matching group and apply it,
3260 * and when the theme changes midway through the application, all widgets
3261 * will be updated accordingly.
3263 * There are three concepts you need to know to understand how Elementary
3264 * theming works: default theme, extensions and overlays.
3266 * Default theme, obviously enough, is the one that provides the default
3267 * look of all widgets. End users can change the theme used by Elementary
3268 * by setting the @c ELM_THEME environment variable before running an
3269 * application, or globally for all programs using the @c elementary_config
3270 * utility. Applications can change the default theme using elm_theme_set(),
3271 * but this can go against the user wishes, so it's not an adviced practice.
3273 * Ideally, applications should find everything they need in the already
3274 * provided theme, but there may be occasions when that's not enough and
3275 * custom styles are required to correctly express the idea. For this
3276 * cases, Elementary has extensions.
3278 * Extensions allow the application developer to write styles of its own
3279 * to apply to some widgets. This requires knowledge of how each widget
3280 * is themed, as extensions will always replace the entire group used by
3281 * the widget, so important signals and parts need to be there for the
3282 * object to behave properly (see documentation of Edje for details).
3283 * Once the theme for the extension is done, the application needs to add
3284 * it to the list of themes Elementary will look into, using
3285 * elm_theme_extension_add(), and set the style of the desired widgets as
3286 * he would normally with elm_object_style_set().
3288 * Overlays, on the other hand, can replace the look of all widgets by
3289 * overriding the default style. Like extensions, it's up to the application
3290 * developer to write the theme for the widgets it wants, the difference
3291 * being that when looking for the theme, Elementary will check first the
3292 * list of overlays, then the set theme and lastly the list of extensions,
3293 * so with overlays it's possible to replace the default view and every
3294 * widget will be affected. This is very much alike to setting the whole
3295 * theme for the application and will probably clash with the end user
3296 * options, not to mention the risk of ending up with not matching styles
3297 * across the program. Unless there's a very special reason to use them,
3298 * overlays should be avoided for the resons exposed before.
3300 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3301 * keeps one default internally and every function that receives one of
3302 * these can be called with NULL to refer to this default (except for
3303 * elm_theme_free()). It's possible to create a new instance of a
3304 * ::Elm_Theme to set other theme for a specific widget (and all of its
3305 * children), but this is as discouraged, if not even more so, than using
3306 * overlays. Don't use this unless you really know what you are doing.
3308 * But to be less negative about things, you can look at the following
3310 * @li @ref theme_example_01 "Using extensions"
3311 * @li @ref theme_example_02 "Using overlays"
3316 * @typedef Elm_Theme
3318 * Opaque handler for the list of themes Elementary looks for when
3319 * rendering widgets.
3321 * Stay out of this unless you really know what you are doing. For most
3322 * cases, sticking to the default is all a developer needs.
3324 typedef struct _Elm_Theme Elm_Theme;
3327 * Create a new specific theme
3329 * This creates an empty specific theme that only uses the default theme. A
3330 * specific theme has its own private set of extensions and overlays too
3331 * (which are empty by default). Specific themes do not fall back to themes
3332 * of parent objects. They are not intended for this use. Use styles, overlays
3333 * and extensions when needed, but avoid specific themes unless there is no
3334 * other way (example: you want to have a preview of a new theme you are
3335 * selecting in a "theme selector" window. The preview is inside a scroller
3336 * and should display what the theme you selected will look like, but not
3337 * actually apply it yet. The child of the scroller will have a specific
3338 * theme set to show this preview before the user decides to apply it to all
3341 EAPI Elm_Theme *elm_theme_new(void);
3343 * Free a specific theme
3345 * @param th The theme to free
3347 * This frees a theme created with elm_theme_new().
3349 EAPI void elm_theme_free(Elm_Theme *th);
3351 * Copy the theme fom the source to the destination theme
3353 * @param th The source theme to copy from
3354 * @param thdst The destination theme to copy data to
3356 * This makes a one-time static copy of all the theme config, extensions
3357 * and overlays from @p th to @p thdst. If @p th references a theme, then
3358 * @p thdst is also set to reference it, with all the theme settings,
3359 * overlays and extensions that @p th had.
3361 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3363 * Tell the source theme to reference the ref theme
3365 * @param th The theme that will do the referencing
3366 * @param thref The theme that is the reference source
3368 * This clears @p th to be empty and then sets it to refer to @p thref
3369 * so @p th acts as an override to @p thref, but where its overrides
3370 * don't apply, it will fall through to @p thref for configuration.
3372 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3374 * Return the theme referred to
3376 * @param th The theme to get the reference from
3377 * @return The referenced theme handle
3379 * This gets the theme set as the reference theme by elm_theme_ref_set().
3380 * If no theme is set as a reference, NULL is returned.
3382 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3384 * Return the default theme
3386 * @return The default theme handle
3388 * This returns the internal default theme setup handle that all widgets
3389 * use implicitly unless a specific theme is set. This is also often use
3390 * as a shorthand of NULL.
3392 EAPI Elm_Theme *elm_theme_default_get(void);
3394 * Prepends a theme overlay to the list of overlays
3396 * @param th The theme to add to, or if NULL, the default theme
3397 * @param item The Edje file path to be used
3399 * Use this if your application needs to provide some custom overlay theme
3400 * (An Edje file that replaces some default styles of widgets) where adding
3401 * new styles, or changing system theme configuration is not possible. Do
3402 * NOT use this instead of a proper system theme configuration. Use proper
3403 * configuration files, profiles, environment variables etc. to set a theme
3404 * so that the theme can be altered by simple confiugration by a user. Using
3405 * this call to achieve that effect is abusing the API and will create lots
3408 * @see elm_theme_extension_add()
3410 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3412 * Delete a theme overlay from the list of overlays
3414 * @param th The theme to delete from, or if NULL, the default theme
3415 * @param item The name of the theme overlay
3417 * @see elm_theme_overlay_add()
3419 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3421 * Appends a theme extension to the list of extensions.
3423 * @param th The theme to add to, or if NULL, the default theme
3424 * @param item The Edje file path to be used
3426 * This is intended when an application needs more styles of widgets or new
3427 * widget themes that the default does not provide (or may not provide). The
3428 * application has "extended" usage by coming up with new custom style names
3429 * for widgets for specific uses, but as these are not "standard", they are
3430 * not guaranteed to be provided by a default theme. This means the
3431 * application is required to provide these extra elements itself in specific
3432 * Edje files. This call adds one of those Edje files to the theme search
3433 * path to be search after the default theme. The use of this call is
3434 * encouraged when default styles do not meet the needs of the application.
3435 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3437 * @see elm_object_style_set()
3439 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3441 * Deletes a theme extension from the list of extensions.
3443 * @param th The theme to delete from, or if NULL, the default theme
3444 * @param item The name of the theme extension
3446 * @see elm_theme_extension_add()
3448 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3450 * Set the theme search order for the given theme
3452 * @param th The theme to set the search order, or if NULL, the default theme
3453 * @param theme Theme search string
3455 * This sets the search string for the theme in path-notation from first
3456 * theme to search, to last, delimited by the : character. Example:
3458 * "shiny:/path/to/file.edj:default"
3460 * See the ELM_THEME environment variable for more information.
3462 * @see elm_theme_get()
3463 * @see elm_theme_list_get()
3465 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3467 * Return the theme search order
3469 * @param th The theme to get the search order, or if NULL, the default theme
3470 * @return The internal search order path
3472 * This function returns a colon separated string of theme elements as
3473 * returned by elm_theme_list_get().
3475 * @see elm_theme_set()
3476 * @see elm_theme_list_get()
3478 EAPI const char *elm_theme_get(Elm_Theme *th);
3480 * Return a list of theme elements to be used in a theme.
3482 * @param th Theme to get the list of theme elements from.
3483 * @return The internal list of theme elements
3485 * This returns the internal list of theme elements (will only be valid as
3486 * long as the theme is not modified by elm_theme_set() or theme is not
3487 * freed by elm_theme_free(). This is a list of strings which must not be
3488 * altered as they are also internal. If @p th is NULL, then the default
3489 * theme element list is returned.
3491 * A theme element can consist of a full or relative path to a .edj file,
3492 * or a name, without extension, for a theme to be searched in the known
3493 * theme paths for Elemementary.
3495 * @see elm_theme_set()
3496 * @see elm_theme_get()
3498 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3500 * Return the full patrh for a theme element
3502 * @param f The theme element name
3503 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3504 * @return The full path to the file found.
3506 * This returns a string you should free with free() on success, NULL on
3507 * failure. This will search for the given theme element, and if it is a
3508 * full or relative path element or a simple searchable name. The returned
3509 * path is the full path to the file, if searched, and the file exists, or it
3510 * is simply the full path given in the element or a resolved path if
3511 * relative to home. The @p in_search_path boolean pointed to is set to
3512 * EINA_TRUE if the file was a searchable file andis in the search path,
3513 * and EINA_FALSE otherwise.
3515 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3517 * Flush the current theme.
3519 * @param th Theme to flush
3521 * This flushes caches that let elementary know where to find theme elements
3522 * in the given theme. If @p th is NULL, then the default theme is flushed.
3523 * Call this function if source theme data has changed in such a way as to
3524 * make any caches Elementary kept invalid.
3526 EAPI void elm_theme_flush(Elm_Theme *th);
3528 * This flushes all themes (default and specific ones).
3530 * This will flush all themes in the current application context, by calling
3531 * elm_theme_flush() on each of them.
3533 EAPI void elm_theme_full_flush(void);
3535 * Set the theme for all elementary using applications on the current display
3537 * @param theme The name of the theme to use. Format same as the ELM_THEME
3538 * environment variable.
3540 EAPI void elm_theme_all_set(const char *theme);
3542 * Return a list of theme elements in the theme search path
3544 * @return A list of strings that are the theme element names.
3546 * This lists all available theme files in the standard Elementary search path
3547 * for theme elements, and returns them in alphabetical order as theme
3548 * element names in a list of strings. Free this with
3549 * elm_theme_name_available_list_free() when you are done with the list.
3551 EAPI Eina_List *elm_theme_name_available_list_new(void);
3553 * Free the list returned by elm_theme_name_available_list_new()
3555 * This frees the list of themes returned by
3556 * elm_theme_name_available_list_new(). Once freed the list should no longer
3557 * be used. a new list mys be created.
3559 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3561 * Set a specific theme to be used for this object and its children
3563 * @param obj The object to set the theme on
3564 * @param th The theme to set
3566 * This sets a specific theme that will be used for the given object and any
3567 * child objects it has. If @p th is NULL then the theme to be used is
3568 * cleared and the object will inherit its theme from its parent (which
3569 * ultimately will use the default theme if no specific themes are set).
3571 * Use special themes with great care as this will annoy users and make
3572 * configuration difficult. Avoid any custom themes at all if it can be
3575 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3577 * Get the specific theme to be used
3579 * @param obj The object to get the specific theme from
3580 * @return The specifc theme set.
3582 * This will return a specific theme set, or NULL if no specific theme is
3583 * set on that object. It will not return inherited themes from parents, only
3584 * the specific theme set for that specific object. See elm_object_theme_set()
3585 * for more information.
3587 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3590 * Get a data item from a theme
3592 * @param th The theme, or NULL for default theme
3593 * @param key The data key to search with
3594 * @return The data value, or NULL on failure
3596 * This function is used to return data items from edc in @p th, an overlay, or an extension.
3597 * It works the same way as edje_file_data_get() except that the return is stringshared.
3599 EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3605 /** @defgroup Win Win
3607 * @image html img/widget/win/preview-00.png
3608 * @image latex img/widget/win/preview-00.eps
3610 * The window class of Elementary. Contains functions to manipulate
3611 * windows. The Evas engine used to render the window contents is specified
3612 * in the system or user elementary config files (whichever is found last),
3613 * and can be overridden with the ELM_ENGINE environment variable for
3614 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3615 * compilation setup and modules actually installed at runtime) are (listed
3616 * in order of best supported and most likely to be complete and work to
3619 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3620 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3622 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3624 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3626 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3628 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3629 * rendering using SDL as the buffer)
3630 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3631 * GDI with software)
3632 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3633 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3634 * grayscale using dedicated 8bit software engine in X11)
3635 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3636 * X11 using 16bit software engine)
3637 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3638 * (Windows CE rendering via GDI with 16bit software renderer)
3639 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3640 * buffer with 16bit software renderer)
3641 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3642 * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3643 * @li "psl1ght" (PS3 rendering using PSL1GHT)
3645 * All engines use a simple string to select the engine to render, EXCEPT
3646 * the "shot" engine. This actually encodes the output of the virtual
3647 * screenshot and how long to delay in the engine string. The engine string
3648 * is encoded in the following way:
3650 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3652 * Where options are separated by a ":" char if more than one option is
3653 * given, with delay, if provided being the first option and file the last
3654 * (order is important). The delay specifies how long to wait after the
3655 * window is shown before doing the virtual "in memory" rendering and then
3656 * save the output to the file specified by the file option (and then exit).
3657 * If no delay is given, the default is 0.5 seconds. If no file is given the
3658 * default output file is "out.png". Repeat option is for continous
3659 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3660 * fixed to "out001.png" Some examples of using the shot engine:
3662 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3663 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3664 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3665 * ELM_ENGINE="shot:delay=2.0" elementary_test
3666 * ELM_ENGINE="shot:" elementary_test
3668 * Signals that you can add callbacks for are:
3670 * @li "delete,request": the user requested to close the window. See
3671 * elm_win_autodel_set().
3672 * @li "focus,in": window got focus
3673 * @li "focus,out": window lost focus
3674 * @li "moved": window that holds the canvas was moved
3677 * @li @ref win_example_01
3682 * Defines the types of window that can be created
3684 * These are hints set on the window so that a running Window Manager knows
3685 * how the window should be handled and/or what kind of decorations it
3688 * Currently, only the X11 backed engines use them.
3690 typedef enum _Elm_Win_Type
3692 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3693 window. Almost every window will be created with this
3695 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3696 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3697 window holding desktop icons. */
3698 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3699 be kept on top of any other window by the Window
3701 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3703 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3704 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3706 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3707 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3708 entry in a menubar is clicked. Typically used
3709 with elm_win_override_set(). This hint exists
3710 for completion only, as the EFL way of
3711 implementing a menu would not normally use a
3712 separate window for its contents. */
3713 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3714 triggered by right-clicking an object. */
3715 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3716 explanatory text that typically appear after the
3717 mouse cursor hovers over an object for a while.
3718 Typically used with elm_win_override_set() and also
3719 not very commonly used in the EFL. */
3720 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3721 battery life or a new E-Mail received. */
3722 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3723 usually used in the EFL. */
3724 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3725 object being dragged across different windows, or even
3726 applications. Typically used with
3727 elm_win_override_set(). */
3728 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3729 buffer. No actual window is created for this
3730 type, instead the window and all of its
3731 contents will be rendered to an image buffer.
3732 This allows to have children window inside a
3733 parent one just like any other object would
3734 be, and do other things like applying @c
3735 Evas_Map effects to it. This is the only type
3736 of window that requires the @c parent
3737 parameter of elm_win_add() to be a valid @c
3742 * The differents layouts that can be requested for the virtual keyboard.
3744 * When the application window is being managed by Illume, it may request
3745 * any of the following layouts for the virtual keyboard.
3747 typedef enum _Elm_Win_Keyboard_Mode
3749 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3750 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3751 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3752 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3753 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3754 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3755 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3756 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3757 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3758 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3759 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3760 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3761 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3762 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3763 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3764 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3765 } Elm_Win_Keyboard_Mode;
3768 * Available commands that can be sent to the Illume manager.
3770 * When running under an Illume session, a window may send commands to the
3771 * Illume manager to perform different actions.
3773 typedef enum _Elm_Illume_Command
3775 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3777 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3779 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3781 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3782 } Elm_Illume_Command;
3785 * Adds a window object. If this is the first window created, pass NULL as
3788 * @param parent Parent object to add the window to, or NULL
3789 * @param name The name of the window
3790 * @param type The window type, one of #Elm_Win_Type.
3792 * The @p parent paramter can be @c NULL for every window @p type except
3793 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3794 * which the image object will be created.
3796 * @return The created object, or NULL on failure
3798 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3800 * Adds a window object with standard setup
3802 * @param name The name of the window
3803 * @param title The title for the window
3805 * This creates a window like elm_win_add() but also puts in a standard
3806 * background with elm_bg_add(), as well as setting the window title to
3807 * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
3808 * as the parent widget.
3810 * @return The created object, or NULL on failure
3812 * @see elm_win_add()
3814 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
3816 * Add @p subobj as a resize object of window @p obj.
3819 * Setting an object as a resize object of the window means that the
3820 * @p subobj child's size and position will be controlled by the window
3821 * directly. That is, the object will be resized to match the window size
3822 * and should never be moved or resized manually by the developer.
3824 * In addition, resize objects of the window control what the minimum size
3825 * of it will be, as well as whether it can or not be resized by the user.
3827 * For the end user to be able to resize a window by dragging the handles
3828 * or borders provided by the Window Manager, or using any other similar
3829 * mechanism, all of the resize objects in the window should have their
3830 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3832 * @param obj The window object
3833 * @param subobj The resize object to add
3835 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3837 * Delete @p subobj as a resize object of window @p obj.
3839 * This function removes the object @p subobj from the resize objects of
3840 * the window @p obj. It will not delete the object itself, which will be
3841 * left unmanaged and should be deleted by the developer, manually handled
3842 * or set as child of some other container.
3844 * @param obj The window object
3845 * @param subobj The resize object to add
3847 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3849 * Set the title of the window
3851 * @param obj The window object
3852 * @param title The title to set
3854 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3856 * Get the title of the window
3858 * The returned string is an internal one and should not be freed or
3859 * modified. It will also be rendered invalid if a new title is set or if
3860 * the window is destroyed.
3862 * @param obj The window object
3865 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3867 * Set the window's autodel state.
3869 * When closing the window in any way outside of the program control, like
3870 * pressing the X button in the titlebar or using a command from the
3871 * Window Manager, a "delete,request" signal is emitted to indicate that
3872 * this event occurred and the developer can take any action, which may
3873 * include, or not, destroying the window object.
3875 * When the @p autodel parameter is set, the window will be automatically
3876 * destroyed when this event occurs, after the signal is emitted.
3877 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3878 * and is up to the program to do so when it's required.
3880 * @param obj The window object
3881 * @param autodel If true, the window will automatically delete itself when
3884 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3886 * Get the window's autodel state.
3888 * @param obj The window object
3889 * @return If the window will automatically delete itself when closed
3891 * @see elm_win_autodel_set()
3893 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3895 * Activate a window object.
3897 * This function sends a request to the Window Manager to activate the
3898 * window pointed by @p obj. If honored by the WM, the window will receive
3899 * the keyboard focus.
3901 * @note This is just a request that a Window Manager may ignore, so calling
3902 * this function does not ensure in any way that the window will be the
3903 * active one after it.
3905 * @param obj The window object
3907 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3909 * Lower a window object.
3911 * Places the window pointed by @p obj at the bottom of the stack, so that
3912 * no other window is covered by it.
3914 * If elm_win_override_set() is not set, the Window Manager may ignore this
3917 * @param obj The window object
3919 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3921 * Raise a window object.
3923 * Places the window pointed by @p obj at the top of the stack, so that it's
3924 * not covered by any other window.
3926 * If elm_win_override_set() is not set, the Window Manager may ignore this
3929 * @param obj The window object
3931 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3933 * Set the borderless state of a window.
3935 * This function requests the Window Manager to not draw any decoration
3936 * around the window.
3938 * @param obj The window object
3939 * @param borderless If true, the window is borderless
3941 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3943 * Get the borderless state of a window.
3945 * @param obj The window object
3946 * @return If true, the window is borderless
3948 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3950 * Set the shaped state of a window.
3952 * Shaped windows, when supported, will render the parts of the window that
3953 * has no content, transparent.
3955 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3956 * background object or cover the entire window in any other way, or the
3957 * parts of the canvas that have no data will show framebuffer artifacts.
3959 * @param obj The window object
3960 * @param shaped If true, the window is shaped
3962 * @see elm_win_alpha_set()
3964 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3966 * Get the shaped state of a window.
3968 * @param obj The window object
3969 * @return If true, the window is shaped
3971 * @see elm_win_shaped_set()
3973 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3975 * Set the alpha channel state of a window.
3977 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3978 * possibly making parts of the window completely or partially transparent.
3979 * This is also subject to the underlying system supporting it, like for
3980 * example, running under a compositing manager. If no compositing is
3981 * available, enabling this option will instead fallback to using shaped
3982 * windows, with elm_win_shaped_set().
3984 * @param obj The window object
3985 * @param alpha If true, the window has an alpha channel
3987 * @see elm_win_alpha_set()
3989 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3991 * Get the transparency state of a window.
3993 * @param obj The window object
3994 * @return If true, the window is transparent
3996 * @see elm_win_transparent_set()
3998 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4000 * Set the transparency state of a window.
4002 * Use elm_win_alpha_set() instead.
4004 * @param obj The window object
4005 * @param transparent If true, the window is transparent
4007 * @see elm_win_alpha_set()
4009 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4011 * Get the alpha channel state of a window.
4013 * @param obj The window object
4014 * @return If true, the window has an alpha channel
4016 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4018 * Set the override state of a window.
4020 * A window with @p override set to EINA_TRUE will not be managed by the
4021 * Window Manager. This means that no decorations of any kind will be shown
4022 * for it, moving and resizing must be handled by the application, as well
4023 * as the window visibility.
4025 * This should not be used for normal windows, and even for not so normal
4026 * ones, it should only be used when there's a good reason and with a lot
4027 * of care. Mishandling override windows may result situations that
4028 * disrupt the normal workflow of the end user.
4030 * @param obj The window object
4031 * @param override If true, the window is overridden
4033 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4035 * Get the override state of a window.
4037 * @param obj The window object
4038 * @return If true, the window is overridden
4040 * @see elm_win_override_set()
4042 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4044 * Set the fullscreen state of a window.
4046 * @param obj The window object
4047 * @param fullscreen If true, the window is fullscreen
4049 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4051 * Get the fullscreen state of a window.
4053 * @param obj The window object
4054 * @return If true, the window is fullscreen
4056 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4058 * Set the maximized state of a window.
4060 * @param obj The window object
4061 * @param maximized If true, the window is maximized
4063 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4065 * Get the maximized state of a window.
4067 * @param obj The window object
4068 * @return If true, the window is maximized
4070 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4072 * Set the iconified state of a window.
4074 * @param obj The window object
4075 * @param iconified If true, the window is iconified
4077 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4079 * Get the iconified state of a window.
4081 * @param obj The window object
4082 * @return If true, the window is iconified
4084 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4086 * Set the layer of the window.
4088 * What this means exactly will depend on the underlying engine used.
4090 * In the case of X11 backed engines, the value in @p layer has the
4091 * following meanings:
4092 * @li < 3: The window will be placed below all others.
4093 * @li > 5: The window will be placed above all others.
4094 * @li other: The window will be placed in the default layer.
4096 * @param obj The window object
4097 * @param layer The layer of the window
4099 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4101 * Get the layer of the window.
4103 * @param obj The window object
4104 * @return The layer of the window
4106 * @see elm_win_layer_set()
4108 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4110 * Set the rotation of the window.
4112 * Most engines only work with multiples of 90.
4114 * This function is used to set the orientation of the window @p obj to
4115 * match that of the screen. The window itself will be resized to adjust
4116 * to the new geometry of its contents. If you want to keep the window size,
4117 * see elm_win_rotation_with_resize_set().
4119 * @param obj The window object
4120 * @param rotation The rotation of the window, in degrees (0-360),
4121 * counter-clockwise.
4123 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4125 * Rotates the window and resizes it.
4127 * Like elm_win_rotation_set(), but it also resizes the window's contents so
4128 * that they fit inside the current window geometry.
4130 * @param obj The window object
4131 * @param layer The rotation of the window in degrees (0-360),
4132 * counter-clockwise.
4134 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4136 * Get the rotation of the window.
4138 * @param obj The window object
4139 * @return The rotation of the window in degrees (0-360)
4141 * @see elm_win_rotation_set()
4142 * @see elm_win_rotation_with_resize_set()
4144 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4146 * Set the sticky state of the window.
4148 * Hints the Window Manager that the window in @p obj should be left fixed
4149 * at its position even when the virtual desktop it's on moves or changes.
4151 * @param obj The window object
4152 * @param sticky If true, the window's sticky state is enabled
4154 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4156 * Get the sticky state of the window.
4158 * @param obj The window object
4159 * @return If true, the window's sticky state is enabled
4161 * @see elm_win_sticky_set()
4163 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4165 * Set if this window is an illume conformant window
4167 * @param obj The window object
4168 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4170 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4172 * Get if this window is an illume conformant window
4174 * @param obj The window object
4175 * @return A boolean if this window is illume conformant or not
4177 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4179 * Set a window to be an illume quickpanel window
4181 * By default window objects are not quickpanel windows.
4183 * @param obj The window object
4184 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4186 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4188 * Get if this window is a quickpanel or not
4190 * @param obj The window object
4191 * @return A boolean if this window is a quickpanel or not
4193 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4195 * Set the major priority of a quickpanel window
4197 * @param obj The window object
4198 * @param priority The major priority for this quickpanel
4200 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4202 * Get the major priority of a quickpanel window
4204 * @param obj The window object
4205 * @return The major priority of this quickpanel
4207 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4209 * Set the minor priority of a quickpanel window
4211 * @param obj The window object
4212 * @param priority The minor priority for this quickpanel
4214 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4216 * Get the minor priority of a quickpanel window
4218 * @param obj The window object
4219 * @return The minor priority of this quickpanel
4221 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4223 * Set which zone this quickpanel should appear in
4225 * @param obj The window object
4226 * @param zone The requested zone for this quickpanel
4228 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4230 * Get which zone this quickpanel should appear in
4232 * @param obj The window object
4233 * @return The requested zone for this quickpanel
4235 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4237 * Set the window to be skipped by keyboard focus
4239 * This sets the window to be skipped by normal keyboard input. This means
4240 * a window manager will be asked to not focus this window as well as omit
4241 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4243 * Call this and enable it on a window BEFORE you show it for the first time,
4244 * otherwise it may have no effect.
4246 * Use this for windows that have only output information or might only be
4247 * interacted with by the mouse or fingers, and never for typing input.
4248 * Be careful that this may have side-effects like making the window
4249 * non-accessible in some cases unless the window is specially handled. Use
4252 * @param obj The window object
4253 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4255 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4257 * Send a command to the windowing environment
4259 * This is intended to work in touchscreen or small screen device
4260 * environments where there is a more simplistic window management policy in
4261 * place. This uses the window object indicated to select which part of the
4262 * environment to control (the part that this window lives in), and provides
4263 * a command and an optional parameter structure (use NULL for this if not
4266 * @param obj The window object that lives in the environment to control
4267 * @param command The command to send
4268 * @param params Optional parameters for the command
4270 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4272 * Get the inlined image object handle
4274 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4275 * then the window is in fact an evas image object inlined in the parent
4276 * canvas. You can get this object (be careful to not manipulate it as it
4277 * is under control of elementary), and use it to do things like get pixel
4278 * data, save the image to a file, etc.
4280 * @param obj The window object to get the inlined image from
4281 * @return The inlined image object, or NULL if none exists
4283 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4285 * Set the enabled status for the focus highlight in a window
4287 * This function will enable or disable the focus highlight only for the
4288 * given window, regardless of the global setting for it
4290 * @param obj The window where to enable the highlight
4291 * @param enabled The enabled value for the highlight
4293 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4295 * Get the enabled value of the focus highlight for this window
4297 * @param obj The window in which to check if the focus highlight is enabled
4299 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4301 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4303 * Set the style for the focus highlight on this window
4305 * Sets the style to use for theming the highlight of focused objects on
4306 * the given window. If @p style is NULL, the default will be used.
4308 * @param obj The window where to set the style
4309 * @param style The style to set
4311 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4313 * Get the style set for the focus highlight object
4315 * Gets the style set for this windows highilght object, or NULL if none
4318 * @param obj The window to retrieve the highlights style from
4320 * @return The style set or NULL if none was. Default is used in that case.
4322 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4323 EAPI void elm_win_indicator_state_set(Evas_Object *obj, int show_state);
4324 EAPI int elm_win_indicator_state_get(Evas_Object *obj);
4326 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4327 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4328 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4329 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4330 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4331 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4332 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4334 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4335 * (blank mouse, private mouse obj, defaultmouse)
4339 * Sets the keyboard mode of the window.
4341 * @param obj The window object
4342 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4344 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4346 * Gets the keyboard mode of the window.
4348 * @param obj The window object
4349 * @return The mode, one of #Elm_Win_Keyboard_Mode
4351 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4353 * Sets whether the window is a keyboard.
4355 * @param obj The window object
4356 * @param is_keyboard If true, the window is a virtual keyboard
4358 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4360 * Gets whether the window is a keyboard.
4362 * @param obj The window object
4363 * @return If the window is a virtual keyboard
4365 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4368 * Get the screen position of a window.
4370 * @param obj The window object
4371 * @param x The int to store the x coordinate to
4372 * @param y The int to store the y coordinate to
4374 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4380 * @defgroup Inwin Inwin
4382 * @image html img/widget/inwin/preview-00.png
4383 * @image latex img/widget/inwin/preview-00.eps
4384 * @image html img/widget/inwin/preview-01.png
4385 * @image latex img/widget/inwin/preview-01.eps
4386 * @image html img/widget/inwin/preview-02.png
4387 * @image latex img/widget/inwin/preview-02.eps
4389 * An inwin is a window inside a window that is useful for a quick popup.
4390 * It does not hover.
4392 * It works by creating an object that will occupy the entire window, so it
4393 * must be created using an @ref Win "elm_win" as parent only. The inwin
4394 * object can be hidden or restacked below every other object if it's
4395 * needed to show what's behind it without destroying it. If this is done,
4396 * the elm_win_inwin_activate() function can be used to bring it back to
4397 * full visibility again.
4399 * There are three styles available in the default theme. These are:
4400 * @li default: The inwin is sized to take over most of the window it's
4402 * @li minimal: The size of the inwin will be the minimum necessary to show
4404 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4405 * possible, but it's sized vertically the most it needs to fit its\
4408 * Some examples of Inwin can be found in the following:
4409 * @li @ref inwin_example_01
4414 * Adds an inwin to the current window
4416 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4417 * Never call this function with anything other than the top-most window
4418 * as its parameter, unless you are fond of undefined behavior.
4420 * After creating the object, the widget will set itself as resize object
4421 * for the window with elm_win_resize_object_add(), so when shown it will
4422 * appear to cover almost the entire window (how much of it depends on its
4423 * content and the style used). It must not be added into other container
4424 * objects and it needs not be moved or resized manually.
4426 * @param parent The parent object
4427 * @return The new object or NULL if it cannot be created
4429 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4431 * Activates an inwin object, ensuring its visibility
4433 * This function will make sure that the inwin @p obj is completely visible
4434 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4435 * to the front. It also sets the keyboard focus to it, which will be passed
4438 * The object's theme will also receive the signal "elm,action,show" with
4441 * @param obj The inwin to activate
4443 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4445 * Set the content of an inwin object.
4447 * Once the content object is set, a previously set one will be deleted.
4448 * If you want to keep that old content object, use the
4449 * elm_win_inwin_content_unset() function.
4451 * @param obj The inwin object
4452 * @param content The object to set as content
4454 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4456 * Get the content of an inwin object.
4458 * Return the content object which is set for this widget.
4460 * The returned object is valid as long as the inwin is still alive and no
4461 * other content is set on it. Deleting the object will notify the inwin
4462 * about it and this one will be left empty.
4464 * If you need to remove an inwin's content to be reused somewhere else,
4465 * see elm_win_inwin_content_unset().
4467 * @param obj The inwin object
4468 * @return The content that is being used
4470 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4472 * Unset the content of an inwin object.
4474 * Unparent and return the content object which was set for this widget.
4476 * @param obj The inwin object
4477 * @return The content that was being used
4479 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4483 /* X specific calls - won't work on non-x engines (return 0) */
4486 * Get the Ecore_X_Window of an Evas_Object
4488 * @param obj The object
4490 * @return The Ecore_X_Window of @p obj
4494 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4496 /* smart callbacks called:
4497 * "delete,request" - the user requested to delete the window
4498 * "focus,in" - window got focus
4499 * "focus,out" - window lost focus
4500 * "moved" - window that holds the canvas was moved
4506 * @image html img/widget/bg/preview-00.png
4507 * @image latex img/widget/bg/preview-00.eps
4509 * @brief Background object, used for setting a solid color, image or Edje
4510 * group as background to a window or any container object.
4512 * The bg object is used for setting a solid background to a window or
4513 * packing into any container object. It works just like an image, but has
4514 * some properties useful to a background, like setting it to tiled,
4515 * centered, scaled or stretched.
4517 * Default contents parts of the bg widget that you can use for are:
4518 * @li "elm.swallow.content" - overlay of the bg
4520 * Here is some sample code using it:
4521 * @li @ref bg_01_example_page
4522 * @li @ref bg_02_example_page
4523 * @li @ref bg_03_example_page
4527 typedef enum _Elm_Bg_Option
4529 ELM_BG_OPTION_CENTER, /**< center the background */
4530 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4531 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4532 ELM_BG_OPTION_TILE /**< tile background at its original size */
4536 * Add a new background to the parent
4538 * @param parent The parent object
4539 * @return The new object or NULL if it cannot be created
4543 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4546 * Set the file (image or edje) used for the background
4548 * @param obj The bg object
4549 * @param file The file path
4550 * @param group Optional key (group in Edje) within the file
4552 * This sets the image file used in the background object. The image (or edje)
4553 * will be stretched (retaining aspect if its an image file) to completely fill
4554 * the bg object. This may mean some parts are not visible.
4556 * @note Once the image of @p obj is set, a previously set one will be deleted,
4557 * even if @p file is NULL.
4561 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4564 * Get the file (image or edje) used for the background
4566 * @param obj The bg object
4567 * @param file The file path
4568 * @param group Optional key (group in Edje) within the file
4572 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4575 * Set the option used for the background image
4577 * @param obj The bg object
4578 * @param option The desired background option (TILE, SCALE)
4580 * This sets the option used for manipulating the display of the background
4581 * image. The image can be tiled or scaled.
4585 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4588 * Get the option used for the background image
4590 * @param obj The bg object
4591 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4595 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4597 * Set the option used for the background color
4599 * @param obj The bg object
4604 * This sets the color used for the background rectangle. Its range goes
4609 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4611 * Get the option used for the background color
4613 * @param obj The bg object
4620 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4623 * Set the overlay object used for the background object.
4625 * @param obj The bg object
4626 * @param overlay The overlay object
4628 * This provides a way for elm_bg to have an 'overlay' that will be on top
4629 * of the bg. Once the over object is set, a previously set one will be
4630 * deleted, even if you set the new one to NULL. If you want to keep that
4631 * old content object, use the elm_bg_overlay_unset() function.
4633 * @deprecated use elm_object_content_set() instead
4638 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4641 * Get the overlay object used for the background object.
4643 * @param obj The bg object
4644 * @return The content that is being used
4646 * Return the content object which is set for this widget
4648 * @deprecated use elm_object_content_get() instead
4652 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4655 * Get the overlay object used for the background object.
4657 * @param obj The bg object
4658 * @return The content that was being used
4660 * Unparent and return the overlay object which was set for this widget
4662 * @deprecated use elm_object_content_unset() instead
4666 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4669 * Set the size of the pixmap representation of the image.
4671 * This option just makes sense if an image is going to be set in the bg.
4673 * @param obj The bg object
4674 * @param w The new width of the image pixmap representation.
4675 * @param h The new height of the image pixmap representation.
4677 * This function sets a new size for pixmap representation of the given bg
4678 * image. It allows the image to be loaded already in the specified size,
4679 * reducing the memory usage and load time when loading a big image with load
4680 * size set to a smaller size.
4682 * NOTE: this is just a hint, the real size of the pixmap may differ
4683 * depending on the type of image being loaded, being bigger than requested.
4687 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4688 /* smart callbacks called:
4692 * @defgroup Icon Icon
4694 * @image html img/widget/icon/preview-00.png
4695 * @image latex img/widget/icon/preview-00.eps
4697 * An object that provides standard icon images (delete, edit, arrows, etc.)
4698 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4700 * The icon image requested can be in the elementary theme, or in the
4701 * freedesktop.org paths. It's possible to set the order of preference from
4702 * where the image will be used.
4704 * This API is very similar to @ref Image, but with ready to use images.
4706 * Default images provided by the theme are described below.
4708 * The first list contains icons that were first intended to be used in
4709 * toolbars, but can be used in many other places too:
4725 * Now some icons that were designed to be used in menus (but again, you can
4726 * use them anywhere else):
4731 * @li menu/arrow_down
4732 * @li menu/arrow_left
4733 * @li menu/arrow_right
4742 * And here we have some media player specific icons:
4743 * @li media_player/forward
4744 * @li media_player/info
4745 * @li media_player/next
4746 * @li media_player/pause
4747 * @li media_player/play
4748 * @li media_player/prev
4749 * @li media_player/rewind
4750 * @li media_player/stop
4752 * Signals that you can add callbacks for are:
4754 * "clicked" - This is called when a user has clicked the icon
4756 * An example of usage for this API follows:
4757 * @li @ref tutorial_icon
4765 typedef enum _Elm_Icon_Type
4772 * @enum _Elm_Icon_Lookup_Order
4773 * @typedef Elm_Icon_Lookup_Order
4775 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4776 * theme, FDO paths, or both?
4780 typedef enum _Elm_Icon_Lookup_Order
4782 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4783 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4784 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4785 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4786 } Elm_Icon_Lookup_Order;
4789 * Add a new icon object to the parent.
4791 * @param parent The parent object
4792 * @return The new object or NULL if it cannot be created
4794 * @see elm_icon_file_set()
4798 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4800 * Set the file that will be used as icon.
4802 * @param obj The icon object
4803 * @param file The path to file that will be used as icon image
4804 * @param group The group that the icon belongs to an edje file
4806 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4808 * @note The icon image set by this function can be changed by
4809 * elm_icon_standard_set().
4811 * @see elm_icon_file_get()
4815 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4817 * Set a location in memory to be used as an icon
4819 * @param obj The icon object
4820 * @param img The binary data that will be used as an image
4821 * @param size The size of binary data @p img
4822 * @param format Optional format of @p img to pass to the image loader
4823 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4825 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4827 * @note The icon image set by this function can be changed by
4828 * elm_icon_standard_set().
4832 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);
4834 * Get the file that will be used as icon.
4836 * @param obj The icon object
4837 * @param file The path to file that will be used as the icon image
4838 * @param group The group that the icon belongs to, in edje file
4840 * @see elm_icon_file_set()
4844 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4845 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4847 * Set the icon by icon standards names.
4849 * @param obj The icon object
4850 * @param name The icon name
4852 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4854 * For example, freedesktop.org defines standard icon names such as "home",
4855 * "network", etc. There can be different icon sets to match those icon
4856 * keys. The @p name given as parameter is one of these "keys", and will be
4857 * used to look in the freedesktop.org paths and elementary theme. One can
4858 * change the lookup order with elm_icon_order_lookup_set().
4860 * If name is not found in any of the expected locations and it is the
4861 * absolute path of an image file, this image will be used.
4863 * @note The icon image set by this function can be changed by
4864 * elm_icon_file_set().
4866 * @see elm_icon_standard_get()
4867 * @see elm_icon_file_set()
4871 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4873 * Get the icon name set by icon standard names.
4875 * @param obj The icon object
4876 * @return The icon name
4878 * If the icon image was set using elm_icon_file_set() instead of
4879 * elm_icon_standard_set(), then this function will return @c NULL.
4881 * @see elm_icon_standard_set()
4885 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4887 * Set the smooth scaling for an icon object.
4889 * @param obj The icon object
4890 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4891 * otherwise. Default is @c EINA_TRUE.
4893 * Set the scaling algorithm to be used when scaling the icon image. Smooth
4894 * scaling provides a better resulting image, but is slower.
4896 * The smooth scaling should be disabled when making animations that change
4897 * the icon size, since they will be faster. Animations that don't require
4898 * resizing of the icon can keep the smooth scaling enabled (even if the icon
4899 * is already scaled, since the scaled icon image will be cached).
4901 * @see elm_icon_smooth_get()
4905 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4907 * Get whether smooth scaling is enabled for an icon object.
4909 * @param obj The icon object
4910 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4912 * @see elm_icon_smooth_set()
4916 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4918 * Disable scaling of this object.
4920 * @param obj The icon object.
4921 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4922 * otherwise. Default is @c EINA_FALSE.
4924 * This function disables scaling of the icon object through the function
4925 * elm_object_scale_set(). However, this does not affect the object
4926 * size/resize in any way. For that effect, take a look at
4927 * elm_icon_scale_set().
4929 * @see elm_icon_no_scale_get()
4930 * @see elm_icon_scale_set()
4931 * @see elm_object_scale_set()
4935 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4937 * Get whether scaling is disabled on the object.
4939 * @param obj The icon object
4940 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4942 * @see elm_icon_no_scale_set()
4946 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4948 * Set if the object is (up/down) resizable.
4950 * @param obj The icon object
4951 * @param scale_up A bool to set if the object is resizable up. Default is
4953 * @param scale_down A bool to set if the object is resizable down. Default
4956 * This function limits the icon object resize ability. If @p scale_up is set to
4957 * @c EINA_FALSE, the object can't have its height or width resized to a value
4958 * higher than the original icon size. Same is valid for @p scale_down.
4960 * @see elm_icon_scale_get()
4964 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4966 * Get if the object is (up/down) resizable.
4968 * @param obj The icon object
4969 * @param scale_up A bool to set if the object is resizable up
4970 * @param scale_down A bool to set if the object is resizable down
4972 * @see elm_icon_scale_set()
4976 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4978 * Get the object's image size
4980 * @param obj The icon object
4981 * @param w A pointer to store the width in
4982 * @param h A pointer to store the height in
4986 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4988 * Set if the icon fill the entire object area.
4990 * @param obj The icon object
4991 * @param fill_outside @c EINA_TRUE if the object is filled outside,
4992 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4994 * When the icon object is resized to a different aspect ratio from the
4995 * original icon image, the icon image will still keep its aspect. This flag
4996 * tells how the image should fill the object's area. They are: keep the
4997 * entire icon inside the limits of height and width of the object (@p
4998 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4999 * of the object, and the icon will fill the entire object (@p fill_outside
5002 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5003 * retain property to false. Thus, the icon image will always keep its
5004 * original aspect ratio.
5006 * @see elm_icon_fill_outside_get()
5007 * @see elm_image_fill_outside_set()
5011 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5013 * Get if the object is filled outside.
5015 * @param obj The icon object
5016 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5018 * @see elm_icon_fill_outside_set()
5022 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5024 * Set the prescale size for the icon.
5026 * @param obj The icon object
5027 * @param size The prescale size. This value is used for both width and
5030 * This function sets a new size for pixmap representation of the given
5031 * icon. It allows the icon to be loaded already in the specified size,
5032 * reducing the memory usage and load time when loading a big icon with load
5033 * size set to a smaller size.
5035 * It's equivalent to the elm_bg_load_size_set() function for bg.
5037 * @note this is just a hint, the real size of the pixmap may differ
5038 * depending on the type of icon being loaded, being bigger than requested.
5040 * @see elm_icon_prescale_get()
5041 * @see elm_bg_load_size_set()
5045 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5047 * Get the prescale size for the icon.
5049 * @param obj The icon object
5050 * @return The prescale size
5052 * @see elm_icon_prescale_set()
5056 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5058 * Gets the image object of the icon. DO NOT MODIFY THIS.
5060 * @param obj The icon object
5061 * @return The internal icon object
5065 EAPI Evas_Object *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5067 * Sets the icon lookup order used by elm_icon_standard_set().
5069 * @param obj The icon object
5070 * @param order The icon lookup order (can be one of
5071 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5072 * or ELM_ICON_LOOKUP_THEME)
5074 * @see elm_icon_order_lookup_get()
5075 * @see Elm_Icon_Lookup_Order
5079 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5081 * Gets the icon lookup order.
5083 * @param obj The icon object
5084 * @return The icon lookup order
5086 * @see elm_icon_order_lookup_set()
5087 * @see Elm_Icon_Lookup_Order
5091 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5093 * Enable or disable preloading of the icon
5095 * @param obj The icon object
5096 * @param disable If EINA_TRUE, preloading will be disabled
5099 EAPI void elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5101 * Get if the icon supports animation or not.
5103 * @param obj The icon object
5104 * @return @c EINA_TRUE if the icon supports animation,
5105 * @c EINA_FALSE otherwise.
5107 * Return if this elm icon's image can be animated. Currently Evas only
5108 * supports gif animation. If the return value is EINA_FALSE, other
5109 * elm_icon_animated_XXX APIs won't work.
5112 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5114 * Set animation mode of the icon.
5116 * @param obj The icon object
5117 * @param anim @c EINA_TRUE if the object do animation job,
5118 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5120 * Since the default animation mode is set to EINA_FALSE,
5121 * the icon is shown without animation.
5122 * This might be desirable when the application developer wants to show
5123 * a snapshot of the animated icon.
5124 * Set it to EINA_TRUE when the icon needs to be animated.
5127 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5129 * Get animation mode of the icon.
5131 * @param obj The icon object
5132 * @return The animation mode of the icon object
5133 * @see elm_icon_animated_set
5136 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5138 * Set animation play mode of the icon.
5140 * @param obj The icon object
5141 * @param play @c EINA_TRUE the object play animation images,
5142 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5144 * To play elm icon's animation, set play to EINA_TURE.
5145 * For example, you make gif player using this set/get API and click event.
5147 * 1. Click event occurs
5148 * 2. Check play flag using elm_icon_animaged_play_get
5149 * 3. If elm icon was playing, set play to EINA_FALSE.
5150 * Then animation will be stopped and vice versa
5153 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5155 * Get animation play mode of the icon.
5157 * @param obj The icon object
5158 * @return The play mode of the icon object
5160 * @see elm_icon_animated_play_get
5163 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5165 /* compatibility code to avoid API and ABI breaks */
5166 EINA_DEPRECATED EAPI extern inline void elm_icon_anim_set(Evas_Object *obj, Eina_Bool animated)
5168 elm_icon_animated_set(obj, animated);
5171 EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_get(const Evas_Object *obj)
5173 return elm_icon_animated_get(obj);
5176 EINA_DEPRECATED EAPI extern inline void elm_icon_anim_play_set(Evas_Object *obj, Eina_Bool play)
5178 elm_icon_animated_play_set(obj, play);
5181 EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_play_get(const Evas_Object *obj)
5183 return elm_icon_animated_play_get(obj);
5191 * @defgroup Image Image
5193 * @image html img/widget/image/preview-00.png
5194 * @image latex img/widget/image/preview-00.eps
5197 * An object that allows one to load an image file to it. It can be used
5198 * anywhere like any other elementary widget.
5200 * This widget provides most of the functionality provided from @ref Bg or @ref
5201 * Icon, but with a slightly different API (use the one that fits better your
5204 * The features not provided by those two other image widgets are:
5205 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5206 * @li change the object orientation with elm_image_orient_set();
5207 * @li and turning the image editable with elm_image_editable_set().
5209 * Signals that you can add callbacks for are:
5211 * @li @c "clicked" - This is called when a user has clicked the image
5213 * An example of usage for this API follows:
5214 * @li @ref tutorial_image
5223 * @enum _Elm_Image_Orient
5224 * @typedef Elm_Image_Orient
5226 * Possible orientation options for elm_image_orient_set().
5228 * @image html elm_image_orient_set.png
5229 * @image latex elm_image_orient_set.eps width=\textwidth
5233 typedef enum _Elm_Image_Orient
5235 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5236 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5237 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5238 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5239 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5240 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5241 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5242 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5246 * Add a new image to the parent.
5248 * @param parent The parent object
5249 * @return The new object or NULL if it cannot be created
5251 * @see elm_image_file_set()
5255 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5257 * Set the file that will be used as image.
5259 * @param obj The image object
5260 * @param file The path to file that will be used as image
5261 * @param group The group that the image belongs in edje file (if it's an
5264 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5266 * @see elm_image_file_get()
5270 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5272 * Get the file that will be used as image.
5274 * @param obj The image object
5275 * @param file The path to file
5276 * @param group The group that the image belongs in edje file
5278 * @see elm_image_file_set()
5282 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5284 * Set the smooth effect for an image.
5286 * @param obj The image object
5287 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5288 * otherwise. Default is @c EINA_TRUE.
5290 * Set the scaling algorithm to be used when scaling the image. Smooth
5291 * scaling provides a better resulting image, but is slower.
5293 * The smooth scaling should be disabled when making animations that change
5294 * the image size, since it will be faster. Animations that don't require
5295 * resizing of the image can keep the smooth scaling enabled (even if the
5296 * image is already scaled, since the scaled image will be cached).
5298 * @see elm_image_smooth_get()
5302 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5304 * Get the smooth effect for an image.
5306 * @param obj The image object
5307 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5309 * @see elm_image_smooth_get()
5313 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5316 * Gets the current size of the image.
5318 * @param obj The image object.
5319 * @param w Pointer to store width, or NULL.
5320 * @param h Pointer to store height, or NULL.
5322 * This is the real size of the image, not the size of the object.
5324 * On error, neither w or h will be written.
5328 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5330 * Disable scaling of this object.
5332 * @param obj The image object.
5333 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5334 * otherwise. Default is @c EINA_FALSE.
5336 * This function disables scaling of the elm_image widget through the
5337 * function elm_object_scale_set(). However, this does not affect the widget
5338 * size/resize in any way. For that effect, take a look at
5339 * elm_image_scale_set().
5341 * @see elm_image_no_scale_get()
5342 * @see elm_image_scale_set()
5343 * @see elm_object_scale_set()
5347 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5349 * Get whether scaling is disabled on the object.
5351 * @param obj The image object
5352 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5354 * @see elm_image_no_scale_set()
5358 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5360 * Set if the object is (up/down) resizable.
5362 * @param obj The image object
5363 * @param scale_up A bool to set if the object is resizable up. Default is
5365 * @param scale_down A bool to set if the object is resizable down. Default
5368 * This function limits the image resize ability. If @p scale_up is set to
5369 * @c EINA_FALSE, the object can't have its height or width resized to a value
5370 * higher than the original image size. Same is valid for @p scale_down.
5372 * @see elm_image_scale_get()
5376 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5378 * Get if the object is (up/down) resizable.
5380 * @param obj The image object
5381 * @param scale_up A bool to set if the object is resizable up
5382 * @param scale_down A bool to set if the object is resizable down
5384 * @see elm_image_scale_set()
5388 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5390 * Set if the image fills the entire object area, when keeping the aspect ratio.
5392 * @param obj The image object
5393 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5394 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5396 * When the image should keep its aspect ratio even if resized to another
5397 * aspect ratio, there are two possibilities to resize it: keep the entire
5398 * image inside the limits of height and width of the object (@p fill_outside
5399 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5400 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5402 * @note This option will have no effect if
5403 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5405 * @see elm_image_fill_outside_get()
5406 * @see elm_image_aspect_ratio_retained_set()
5410 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5412 * Get if the object is filled outside
5414 * @param obj The image object
5415 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5417 * @see elm_image_fill_outside_set()
5421 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5423 * Set the prescale size for the image
5425 * @param obj The image object
5426 * @param size The prescale size. This value is used for both width and
5429 * This function sets a new size for pixmap representation of the given
5430 * image. It allows the image to be loaded already in the specified size,
5431 * reducing the memory usage and load time when loading a big image with load
5432 * size set to a smaller size.
5434 * It's equivalent to the elm_bg_load_size_set() function for bg.
5436 * @note this is just a hint, the real size of the pixmap may differ
5437 * depending on the type of image being loaded, being bigger than requested.
5439 * @see elm_image_prescale_get()
5440 * @see elm_bg_load_size_set()
5444 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5446 * Get the prescale size for the image
5448 * @param obj The image object
5449 * @return The prescale size
5451 * @see elm_image_prescale_set()
5455 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5457 * Set the image orientation.
5459 * @param obj The image object
5460 * @param orient The image orientation @ref Elm_Image_Orient
5461 * Default is #ELM_IMAGE_ORIENT_NONE.
5463 * This function allows to rotate or flip the given image.
5465 * @see elm_image_orient_get()
5466 * @see @ref Elm_Image_Orient
5470 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5472 * Get the image orientation.
5474 * @param obj The image object
5475 * @return The image orientation @ref Elm_Image_Orient
5477 * @see elm_image_orient_set()
5478 * @see @ref Elm_Image_Orient
5482 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5484 * Make the image 'editable'.
5486 * @param obj Image object.
5487 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5489 * This means the image is a valid drag target for drag and drop, and can be
5490 * cut or pasted too.
5494 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5496 * Check if the image 'editable'.
5498 * @param obj Image object.
5499 * @return Editability.
5501 * A return value of EINA_TRUE means the image is a valid drag target
5502 * for drag and drop, and can be cut or pasted too.
5506 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5508 * Get the basic Evas_Image object from this object (widget).
5510 * @param obj The image object to get the inlined image from
5511 * @return The inlined image object, or NULL if none exists
5513 * This function allows one to get the underlying @c Evas_Object of type
5514 * Image from this elementary widget. It can be useful to do things like get
5515 * the pixel data, save the image to a file, etc.
5517 * @note Be careful to not manipulate it, as it is under control of
5522 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5524 * Set whether the original aspect ratio of the image should be kept on resize.
5526 * @param obj The image object.
5527 * @param retained @c EINA_TRUE if the image should retain the aspect,
5528 * @c EINA_FALSE otherwise.
5530 * The original aspect ratio (width / height) of the image is usually
5531 * distorted to match the object's size. Enabling this option will retain
5532 * this original aspect, and the way that the image is fit into the object's
5533 * area depends on the option set by elm_image_fill_outside_set().
5535 * @see elm_image_aspect_ratio_retained_get()
5536 * @see elm_image_fill_outside_set()
5540 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5542 * Get if the object retains the original aspect ratio.
5544 * @param obj The image object.
5545 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5550 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5557 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5559 /* old API compatibility */
5560 typedef Elm_GLView_Func_Cb Elm_GLView_Func;
5562 typedef enum _Elm_GLView_Mode
5564 ELM_GLVIEW_ALPHA = 1,
5565 ELM_GLVIEW_DEPTH = 2,
5566 ELM_GLVIEW_STENCIL = 4
5570 * Defines a policy for the glview resizing.
5572 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5574 typedef enum _Elm_GLView_Resize_Policy
5576 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5577 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5578 } Elm_GLView_Resize_Policy;
5580 typedef enum _Elm_GLView_Render_Policy
5582 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5583 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5584 } Elm_GLView_Render_Policy;
5589 * A simple GLView widget that allows GL rendering.
5591 * Signals that you can add callbacks for are:
5597 * Add a new glview to the parent
5599 * @param parent The parent object
5600 * @return The new object or NULL if it cannot be created
5604 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5607 * Sets the size of the glview
5609 * @param obj The glview object
5610 * @param width width of the glview object
5611 * @param height height of the glview object
5615 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5618 * Gets the size of the glview.
5620 * @param obj The glview object
5621 * @param width width of the glview object
5622 * @param height height of the glview object
5624 * Note that this function returns the actual image size of the
5625 * glview. This means that when the scale policy is set to
5626 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5631 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5634 * Gets the gl api struct for gl rendering
5636 * @param obj The glview object
5637 * @return The api object or NULL if it cannot be created
5641 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5644 * Set the mode of the GLView. Supports Three simple modes.
5646 * @param obj The glview object
5647 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5648 * @return True if set properly.
5652 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5655 * Set the resize policy for the glview object.
5657 * @param obj The glview object.
5658 * @param policy The scaling policy.
5660 * By default, the resize policy is set to
5661 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5662 * destroys the previous surface and recreates the newly specified
5663 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5664 * however, glview only scales the image object and not the underlying
5669 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5672 * Set the render policy for the glview object.
5674 * @param obj The glview object.
5675 * @param policy The render policy.
5677 * By default, the render policy is set to
5678 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5679 * that during the render loop, glview is only redrawn if it needs
5680 * to be redrawn. (i.e. When it is visible) If the policy is set to
5681 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5682 * whether it is visible/need redrawing or not.
5686 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5689 * Set the init function that runs once in the main loop.
5691 * @param obj The glview object.
5692 * @param func The init function to be registered.
5694 * The registered init function gets called once during the render loop.
5698 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5701 * Set the render function that runs in the main loop.
5703 * @param obj The glview object.
5704 * @param func The delete function to be registered.
5706 * The registered del function gets called when GLView object is deleted.
5710 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5713 * Set the resize function that gets called when resize happens.
5715 * @param obj The glview object.
5716 * @param func The resize function to be registered.
5720 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5723 * Set the render function that runs in the main loop.
5725 * @param obj The glview object.
5726 * @param func The render function to be registered.
5730 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5733 * Notifies that there has been changes in the GLView.
5735 * @param obj The glview object.
5739 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5749 * @image html img/widget/box/preview-00.png
5750 * @image latex img/widget/box/preview-00.eps width=\textwidth
5752 * @image html img/box.png
5753 * @image latex img/box.eps width=\textwidth
5755 * A box arranges objects in a linear fashion, governed by a layout function
5756 * that defines the details of this arrangement.
5758 * By default, the box will use an internal function to set the layout to
5759 * a single row, either vertical or horizontal. This layout is affected
5760 * by a number of parameters, such as the homogeneous flag set by
5761 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5762 * elm_box_align_set() and the hints set to each object in the box.
5764 * For this default layout, it's possible to change the orientation with
5765 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5766 * placing its elements ordered from top to bottom. When horizontal is set,
5767 * the order will go from left to right. If the box is set to be
5768 * homogeneous, every object in it will be assigned the same space, that
5769 * of the largest object. Padding can be used to set some spacing between
5770 * the cell given to each object. The alignment of the box, set with
5771 * elm_box_align_set(), determines how the bounding box of all the elements
5772 * will be placed within the space given to the box widget itself.
5774 * The size hints of each object also affect how they are placed and sized
5775 * within the box. evas_object_size_hint_min_set() will give the minimum
5776 * size the object can have, and the box will use it as the basis for all
5777 * latter calculations. Elementary widgets set their own minimum size as
5778 * needed, so there's rarely any need to use it manually.
5780 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5781 * used to tell whether the object will be allocated the minimum size it
5782 * needs or if the space given to it should be expanded. It's important
5783 * to realize that expanding the size given to the object is not the same
5784 * thing as resizing the object. It could very well end being a small
5785 * widget floating in a much larger empty space. If not set, the weight
5786 * for objects will normally be 0.0 for both axis, meaning the widget will
5787 * not be expanded. To take as much space possible, set the weight to
5788 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5790 * Besides how much space each object is allocated, it's possible to control
5791 * how the widget will be placed within that space using
5792 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5793 * for both axis, meaning the object will be centered, but any value from
5794 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5795 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5796 * is -1.0, means the object will be resized to fill the entire space it
5799 * In addition, customized functions to define the layout can be set, which
5800 * allow the application developer to organize the objects within the box
5801 * in any number of ways.
5803 * The special elm_box_layout_transition() function can be used
5804 * to switch from one layout to another, animating the motion of the
5805 * children of the box.
5807 * @note Objects should not be added to box objects using _add() calls.
5809 * Some examples on how to use boxes follow:
5810 * @li @ref box_example_01
5811 * @li @ref box_example_02
5816 * @typedef Elm_Box_Transition
5818 * Opaque handler containing the parameters to perform an animated
5819 * transition of the layout the box uses.
5821 * @see elm_box_transition_new()
5822 * @see elm_box_layout_set()
5823 * @see elm_box_layout_transition()
5825 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5828 * Add a new box to the parent
5830 * By default, the box will be in vertical mode and non-homogeneous.
5832 * @param parent The parent object
5833 * @return The new object or NULL if it cannot be created
5835 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5837 * Set the horizontal orientation
5839 * By default, box object arranges their contents vertically from top to
5841 * By calling this function with @p horizontal as EINA_TRUE, the box will
5842 * become horizontal, arranging contents from left to right.
5844 * @note This flag is ignored if a custom layout function is set.
5846 * @param obj The box object
5847 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5848 * EINA_FALSE = vertical)
5850 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5852 * Get the horizontal orientation
5854 * @param obj The box object
5855 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5857 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5859 * Set the box to arrange its children homogeneously
5861 * If enabled, homogeneous layout makes all items the same size, according
5862 * to the size of the largest of its children.
5864 * @note This flag is ignored if a custom layout function is set.
5866 * @param obj The box object
5867 * @param homogeneous The homogeneous flag
5869 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5871 * Get whether the box is using homogeneous mode or not
5873 * @param obj The box object
5874 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5876 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5877 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5878 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5880 * Add an object to the beginning of the pack list
5882 * Pack @p subobj into the box @p obj, placing it first in the list of
5883 * children objects. The actual position the object will get on screen
5884 * depends on the layout used. If no custom layout is set, it will be at
5885 * the top or left, depending if the box is vertical or horizontal,
5888 * @param obj The box object
5889 * @param subobj The object to add to the box
5891 * @see elm_box_pack_end()
5892 * @see elm_box_pack_before()
5893 * @see elm_box_pack_after()
5894 * @see elm_box_unpack()
5895 * @see elm_box_unpack_all()
5896 * @see elm_box_clear()
5898 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5900 * Add an object at the end of the pack list
5902 * Pack @p subobj into the box @p obj, placing it last in the list of
5903 * children objects. The actual position the object will get on screen
5904 * depends on the layout used. If no custom layout is set, it will be at
5905 * the bottom or right, depending if the box is vertical or horizontal,
5908 * @param obj The box object
5909 * @param subobj The object to add to the box
5911 * @see elm_box_pack_start()
5912 * @see elm_box_pack_before()
5913 * @see elm_box_pack_after()
5914 * @see elm_box_unpack()
5915 * @see elm_box_unpack_all()
5916 * @see elm_box_clear()
5918 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5920 * Adds an object to the box before the indicated object
5922 * This will add the @p subobj to the box indicated before the object
5923 * indicated with @p before. If @p before is not already in the box, results
5924 * are undefined. Before means either to the left of the indicated object or
5925 * above it depending on orientation.
5927 * @param obj The box object
5928 * @param subobj The object to add to the box
5929 * @param before The object before which to add it
5931 * @see elm_box_pack_start()
5932 * @see elm_box_pack_end()
5933 * @see elm_box_pack_after()
5934 * @see elm_box_unpack()
5935 * @see elm_box_unpack_all()
5936 * @see elm_box_clear()
5938 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5940 * Adds an object to the box after the indicated object
5942 * This will add the @p subobj to the box indicated after the object
5943 * indicated with @p after. If @p after is not already in the box, results
5944 * are undefined. After means either to the right of the indicated object or
5945 * below it depending on orientation.
5947 * @param obj The box object
5948 * @param subobj The object to add to the box
5949 * @param after The object after which to add it
5951 * @see elm_box_pack_start()
5952 * @see elm_box_pack_end()
5953 * @see elm_box_pack_before()
5954 * @see elm_box_unpack()
5955 * @see elm_box_unpack_all()
5956 * @see elm_box_clear()
5958 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5960 * Clear the box of all children
5962 * Remove all the elements contained by the box, deleting the respective
5965 * @param obj The box object
5967 * @see elm_box_unpack()
5968 * @see elm_box_unpack_all()
5970 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5974 * Remove the object given by @p subobj from the box @p obj without
5977 * @param obj The box object
5979 * @see elm_box_unpack_all()
5980 * @see elm_box_clear()
5982 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5984 * Remove all items from the box, without deleting them
5986 * Clear the box from all children, but don't delete the respective objects.
5987 * If no other references of the box children exist, the objects will never
5988 * be deleted, and thus the application will leak the memory. Make sure
5989 * when using this function that you hold a reference to all the objects
5990 * in the box @p obj.
5992 * @param obj The box object
5994 * @see elm_box_clear()
5995 * @see elm_box_unpack()
5997 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5999 * Retrieve a list of the objects packed into the box
6001 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
6002 * The order of the list corresponds to the packing order the box uses.
6004 * You must free this list with eina_list_free() once you are done with it.
6006 * @param obj The box object
6008 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6010 * Set the space (padding) between the box's elements.
6012 * Extra space in pixels that will be added between a box child and its
6013 * neighbors after its containing cell has been calculated. This padding
6014 * is set for all elements in the box, besides any possible padding that
6015 * individual elements may have through their size hints.
6017 * @param obj The box object
6018 * @param horizontal The horizontal space between elements
6019 * @param vertical The vertical space between elements
6021 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
6023 * Get the space (padding) between the box's elements.
6025 * @param obj The box object
6026 * @param horizontal The horizontal space between elements
6027 * @param vertical The vertical space between elements
6029 * @see elm_box_padding_set()
6031 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
6033 * Set the alignment of the whole bouding box of contents.
6035 * Sets how the bounding box containing all the elements of the box, after
6036 * their sizes and position has been calculated, will be aligned within
6037 * the space given for the whole box widget.
6039 * @param obj The box object
6040 * @param horizontal The horizontal alignment of elements
6041 * @param vertical The vertical alignment of elements
6043 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6045 * Get the alignment of the whole bouding box of contents.
6047 * @param obj The box object
6048 * @param horizontal The horizontal alignment of elements
6049 * @param vertical The vertical alignment of elements
6051 * @see elm_box_align_set()
6053 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6056 * Force the box to recalculate its children packing.
6058 * If any children was added or removed, box will not calculate the
6059 * values immediately rather leaving it to the next main loop
6060 * iteration. While this is great as it would save lots of
6061 * recalculation, whenever you need to get the position of a just
6062 * added item you must force recalculate before doing so.
6064 * @param obj The box object.
6066 EAPI void elm_box_recalculate(Evas_Object *obj);
6069 * Set the layout defining function to be used by the box
6071 * Whenever anything changes that requires the box in @p obj to recalculate
6072 * the size and position of its elements, the function @p cb will be called
6073 * to determine what the layout of the children will be.
6075 * Once a custom function is set, everything about the children layout
6076 * is defined by it. The flags set by elm_box_horizontal_set() and
6077 * elm_box_homogeneous_set() no longer have any meaning, and the values
6078 * given by elm_box_padding_set() and elm_box_align_set() are up to this
6079 * layout function to decide if they are used and how. These last two
6080 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6081 * passed to @p cb. The @c Evas_Object the function receives is not the
6082 * Elementary widget, but the internal Evas Box it uses, so none of the
6083 * functions described here can be used on it.
6085 * Any of the layout functions in @c Evas can be used here, as well as the
6086 * special elm_box_layout_transition().
6088 * The final @p data argument received by @p cb is the same @p data passed
6089 * here, and the @p free_data function will be called to free it
6090 * whenever the box is destroyed or another layout function is set.
6092 * Setting @p cb to NULL will revert back to the default layout function.
6094 * @param obj The box object
6095 * @param cb The callback function used for layout
6096 * @param data Data that will be passed to layout function
6097 * @param free_data Function called to free @p data
6099 * @see elm_box_layout_transition()
6101 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);
6103 * Special layout function that animates the transition from one layout to another
6105 * Normally, when switching the layout function for a box, this will be
6106 * reflected immediately on screen on the next render, but it's also
6107 * possible to do this through an animated transition.
6109 * This is done by creating an ::Elm_Box_Transition and setting the box
6110 * layout to this function.
6114 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6115 * evas_object_box_layout_vertical, // start
6116 * NULL, // data for initial layout
6117 * NULL, // free function for initial data
6118 * evas_object_box_layout_horizontal, // end
6119 * NULL, // data for final layout
6120 * NULL, // free function for final data
6121 * anim_end, // will be called when animation ends
6122 * NULL); // data for anim_end function\
6123 * elm_box_layout_set(box, elm_box_layout_transition, t,
6124 * elm_box_transition_free);
6127 * @note This function can only be used with elm_box_layout_set(). Calling
6128 * it directly will not have the expected results.
6130 * @see elm_box_transition_new
6131 * @see elm_box_transition_free
6132 * @see elm_box_layout_set
6134 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6136 * Create a new ::Elm_Box_Transition to animate the switch of layouts
6138 * If you want to animate the change from one layout to another, you need
6139 * to set the layout function of the box to elm_box_layout_transition(),
6140 * passing as user data to it an instance of ::Elm_Box_Transition with the
6141 * necessary information to perform this animation. The free function to
6142 * set for the layout is elm_box_transition_free().
6144 * The parameters to create an ::Elm_Box_Transition sum up to how long
6145 * will it be, in seconds, a layout function to describe the initial point,
6146 * another for the final position of the children and one function to be
6147 * called when the whole animation ends. This last function is useful to
6148 * set the definitive layout for the box, usually the same as the end
6149 * layout for the animation, but could be used to start another transition.
6151 * @param start_layout The layout function that will be used to start the animation
6152 * @param start_layout_data The data to be passed the @p start_layout function
6153 * @param start_layout_free_data Function to free @p start_layout_data
6154 * @param end_layout The layout function that will be used to end the animation
6155 * @param end_layout_free_data The data to be passed the @p end_layout function
6156 * @param end_layout_free_data Function to free @p end_layout_data
6157 * @param transition_end_cb Callback function called when animation ends
6158 * @param transition_end_data Data to be passed to @p transition_end_cb
6159 * @return An instance of ::Elm_Box_Transition
6161 * @see elm_box_transition_new
6162 * @see elm_box_layout_transition
6164 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);
6166 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6168 * This function is mostly useful as the @c free_data parameter in
6169 * elm_box_layout_set() when elm_box_layout_transition().
6171 * @param data The Elm_Box_Transition instance to be freed.
6173 * @see elm_box_transition_new
6174 * @see elm_box_layout_transition
6176 EAPI void elm_box_transition_free(void *data);
6183 * @defgroup Button Button
6185 * @image html img/widget/button/preview-00.png
6186 * @image latex img/widget/button/preview-00.eps
6187 * @image html img/widget/button/preview-01.png
6188 * @image latex img/widget/button/preview-01.eps
6189 * @image html img/widget/button/preview-02.png
6190 * @image latex img/widget/button/preview-02.eps
6192 * This is a push-button. Press it and run some function. It can contain
6193 * a simple label and icon object and it also has an autorepeat feature.
6195 * This widgets emits the following signals:
6196 * @li "clicked": the user clicked the button (press/release).
6197 * @li "repeated": the user pressed the button without releasing it.
6198 * @li "pressed": button was pressed.
6199 * @li "unpressed": button was released after being pressed.
6200 * In all three cases, the @c event parameter of the callback will be
6203 * Also, defined in the default theme, the button has the following styles
6205 * @li default: a normal button.
6206 * @li anchor: Like default, but the button fades away when the mouse is not
6207 * over it, leaving only the text or icon.
6208 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6209 * continuous look across its options.
6210 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6212 * Default contents parts of the button widget that you can use for are:
6213 * @li "elm.swallow.content" - A icon of the button
6215 * Default text parts of the button widget that you can use for are:
6216 * @li "elm.text" - Label of the button
6218 * Follow through a complete example @ref button_example_01 "here".
6224 UIControlStateDefault,
6225 UIControlStateHighlighted,
6226 UIControlStateDisabled,
6227 UIControlStateFocused,
6228 UIControlStateReserved
6232 * Add a new button to the parent's canvas
6234 * @param parent The parent object
6235 * @return The new object or NULL if it cannot be created
6237 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6239 * Set the label used in the button
6241 * The passed @p label can be NULL to clean any existing text in it and
6242 * leave the button as an icon only object.
6244 * @param obj The button object
6245 * @param label The text will be written on the button
6246 * @deprecated use elm_object_text_set() instead.
6248 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6250 * Get the label set for the button
6252 * The string returned is an internal pointer and should not be freed or
6253 * altered. It will also become invalid when the button is destroyed.
6254 * The string returned, if not NULL, is a stringshare, so if you need to
6255 * keep it around even after the button is destroyed, you can use
6256 * eina_stringshare_ref().
6258 * @param obj The button object
6259 * @return The text set to the label, or NULL if nothing is set
6260 * @deprecated use elm_object_text_set() instead.
6262 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6264 * Set the label for each state of button
6266 * The passed @p label can be NULL to clean any existing text in it and
6267 * leave the button as an icon only object for the state.
6269 * @param obj The button object
6270 * @param label The text will be written on the button
6271 * @param state The state of button
6275 EINA_DEPRECATED EAPI void elm_button_label_set_for_state(Evas_Object *obj, const char *label, UIControlState state) EINA_ARG_NONNULL(1);
6277 * Get the label of button for each state
6279 * The string returned is an internal pointer and should not be freed or
6280 * altered. It will also become invalid when the button is destroyed.
6281 * The string returned, if not NULL, is a stringshare, so if you need to
6282 * keep it around even after the button is destroyed, you can use
6283 * eina_stringshare_ref().
6285 * @param obj The button object
6286 * @param state The state of button
6287 * @return The title of button for state
6291 EINA_DEPRECATED EAPI const char *elm_button_label_get_for_state(const Evas_Object *obj, UIControlState state) EINA_ARG_NONNULL(1);
6293 * Set the icon used for the button
6295 * Setting a new icon will delete any other that was previously set, making
6296 * any reference to them invalid. If you need to maintain the previous
6297 * object alive, unset it first with elm_button_icon_unset().
6299 * @param obj The button object
6300 * @param icon The icon object for the button
6301 * @deprecated use elm_object_content_set() instead.
6303 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6305 * Get the icon used for the button
6307 * Return the icon object which is set for this widget. If the button is
6308 * destroyed or another icon is set, the returned object will be deleted
6309 * and any reference to it will be invalid.
6311 * @param obj The button object
6312 * @return The icon object that is being used
6314 * @deprecated use elm_button_icon_unset() instead
6316 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6318 * Remove the icon set without deleting it and return the object
6320 * This function drops the reference the button holds of the icon object
6321 * and returns this last object. It is used in case you want to remove any
6322 * icon, or set another one, without deleting the actual object. The button
6323 * will be left without an icon set.
6325 * @param obj The button object
6326 * @return The icon object that was being used
6327 * @deprecated use elm_object_content_unset() instead.
6329 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6331 * Turn on/off the autorepeat event generated when the button is kept pressed
6333 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6334 * signal when they are clicked.
6336 * When on, keeping a button pressed will continuously emit a @c repeated
6337 * signal until the button is released. The time it takes until it starts
6338 * emitting the signal is given by
6339 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6340 * new emission by elm_button_autorepeat_gap_timeout_set().
6342 * @param obj The button object
6343 * @param on A bool to turn on/off the event
6345 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6347 * Get whether the autorepeat feature is enabled
6349 * @param obj The button object
6350 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6352 * @see elm_button_autorepeat_set()
6354 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6356 * Set the initial timeout before the autorepeat event is generated
6358 * Sets the timeout, in seconds, since the button is pressed until the
6359 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6360 * won't be any delay and the even will be fired the moment the button is
6363 * @param obj The button object
6364 * @param t Timeout in seconds
6366 * @see elm_button_autorepeat_set()
6367 * @see elm_button_autorepeat_gap_timeout_set()
6369 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6371 * Get the initial timeout before the autorepeat event is generated
6373 * @param obj The button object
6374 * @return Timeout in seconds
6376 * @see elm_button_autorepeat_initial_timeout_set()
6378 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6380 * Set the interval between each generated autorepeat event
6382 * After the first @c repeated event is fired, all subsequent ones will
6383 * follow after a delay of @p t seconds for each.
6385 * @param obj The button object
6386 * @param t Interval in seconds
6388 * @see elm_button_autorepeat_initial_timeout_set()
6390 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6392 * Get the interval between each generated autorepeat event
6394 * @param obj The button object
6395 * @return Interval in seconds
6397 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6403 * @defgroup File_Selector_Button File Selector Button
6405 * @image html img/widget/fileselector_button/preview-00.png
6406 * @image latex img/widget/fileselector_button/preview-00.eps
6407 * @image html img/widget/fileselector_button/preview-01.png
6408 * @image latex img/widget/fileselector_button/preview-01.eps
6409 * @image html img/widget/fileselector_button/preview-02.png
6410 * @image latex img/widget/fileselector_button/preview-02.eps
6412 * This is a button that, when clicked, creates an Elementary
6413 * window (or inner window) <b> with a @ref Fileselector "file
6414 * selector widget" within</b>. When a file is chosen, the (inner)
6415 * window is closed and the button emits a signal having the
6416 * selected file as it's @c event_info.
6418 * This widget encapsulates operations on its internal file
6419 * selector on its own API. There is less control over its file
6420 * selector than that one would have instatiating one directly.
6422 * The following styles are available for this button:
6425 * @li @c "hoversel_vertical"
6426 * @li @c "hoversel_vertical_entry"
6428 * Smart callbacks one can register to:
6429 * - @c "file,chosen" - the user has selected a path, whose string
6430 * pointer comes as the @c event_info data (a stringshared
6433 * Here is an example on its usage:
6434 * @li @ref fileselector_button_example
6436 * @see @ref File_Selector_Entry for a similar widget.
6441 * Add a new file selector button widget to the given parent
6442 * Elementary (container) object
6444 * @param parent The parent object
6445 * @return a new file selector button widget handle or @c NULL, on
6448 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6451 * Set the label for a given file selector button widget
6453 * @param obj The file selector button widget
6454 * @param label The text label to be displayed on @p obj
6456 * @deprecated use elm_object_text_set() instead.
6458 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6461 * Get the label set for a given file selector button widget
6463 * @param obj The file selector button widget
6464 * @return The button label
6466 * @deprecated use elm_object_text_set() instead.
6468 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6471 * Set the icon on a given file selector button widget
6473 * @param obj The file selector button widget
6474 * @param icon The icon object for the button
6476 * Once the icon object is set, a previously set one will be
6477 * deleted. If you want to keep the latter, use the
6478 * elm_fileselector_button_icon_unset() function.
6480 * @see elm_fileselector_button_icon_get()
6482 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6485 * Get the icon set for a given file selector button widget
6487 * @param obj The file selector button widget
6488 * @return The icon object currently set on @p obj or @c NULL, if
6491 * @see elm_fileselector_button_icon_set()
6493 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6496 * Unset the icon used in a given file selector button widget
6498 * @param obj The file selector button widget
6499 * @return The icon object that was being used on @p obj or @c
6502 * Unparent and return the icon object which was set for this
6505 * @see elm_fileselector_button_icon_set()
6507 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6510 * Set the title for a given file selector button widget's window
6512 * @param obj The file selector button widget
6513 * @param title The title string
6515 * This will change the window's title, when the file selector pops
6516 * out after a click on the button. Those windows have the default
6517 * (unlocalized) value of @c "Select a file" as titles.
6519 * @note It will only take any effect if the file selector
6520 * button widget is @b not under "inwin mode".
6522 * @see elm_fileselector_button_window_title_get()
6524 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6527 * Get the title set for a given file selector button widget's
6530 * @param obj The file selector button widget
6531 * @return Title of the file selector button's window
6533 * @see elm_fileselector_button_window_title_get() for more details
6535 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6538 * Set the size of a given file selector button widget's window,
6539 * holding the file selector itself.
6541 * @param obj The file selector button widget
6542 * @param width The window's width
6543 * @param height The window's height
6545 * @note it will only take any effect if the file selector button
6546 * widget is @b not under "inwin mode". The default size for the
6547 * window (when applicable) is 400x400 pixels.
6549 * @see elm_fileselector_button_window_size_get()
6551 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6554 * Get the size of a given file selector button widget's window,
6555 * holding the file selector itself.
6557 * @param obj The file selector button widget
6558 * @param width Pointer into which to store the width value
6559 * @param height Pointer into which to store the height value
6561 * @note Use @c NULL pointers on the size values you're not
6562 * interested in: they'll be ignored by the function.
6564 * @see elm_fileselector_button_window_size_set(), for more details
6566 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6569 * Set the initial file system path for a given file selector
6572 * @param obj The file selector button widget
6573 * @param path The path string
6575 * It must be a <b>directory</b> path, which will have the contents
6576 * displayed initially in the file selector's view, when invoked
6577 * from @p obj. The default initial path is the @c "HOME"
6578 * environment variable's value.
6580 * @see elm_fileselector_button_path_get()
6582 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6585 * Get the initial file system path set for a given file selector
6588 * @param obj The file selector button widget
6589 * @return path The path string
6591 * @see elm_fileselector_button_path_set() for more details
6593 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6596 * Enable/disable a tree view in the given file selector button
6597 * widget's internal file selector
6599 * @param obj The file selector button widget
6600 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6603 * This has the same effect as elm_fileselector_expandable_set(),
6604 * but now applied to a file selector button's internal file
6607 * @note There's no way to put a file selector button's internal
6608 * file selector in "grid mode", as one may do with "pure" file
6611 * @see elm_fileselector_expandable_get()
6613 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6616 * Get whether tree view is enabled for the given file selector
6617 * button widget's internal file selector
6619 * @param obj The file selector button widget
6620 * @return @c EINA_TRUE if @p obj widget's internal file selector
6621 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6623 * @see elm_fileselector_expandable_set() for more details
6625 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6628 * Set whether a given file selector button widget's internal file
6629 * selector is to display folders only or the directory contents,
6632 * @param obj The file selector button widget
6633 * @param only @c EINA_TRUE to make @p obj widget's internal file
6634 * selector only display directories, @c EINA_FALSE to make files
6635 * to be displayed in it too
6637 * This has the same effect as elm_fileselector_folder_only_set(),
6638 * but now applied to a file selector button's internal file
6641 * @see elm_fileselector_folder_only_get()
6643 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6646 * Get whether a given file selector button widget's internal file
6647 * selector is displaying folders only or the directory contents,
6650 * @param obj The file selector button widget
6651 * @return @c EINA_TRUE if @p obj widget's internal file
6652 * selector is only displaying directories, @c EINA_FALSE if files
6653 * are being displayed in it too (and on errors)
6655 * @see elm_fileselector_button_folder_only_set() for more details
6657 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6660 * Enable/disable the file name entry box where the user can type
6661 * in a name for a file, in a given file selector button widget's
6662 * internal file selector.
6664 * @param obj The file selector button widget
6665 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6666 * file selector a "saving dialog", @c EINA_FALSE otherwise
6668 * This has the same effect as elm_fileselector_is_save_set(),
6669 * but now applied to a file selector button's internal file
6672 * @see elm_fileselector_is_save_get()
6674 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6677 * Get whether the given file selector button widget's internal
6678 * file selector is in "saving dialog" mode
6680 * @param obj The file selector button widget
6681 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6682 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6685 * @see elm_fileselector_button_is_save_set() for more details
6687 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6690 * Set whether a given file selector button widget's internal file
6691 * selector will raise an Elementary "inner window", instead of a
6692 * dedicated Elementary window. By default, it won't.
6694 * @param obj The file selector button widget
6695 * @param value @c EINA_TRUE to make it use an inner window, @c
6696 * EINA_TRUE to make it use a dedicated window
6698 * @see elm_win_inwin_add() for more information on inner windows
6699 * @see elm_fileselector_button_inwin_mode_get()
6701 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6704 * Get whether a given file selector button widget's internal file
6705 * selector will raise an Elementary "inner window", instead of a
6706 * dedicated Elementary window.
6708 * @param obj The file selector button widget
6709 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6710 * if it will use a dedicated window
6712 * @see elm_fileselector_button_inwin_mode_set() for more details
6714 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6721 * @defgroup File_Selector_Entry File Selector Entry
6723 * @image html img/widget/fileselector_entry/preview-00.png
6724 * @image latex img/widget/fileselector_entry/preview-00.eps
6726 * This is an entry made to be filled with or display a <b>file
6727 * system path string</b>. Besides the entry itself, the widget has
6728 * a @ref File_Selector_Button "file selector button" on its side,
6729 * which will raise an internal @ref Fileselector "file selector widget",
6730 * when clicked, for path selection aided by file system
6733 * This file selector may appear in an Elementary window or in an
6734 * inner window. When a file is chosen from it, the (inner) window
6735 * is closed and the selected file's path string is exposed both as
6736 * an smart event and as the new text on the entry.
6738 * This widget encapsulates operations on its internal file
6739 * selector on its own API. There is less control over its file
6740 * selector than that one would have instatiating one directly.
6742 * Smart callbacks one can register to:
6743 * - @c "changed" - The text within the entry was changed
6744 * - @c "activated" - The entry has had editing finished and
6745 * changes are to be "committed"
6746 * - @c "press" - The entry has been clicked
6747 * - @c "longpressed" - The entry has been clicked (and held) for a
6749 * - @c "clicked" - The entry has been clicked
6750 * - @c "clicked,double" - The entry has been double clicked
6751 * - @c "focused" - The entry has received focus
6752 * - @c "unfocused" - The entry has lost focus
6753 * - @c "selection,paste" - A paste action has occurred on the
6755 * - @c "selection,copy" - A copy action has occurred on the entry
6756 * - @c "selection,cut" - A cut action has occurred on the entry
6757 * - @c "unpressed" - The file selector entry's button was released
6758 * after being pressed.
6759 * - @c "file,chosen" - The user has selected a path via the file
6760 * selector entry's internal file selector, whose string pointer
6761 * comes as the @c event_info data (a stringshared string)
6763 * Here is an example on its usage:
6764 * @li @ref fileselector_entry_example
6766 * @see @ref File_Selector_Button for a similar widget.
6771 * Add a new file selector entry widget to the given parent
6772 * Elementary (container) object
6774 * @param parent The parent object
6775 * @return a new file selector entry widget handle or @c NULL, on
6778 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6781 * Set the label for a given file selector entry widget's button
6783 * @param obj The file selector entry widget
6784 * @param label The text label to be displayed on @p obj widget's
6787 * @deprecated use elm_object_text_set() instead.
6789 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6792 * Get the label set for a given file selector entry widget's button
6794 * @param obj The file selector entry widget
6795 * @return The widget button's label
6797 * @deprecated use elm_object_text_set() instead.
6799 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6802 * Set the icon on a given file selector entry widget's button
6804 * @param obj The file selector entry widget
6805 * @param icon The icon object for the entry's button
6807 * Once the icon object is set, a previously set one will be
6808 * deleted. If you want to keep the latter, use the
6809 * elm_fileselector_entry_button_icon_unset() function.
6811 * @see elm_fileselector_entry_button_icon_get()
6813 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6816 * Get the icon set for a given file selector entry widget's button
6818 * @param obj The file selector entry widget
6819 * @return The icon object currently set on @p obj widget's button
6820 * or @c NULL, if none is
6822 * @see elm_fileselector_entry_button_icon_set()
6824 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6827 * Unset the icon used in a given file selector entry widget's
6830 * @param obj The file selector entry widget
6831 * @return The icon object that was being used on @p obj widget's
6832 * button or @c NULL, on errors
6834 * Unparent and return the icon object which was set for this
6837 * @see elm_fileselector_entry_button_icon_set()
6839 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6842 * Set the title for a given file selector entry widget's window
6844 * @param obj The file selector entry widget
6845 * @param title The title string
6847 * This will change the window's title, when the file selector pops
6848 * out after a click on the entry's button. Those windows have the
6849 * default (unlocalized) value of @c "Select a file" as titles.
6851 * @note It will only take any effect if the file selector
6852 * entry widget is @b not under "inwin mode".
6854 * @see elm_fileselector_entry_window_title_get()
6856 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6859 * Get the title set for a given file selector entry widget's
6862 * @param obj The file selector entry widget
6863 * @return Title of the file selector entry's window
6865 * @see elm_fileselector_entry_window_title_get() for more details
6867 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6870 * Set the size of a given file selector entry widget's window,
6871 * holding the file selector itself.
6873 * @param obj The file selector entry widget
6874 * @param width The window's width
6875 * @param height The window's height
6877 * @note it will only take any effect if the file selector entry
6878 * widget is @b not under "inwin mode". The default size for the
6879 * window (when applicable) is 400x400 pixels.
6881 * @see elm_fileselector_entry_window_size_get()
6883 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6886 * Get the size of a given file selector entry widget's window,
6887 * holding the file selector itself.
6889 * @param obj The file selector entry widget
6890 * @param width Pointer into which to store the width value
6891 * @param height Pointer into which to store the height value
6893 * @note Use @c NULL pointers on the size values you're not
6894 * interested in: they'll be ignored by the function.
6896 * @see elm_fileselector_entry_window_size_set(), for more details
6898 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6901 * Set the initial file system path and the entry's path string for
6902 * a given file selector entry widget
6904 * @param obj The file selector entry widget
6905 * @param path The path string
6907 * It must be a <b>directory</b> path, which will have the contents
6908 * displayed initially in the file selector's view, when invoked
6909 * from @p obj. The default initial path is the @c "HOME"
6910 * environment variable's value.
6912 * @see elm_fileselector_entry_path_get()
6914 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6917 * Get the entry's path string for a given file selector entry
6920 * @param obj The file selector entry widget
6921 * @return path The path string
6923 * @see elm_fileselector_entry_path_set() for more details
6925 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6928 * Enable/disable a tree view in the given file selector entry
6929 * widget's internal file selector
6931 * @param obj The file selector entry widget
6932 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6935 * This has the same effect as elm_fileselector_expandable_set(),
6936 * but now applied to a file selector entry's internal file
6939 * @note There's no way to put a file selector entry's internal
6940 * file selector in "grid mode", as one may do with "pure" file
6943 * @see elm_fileselector_expandable_get()
6945 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6948 * Get whether tree view is enabled for the given file selector
6949 * entry widget's internal file selector
6951 * @param obj The file selector entry widget
6952 * @return @c EINA_TRUE if @p obj widget's internal file selector
6953 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6955 * @see elm_fileselector_expandable_set() for more details
6957 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6960 * Set whether a given file selector entry widget's internal file
6961 * selector is to display folders only or the directory contents,
6964 * @param obj The file selector entry widget
6965 * @param only @c EINA_TRUE to make @p obj widget's internal file
6966 * selector only display directories, @c EINA_FALSE to make files
6967 * to be displayed in it too
6969 * This has the same effect as elm_fileselector_folder_only_set(),
6970 * but now applied to a file selector entry's internal file
6973 * @see elm_fileselector_folder_only_get()
6975 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6978 * Get whether a given file selector entry widget's internal file
6979 * selector is displaying folders only or the directory contents,
6982 * @param obj The file selector entry widget
6983 * @return @c EINA_TRUE if @p obj widget's internal file
6984 * selector is only displaying directories, @c EINA_FALSE if files
6985 * are being displayed in it too (and on errors)
6987 * @see elm_fileselector_entry_folder_only_set() for more details
6989 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6992 * Enable/disable the file name entry box where the user can type
6993 * in a name for a file, in a given file selector entry widget's
6994 * internal file selector.
6996 * @param obj The file selector entry widget
6997 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6998 * file selector a "saving dialog", @c EINA_FALSE otherwise
7000 * This has the same effect as elm_fileselector_is_save_set(),
7001 * but now applied to a file selector entry's internal file
7004 * @see elm_fileselector_is_save_get()
7006 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7009 * Get whether the given file selector entry widget's internal
7010 * file selector is in "saving dialog" mode
7012 * @param obj The file selector entry widget
7013 * @return @c EINA_TRUE, if @p obj widget's internal file selector
7014 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7017 * @see elm_fileselector_entry_is_save_set() for more details
7019 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7022 * Set whether a given file selector entry widget's internal file
7023 * selector will raise an Elementary "inner window", instead of a
7024 * dedicated Elementary window. By default, it won't.
7026 * @param obj The file selector entry widget
7027 * @param value @c EINA_TRUE to make it use an inner window, @c
7028 * EINA_TRUE to make it use a dedicated window
7030 * @see elm_win_inwin_add() for more information on inner windows
7031 * @see elm_fileselector_entry_inwin_mode_get()
7033 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7036 * Get whether a given file selector entry widget's internal file
7037 * selector will raise an Elementary "inner window", instead of a
7038 * dedicated Elementary window.
7040 * @param obj The file selector entry widget
7041 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7042 * if it will use a dedicated window
7044 * @see elm_fileselector_entry_inwin_mode_set() for more details
7046 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7049 * Set the initial file system path for a given file selector entry
7052 * @param obj The file selector entry widget
7053 * @param path The path string
7055 * It must be a <b>directory</b> path, which will have the contents
7056 * displayed initially in the file selector's view, when invoked
7057 * from @p obj. The default initial path is the @c "HOME"
7058 * environment variable's value.
7060 * @see elm_fileselector_entry_path_get()
7062 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7065 * Get the parent directory's path to the latest file selection on
7066 * a given filer selector entry widget
7068 * @param obj The file selector object
7069 * @return The (full) path of the directory of the last selection
7070 * on @p obj widget, a @b stringshared string
7072 * @see elm_fileselector_entry_path_set()
7074 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7081 * @defgroup Scroller Scroller
7083 * A scroller holds a single object and "scrolls it around". This means that
7084 * it allows the user to use a scrollbar (or a finger) to drag the viewable
7085 * region around, allowing to move through a much larger object that is
7086 * contained in the scroller. The scroller will always have a small minimum
7087 * size by default as it won't be limited by the contents of the scroller.
7089 * Signals that you can add callbacks for are:
7090 * @li "edge,left" - the left edge of the content has been reached
7091 * @li "edge,right" - the right edge of the content has been reached
7092 * @li "edge,top" - the top edge of the content has been reached
7093 * @li "edge,bottom" - the bottom edge of the content has been reached
7094 * @li "scroll" - the content has been scrolled (moved)
7095 * @li "scroll,anim,start" - scrolling animation has started
7096 * @li "scroll,anim,stop" - scrolling animation has stopped
7097 * @li "scroll,drag,start" - dragging the contents around has started
7098 * @li "scroll,drag,stop" - dragging the contents around has stopped
7099 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7102 * @note When Elemementary is in embedded mode the scrollbars will not be
7103 * dragable, they appear merely as indicators of how much has been scrolled.
7104 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7105 * fingerscroll) won't work.
7107 * To set/get/unset the content of the panel, you can use
7108 * elm_object_content_set/get/unset APIs.
7109 * Once the content object is set, a previously set one will be deleted.
7110 * If you want to keep that old content object, use the
7111 * elm_object_content_unset() function
7113 * In @ref tutorial_scroller you'll find an example of how to use most of
7118 * @brief Type that controls when scrollbars should appear.
7120 * @see elm_scroller_policy_set()
7122 typedef enum _Elm_Scroller_Policy
7124 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7125 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7126 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7127 ELM_SCROLLER_POLICY_LAST
7128 } Elm_Scroller_Policy;
7130 * @brief Add a new scroller to the parent
7132 * @param parent The parent object
7133 * @return The new object or NULL if it cannot be created
7135 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7137 * @brief Set the content of the scroller widget (the object to be scrolled around).
7139 * @param obj The scroller object
7140 * @param content The new content object
7142 * Once the content object is set, a previously set one will be deleted.
7143 * If you want to keep that old content object, use the
7144 * elm_scroller_content_unset() function.
7145 * @deprecated use elm_object_content_set() instead
7147 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7149 * @brief Get the content of the scroller widget
7151 * @param obj The slider object
7152 * @return The content that is being used
7154 * Return the content object which is set for this widget
7156 * @see elm_scroller_content_set()
7157 * @deprecated use elm_object_content_get() instead.
7159 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7161 * @brief Unset the content of the scroller widget
7163 * @param obj The slider object
7164 * @return The content that was being used
7166 * Unparent and return the content object which was set for this widget
7168 * @see elm_scroller_content_set()
7169 * @deprecated use elm_object_content_unset() instead.
7171 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7173 * @brief Set custom theme elements for the scroller
7175 * @param obj The scroller object
7176 * @param widget The widget name to use (default is "scroller")
7177 * @param base The base name to use (default is "base")
7179 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7181 * @brief Make the scroller minimum size limited to the minimum size of the content
7183 * @param obj The scroller object
7184 * @param w Enable limiting minimum size horizontally
7185 * @param h Enable limiting minimum size vertically
7187 * By default the scroller will be as small as its design allows,
7188 * irrespective of its content. This will make the scroller minimum size the
7189 * right size horizontally and/or vertically to perfectly fit its content in
7192 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7194 * @brief Show a specific virtual region within the scroller content object
7196 * @param obj The scroller object
7197 * @param x X coordinate of the region
7198 * @param y Y coordinate of the region
7199 * @param w Width of the region
7200 * @param h Height of the region
7202 * This will ensure all (or part if it does not fit) of the designated
7203 * region in the virtual content object (0, 0 starting at the top-left of the
7204 * virtual content object) is shown within the scroller.
7206 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);
7208 * @brief Set the scrollbar visibility policy
7210 * @param obj The scroller object
7211 * @param policy_h Horizontal scrollbar policy
7212 * @param policy_v Vertical scrollbar policy
7214 * This sets the scrollbar visibility policy for the given scroller.
7215 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7216 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7217 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7218 * respectively for the horizontal and vertical scrollbars.
7220 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7222 * @brief Gets scrollbar visibility policy
7224 * @param obj The scroller object
7225 * @param policy_h Horizontal scrollbar policy
7226 * @param policy_v Vertical scrollbar policy
7228 * @see elm_scroller_policy_set()
7230 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7232 * @brief Get the currently visible content region
7234 * @param obj The scroller object
7235 * @param x X coordinate of the region
7236 * @param y Y coordinate of the region
7237 * @param w Width of the region
7238 * @param h Height of the region
7240 * This gets the current region in the content object that is visible through
7241 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7242 * w, @p h values pointed to.
7244 * @note All coordinates are relative to the content.
7246 * @see elm_scroller_region_show()
7248 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);
7250 * @brief Get the size of the content object
7252 * @param obj The scroller object
7253 * @param w Width of the content object.
7254 * @param h Height of the content object.
7256 * This gets the size of the content object of the scroller.
7258 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7260 * @brief Set bouncing behavior
7262 * @param obj The scroller object
7263 * @param h_bounce Allow bounce horizontally
7264 * @param v_bounce Allow bounce vertically
7266 * When scrolling, the scroller may "bounce" when reaching an edge of the
7267 * content object. This is a visual way to indicate the end has been reached.
7268 * This is enabled by default for both axis. This API will set if it is enabled
7269 * for the given axis with the boolean parameters for each axis.
7271 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7273 * @brief Get the bounce behaviour
7275 * @param obj The Scroller object
7276 * @param h_bounce Will the scroller bounce horizontally or not
7277 * @param v_bounce Will the scroller bounce vertically or not
7279 * @see elm_scroller_bounce_set()
7281 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7283 * @brief Set scroll page size relative to viewport size.
7285 * @param obj The scroller object
7286 * @param h_pagerel The horizontal page relative size
7287 * @param v_pagerel The vertical page relative size
7289 * The scroller is capable of limiting scrolling by the user to "pages". That
7290 * is to jump by and only show a "whole page" at a time as if the continuous
7291 * area of the scroller content is split into page sized pieces. This sets
7292 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7293 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7294 * axis. This is mutually exclusive with page size
7295 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7296 * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7297 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7300 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7302 * @brief Set scroll page size.
7304 * @param obj The scroller object
7305 * @param h_pagesize The horizontal page size
7306 * @param v_pagesize The vertical page size
7308 * This sets the page size to an absolute fixed value, with 0 turning it off
7311 * @see elm_scroller_page_relative_set()
7313 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7315 * @brief Get scroll current page number.
7317 * @param obj The scroller object
7318 * @param h_pagenumber The horizontal page number
7319 * @param v_pagenumber The vertical page number
7321 * The page number starts from 0. 0 is the first page.
7322 * Current page means the page which meets the top-left of the viewport.
7323 * If there are two or more pages in the viewport, it returns the number of the page
7324 * which meets the top-left of the viewport.
7326 * @see elm_scroller_last_page_get()
7327 * @see elm_scroller_page_show()
7328 * @see elm_scroller_page_brint_in()
7330 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7332 * @brief Get scroll last page number.
7334 * @param obj The scroller object
7335 * @param h_pagenumber The horizontal page number
7336 * @param v_pagenumber The vertical page number
7338 * The page number starts from 0. 0 is the first page.
7339 * This returns the last page number among the pages.
7341 * @see elm_scroller_current_page_get()
7342 * @see elm_scroller_page_show()
7343 * @see elm_scroller_page_brint_in()
7345 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7347 * Show a specific virtual region within the scroller content object by page number.
7349 * @param obj The scroller object
7350 * @param h_pagenumber The horizontal page number
7351 * @param v_pagenumber The vertical page number
7353 * 0, 0 of the indicated page is located at the top-left of the viewport.
7354 * This will jump to the page directly without animation.
7359 * sc = elm_scroller_add(win);
7360 * elm_scroller_content_set(sc, content);
7361 * elm_scroller_page_relative_set(sc, 1, 0);
7362 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7363 * elm_scroller_page_show(sc, h_page + 1, v_page);
7366 * @see elm_scroller_page_bring_in()
7368 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7370 * Show a specific virtual region within the scroller content object by page number.
7372 * @param obj The scroller object
7373 * @param h_pagenumber The horizontal page number
7374 * @param v_pagenumber The vertical page number
7376 * 0, 0 of the indicated page is located at the top-left of the viewport.
7377 * This will slide to the page with animation.
7382 * sc = elm_scroller_add(win);
7383 * elm_scroller_content_set(sc, content);
7384 * elm_scroller_page_relative_set(sc, 1, 0);
7385 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7386 * elm_scroller_page_bring_in(sc, h_page, v_page);
7389 * @see elm_scroller_page_show()
7391 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7393 * @brief Show a specific virtual region within the scroller content object.
7395 * @param obj The scroller object
7396 * @param x X coordinate of the region
7397 * @param y Y coordinate of the region
7398 * @param w Width of the region
7399 * @param h Height of the region
7401 * This will ensure all (or part if it does not fit) of the designated
7402 * region in the virtual content object (0, 0 starting at the top-left of the
7403 * virtual content object) is shown within the scroller. Unlike
7404 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7405 * to this location (if configuration in general calls for transitions). It
7406 * may not jump immediately to the new location and make take a while and
7407 * show other content along the way.
7409 * @see elm_scroller_region_show()
7411 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);
7413 * @brief Set event propagation on a scroller
7415 * @param obj The scroller object
7416 * @param propagation If propagation is enabled or not
7418 * This enables or disabled event propagation from the scroller content to
7419 * the scroller and its parent. By default event propagation is disabled.
7421 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7423 * @brief Get event propagation for a scroller
7425 * @param obj The scroller object
7426 * @return The propagation state
7428 * This gets the event propagation for a scroller.
7430 * @see elm_scroller_propagate_events_set()
7432 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7434 * @brief Set scrolling gravity on a scroller
7436 * @param obj The scroller object
7437 * @param x The scrolling horizontal gravity
7438 * @param y The scrolling vertical gravity
7440 * The gravity, defines how the scroller will adjust its view
7441 * when the size of the scroller contents increase.
7443 * The scroller will adjust the view to glue itself as follows.
7445 * x=0.0, for showing the left most region of the content.
7446 * x=1.0, for showing the right most region of the content.
7447 * y=0.0, for showing the bottom most region of the content.
7448 * y=1.0, for showing the top most region of the content.
7450 * Default values for x and y are 0.0
7452 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7454 * @brief Get scrolling gravity values for a scroller
7456 * @param obj The scroller object
7457 * @param x The scrolling horizontal gravity
7458 * @param y The scrolling vertical gravity
7460 * This gets gravity values for a scroller.
7462 * @see elm_scroller_gravity_set()
7465 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7471 * @defgroup Label Label
7473 * @image html img/widget/label/preview-00.png
7474 * @image latex img/widget/label/preview-00.eps
7476 * @brief Widget to display text, with simple html-like markup.
7478 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7479 * text doesn't fit the geometry of the label it will be ellipsized or be
7480 * cut. Elementary provides several themes for this widget:
7481 * @li default - No animation
7482 * @li marker - Centers the text in the label and make it bold by default
7483 * @li slide_long - The entire text appears from the right of the screen and
7484 * slides until it disappears in the left of the screen(reappering on the
7486 * @li slide_short - The text appears in the left of the label and slides to
7487 * the right to show the overflow. When all of the text has been shown the
7488 * position is reset.
7489 * @li slide_bounce - The text appears in the left of the label and slides to
7490 * the right to show the overflow. When all of the text has been shown the
7491 * animation reverses, moving the text to the left.
7493 * Custom themes can of course invent new markup tags and style them any way
7496 * The following signals may be emitted by the label widget:
7497 * @li "language,changed": The program's language changed.
7499 * See @ref tutorial_label for a demonstration of how to use a label widget.
7503 * @brief Add a new label to the parent
7505 * @param parent The parent object
7506 * @return The new object or NULL if it cannot be created
7508 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7510 * @brief Set the label on the label object
7512 * @param obj The label object
7513 * @param label The label will be used on the label object
7514 * @deprecated See elm_object_text_set()
7516 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 */
7518 * @brief Get the label used on the label object
7520 * @param obj The label object
7521 * @return The string inside the label
7522 * @deprecated See elm_object_text_get()
7524 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7526 * @brief Set the wrapping behavior of the label
7528 * @param obj The label object
7529 * @param wrap To wrap text or not
7531 * By default no wrapping is done. Possible values for @p wrap are:
7532 * @li ELM_WRAP_NONE - No wrapping
7533 * @li ELM_WRAP_CHAR - wrap between characters
7534 * @li ELM_WRAP_WORD - wrap between words
7535 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7537 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7539 * @brief Get the wrapping behavior of the label
7541 * @param obj The label object
7544 * @see elm_label_line_wrap_set()
7546 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7548 * @brief Set wrap width of the label
7550 * @param obj The label object
7551 * @param w The wrap width in pixels at a minimum where words need to wrap
7553 * This function sets the maximum width size hint of the label.
7555 * @warning This is only relevant if the label is inside a container.
7557 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7559 * @brief Get wrap width of the label
7561 * @param obj The label object
7562 * @return The wrap width in pixels at a minimum where words need to wrap
7564 * @see elm_label_wrap_width_set()
7566 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7568 * @brief Set wrap height of the label
7570 * @param obj The label object
7571 * @param h The wrap height in pixels at a minimum where words need to wrap
7573 * This function sets the maximum height size hint of the label.
7575 * @warning This is only relevant if the label is inside a container.
7577 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7579 * @brief get wrap width of the label
7581 * @param obj The label object
7582 * @return The wrap height in pixels at a minimum where words need to wrap
7584 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7586 * @brief Set the font size on the label object.
7588 * @param obj The label object
7589 * @param size font size
7591 * @warning NEVER use this. It is for hyper-special cases only. use styles
7592 * instead. e.g. "big", "medium", "small" - or better name them by use:
7593 * "title", "footnote", "quote" etc.
7595 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7597 * @brief Set the text color on the label object
7599 * @param obj The label object
7600 * @param r Red property background color of The label object
7601 * @param g Green property background color of The label object
7602 * @param b Blue property background color of The label object
7603 * @param a Alpha property background color of The label object
7605 * @warning NEVER use this. It is for hyper-special cases only. use styles
7606 * instead. e.g. "big", "medium", "small" - or better name them by use:
7607 * "title", "footnote", "quote" etc.
7609 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);
7611 * @brief Set the text align on the label object
7613 * @param obj The label object
7614 * @param align align mode ("left", "center", "right")
7616 * @warning NEVER use this. It is for hyper-special cases only. use styles
7617 * instead. e.g. "big", "medium", "small" - or better name them by use:
7618 * "title", "footnote", "quote" etc.
7620 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7622 * @brief Set background color of the label
7624 * @param obj The label object
7625 * @param r Red property background color of The label object
7626 * @param g Green property background color of The label object
7627 * @param b Blue property background color of The label object
7628 * @param a Alpha property background alpha of The label object
7630 * @warning NEVER use this. It is for hyper-special cases only. use styles
7631 * instead. e.g. "big", "medium", "small" - or better name them by use:
7632 * "title", "footnote", "quote" etc.
7634 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);
7636 * @brief Set the ellipsis behavior of the label
7638 * @param obj The label object
7639 * @param ellipsis To ellipsis text or not
7641 * If set to true and the text doesn't fit in the label an ellipsis("...")
7642 * will be shown at the end of the widget.
7644 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7645 * choosen wrap method was ELM_WRAP_WORD.
7647 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7648 EINA_DEPRECATED EAPI void elm_label_wrap_mode_set(Evas_Object *obj, Eina_Bool wrapmode) EINA_ARG_NONNULL(1);
7650 * @brief Set the text slide of the label
7652 * @param obj The label object
7653 * @param slide To start slide or stop
7655 * If set to true, the text of the label will slide/scroll through the length of
7658 * @warning This only works with the themes "slide_short", "slide_long" and
7661 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7663 * @brief Get the text slide mode of the label
7665 * @param obj The label object
7666 * @return slide slide mode value
7668 * @see elm_label_slide_set()
7670 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7672 * @brief Set the slide duration(speed) of the label
7674 * @param obj The label object
7675 * @return The duration in seconds in moving text from slide begin position
7676 * to slide end position
7678 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7680 * @brief Get the slide duration(speed) of the label
7682 * @param obj The label object
7683 * @return The duration time in moving text from slide begin position to slide end position
7685 * @see elm_label_slide_duration_set()
7687 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7693 * @defgroup Toggle Toggle
7695 * @image html img/widget/toggle/preview-00.png
7696 * @image latex img/widget/toggle/preview-00.eps
7698 * @brief A toggle is a slider which can be used to toggle between
7699 * two values. It has two states: on and off.
7701 * This widget is deprecated. Please use elm_check_add() instead using the
7702 * toggle style like:
7705 * obj = elm_check_add(parent);
7706 * elm_object_style_set(obj, "toggle");
7707 * elm_object_text_part_set(obj, "on", "ON");
7708 * elm_object_text_part_set(obj, "off", "OFF");
7711 * Signals that you can add callbacks for are:
7712 * @li "changed" - Whenever the toggle value has been changed. Is not called
7713 * until the toggle is released by the cursor (assuming it
7714 * has been triggered by the cursor in the first place).
7716 * @ref tutorial_toggle show how to use a toggle.
7720 * @brief Add a toggle to @p parent.
7722 * @param parent The parent object
7724 * @return The toggle object
7726 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7728 * @brief Sets the label to be displayed with the toggle.
7730 * @param obj The toggle object
7731 * @param label The label to be displayed
7733 * @deprecated use elm_object_text_set() instead.
7735 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7737 * @brief Gets the label of the toggle
7739 * @param obj toggle object
7740 * @return The label of the toggle
7742 * @deprecated use elm_object_text_get() instead.
7744 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7746 * @brief Set the icon used for the toggle
7748 * @param obj The toggle object
7749 * @param icon The icon object for the button
7751 * Once the icon object is set, a previously set one will be deleted
7752 * If you want to keep that old content object, use the
7753 * elm_toggle_icon_unset() function.
7755 * @deprecated use elm_object_content_set() instead.
7757 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7759 * @brief Get the icon used for the toggle
7761 * @param obj The toggle object
7762 * @return The icon object that is being used
7764 * Return the icon object which is set for this widget.
7766 * @see elm_toggle_icon_set()
7768 * @deprecated use elm_object_content_get() instead.
7770 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7772 * @brief Unset the icon used for the toggle
7774 * @param obj The toggle object
7775 * @return The icon object that was being used
7777 * Unparent and return the icon object which was set for this widget.
7779 * @see elm_toggle_icon_set()
7781 * @deprecated use elm_object_content_unset() instead.
7783 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7785 * @brief Sets the labels to be associated with the on and off states of the toggle.
7787 * @param obj The toggle object
7788 * @param onlabel The label displayed when the toggle is in the "on" state
7789 * @param offlabel The label displayed when the toggle is in the "off" state
7791 * @deprecated use elm_object_text_part_set() for "on" and "off" parts
7794 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7796 * @brief Gets the labels associated with the on and off states of the
7799 * @param obj The toggle object
7800 * @param onlabel A char** to place the onlabel of @p obj into
7801 * @param offlabel A char** to place the offlabel of @p obj into
7803 * @deprecated use elm_object_text_part_get() for "on" and "off" parts
7806 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7808 * @brief Sets the state of the toggle to @p state.
7810 * @param obj The toggle object
7811 * @param state The state of @p obj
7813 * @deprecated use elm_check_state_set() instead.
7815 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7817 * @brief Gets the state of the toggle to @p state.
7819 * @param obj The toggle object
7820 * @return The state of @p obj
7822 * @deprecated use elm_check_state_get() instead.
7824 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7826 * @brief Sets the state pointer of the toggle to @p statep.
7828 * @param obj The toggle object
7829 * @param statep The state pointer of @p obj
7831 * @deprecated use elm_check_state_pointer_set() instead.
7833 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7839 * @defgroup Frame Frame
7841 * @image html img/widget/frame/preview-00.png
7842 * @image latex img/widget/frame/preview-00.eps
7844 * @brief Frame is a widget that holds some content and has a title.
7846 * The default look is a frame with a title, but Frame supports multple
7854 * @li outdent_bottom
7856 * Of all this styles only default shows the title. Frame emits no signals.
7858 * Default contents parts of the frame widget that you can use for are:
7859 * @li "elm.swallow.content" - A content of the frame
7861 * Default text parts of the frame widget that you can use for are:
7862 * @li "elm.text" - Label of the frame
7864 * For a detailed example see the @ref tutorial_frame.
7869 * @brief Add a new frame to the parent
7871 * @param parent The parent object
7872 * @return The new object or NULL if it cannot be created
7874 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7876 * @brief Set the frame label
7878 * @param obj The frame object
7879 * @param label The label of this frame object
7881 * @deprecated use elm_object_text_set() instead.
7883 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7885 * @brief Get the frame label
7887 * @param obj The frame object
7889 * @return The label of this frame objet or NULL if unable to get frame
7891 * @deprecated use elm_object_text_get() instead.
7893 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7895 * @brief Set the content of the frame widget
7897 * Once the content object is set, a previously set one will be deleted.
7898 * If you want to keep that old content object, use the
7899 * elm_frame_content_unset() function.
7901 * @param obj The frame object
7902 * @param content The content will be filled in this frame object
7904 * @deprecated use elm_object_content_set() instead.
7906 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7908 * @brief Get the content of the frame widget
7910 * Return the content object which is set for this widget
7912 * @param obj The frame object
7913 * @return The content that is being used
7915 * @deprecated use elm_object_content_get() instead.
7917 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7919 * @brief Unset the content of the frame widget
7921 * Unparent and return the content object which was set for this widget
7923 * @param obj The frame object
7924 * @return The content that was being used
7926 * @deprecated use elm_object_content_unset() instead.
7928 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7934 * @defgroup Table Table
7936 * A container widget to arrange other widgets in a table where items can
7937 * also span multiple columns or rows - even overlap (and then be raised or
7938 * lowered accordingly to adjust stacking if they do overlap).
7940 * For a Table widget the row/column count is not fixed.
7941 * The table widget adjusts itself when subobjects are added to it dynamically.
7943 * The followin are examples of how to use a table:
7944 * @li @ref tutorial_table_01
7945 * @li @ref tutorial_table_02
7950 * @brief Add a new table to the parent
7952 * @param parent The parent object
7953 * @return The new object or NULL if it cannot be created
7955 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7957 * @brief Set the homogeneous layout in the table
7959 * @param obj The layout object
7960 * @param homogeneous A boolean to set if the layout is homogeneous in the
7961 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7963 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7965 * @brief Get the current table homogeneous mode.
7967 * @param obj The table object
7968 * @return A boolean to indicating if the layout is homogeneous in the table
7969 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7971 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7973 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7975 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7977 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7979 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7981 * @brief Set padding between cells.
7983 * @param obj The layout object.
7984 * @param horizontal set the horizontal padding.
7985 * @param vertical set the vertical padding.
7987 * Default value is 0.
7989 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7991 * @brief Get padding between cells.
7993 * @param obj The layout object.
7994 * @param horizontal set the horizontal padding.
7995 * @param vertical set the vertical padding.
7997 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7999 * @brief Add a subobject on the table with the coordinates passed
8001 * @param obj The table object
8002 * @param subobj The subobject to be added to the table
8003 * @param x Row number
8004 * @param y Column number
8008 * @note All positioning inside the table is relative to rows and columns, so
8009 * a value of 0 for x and y, means the top left cell of the table, and a
8010 * value of 1 for w and h means @p subobj only takes that 1 cell.
8012 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8014 * @brief Remove child from table.
8016 * @param obj The table object
8017 * @param subobj The subobject
8019 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
8021 * @brief Faster way to remove all child objects from a table object.
8023 * @param obj The table object
8024 * @param clear If true, will delete children, else just remove from table.
8026 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
8028 * @brief Set the packing location of an existing child of the table
8030 * @param subobj The subobject to be modified in the table
8031 * @param x Row number
8032 * @param y Column number
8036 * Modifies the position of an object already in the table.
8038 * @note All positioning inside the table is relative to rows and columns, so
8039 * a value of 0 for x and y, means the top left cell of the table, and a
8040 * value of 1 for w and h means @p subobj only takes that 1 cell.
8042 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8044 * @brief Get the packing location of an existing child of the table
8046 * @param subobj The subobject to be modified in the table
8047 * @param x Row number
8048 * @param y Column number
8052 * @see elm_table_pack_set()
8054 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
8060 * @defgroup Gengrid Gengrid (Generic grid)
8062 * This widget aims to position objects in a grid layout while
8063 * actually creating and rendering only the visible ones, using the
8064 * same idea as the @ref Genlist "genlist": the user defines a @b
8065 * class for each item, specifying functions that will be called at
8066 * object creation, deletion, etc. When those items are selected by
8067 * the user, a callback function is issued. Users may interact with
8068 * a gengrid via the mouse (by clicking on items to select them and
8069 * clicking on the grid's viewport and swiping to pan the whole
8070 * view) or via the keyboard, navigating through item with the
8073 * @section Gengrid_Layouts Gengrid layouts
8075 * Gengrid may layout its items in one of two possible layouts:
8079 * When in "horizontal mode", items will be placed in @b columns,
8080 * from top to bottom and, when the space for a column is filled,
8081 * another one is started on the right, thus expanding the grid
8082 * horizontally, making for horizontal scrolling. When in "vertical
8083 * mode" , though, items will be placed in @b rows, from left to
8084 * right and, when the space for a row is filled, another one is
8085 * started below, thus expanding the grid vertically (and making
8086 * for vertical scrolling).
8088 * @section Gengrid_Items Gengrid items
8090 * An item in a gengrid can have 0 or more text labels (they can be
8091 * regular text or textblock Evas objects - that's up to the style
8092 * to determine), 0 or more icons (which are simply objects
8093 * swallowed into the gengrid item's theming Edje object) and 0 or
8094 * more <b>boolean states</b>, which have the behavior left to the
8095 * user to define. The Edje part names for each of these properties
8096 * will be looked up, in the theme file for the gengrid, under the
8097 * Edje (string) data items named @c "labels", @c "icons" and @c
8098 * "states", respectively. For each of those properties, if more
8099 * than one part is provided, they must have names listed separated
8100 * by spaces in the data fields. For the default gengrid item
8101 * theme, we have @b one label part (@c "elm.text"), @b two icon
8102 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8105 * A gengrid item may be at one of several styles. Elementary
8106 * provides one by default - "default", but this can be extended by
8107 * system or application custom themes/overlays/extensions (see
8108 * @ref Theme "themes" for more details).
8110 * @section Gengrid_Item_Class Gengrid item classes
8112 * In order to have the ability to add and delete items on the fly,
8113 * gengrid implements a class (callback) system where the
8114 * application provides a structure with information about that
8115 * type of item (gengrid may contain multiple different items with
8116 * different classes, states and styles). Gengrid will call the
8117 * functions in this struct (methods) when an item is "realized"
8118 * (i.e., created dynamically, while the user is scrolling the
8119 * grid). All objects will simply be deleted when no longer needed
8120 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8121 * contains the following members:
8122 * - @c item_style - This is a constant string and simply defines
8123 * the name of the item style. It @b must be specified and the
8124 * default should be @c "default".
8125 * - @c func.label_get - This function is called when an item
8126 * object is actually created. The @c data parameter will point to
8127 * the same data passed to elm_gengrid_item_append() and related
8128 * item creation functions. The @c obj parameter is the gengrid
8129 * object itself, while the @c part one is the name string of one
8130 * of the existing text parts in the Edje group implementing the
8131 * item's theme. This function @b must return a strdup'()ed string,
8132 * as the caller will free() it when done. See
8133 * #Elm_Gengrid_Item_Label_Get_Cb.
8134 * - @c func.content_get - This function is called when an item object
8135 * is actually created. The @c data parameter will point to the
8136 * same data passed to elm_gengrid_item_append() and related item
8137 * creation functions. The @c obj parameter is the gengrid object
8138 * itself, while the @c part one is the name string of one of the
8139 * existing (content) swallow parts in the Edje group implementing the
8140 * item's theme. It must return @c NULL, when no content is desired,
8141 * or a valid object handle, otherwise. The object will be deleted
8142 * by the gengrid on its deletion or when the item is "unrealized".
8143 * See #Elm_Gengrid_Item_Content_Get_Cb.
8144 * - @c func.state_get - This function is called when an item
8145 * object is actually created. The @c data parameter will point to
8146 * the same data passed to elm_gengrid_item_append() and related
8147 * item creation functions. The @c obj parameter is the gengrid
8148 * object itself, while the @c part one is the name string of one
8149 * of the state parts in the Edje group implementing the item's
8150 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8151 * true/on. Gengrids will emit a signal to its theming Edje object
8152 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8153 * "source" arguments, respectively, when the state is true (the
8154 * default is false), where @c XXX is the name of the (state) part.
8155 * See #Elm_Gengrid_Item_State_Get_Cb.
8156 * - @c func.del - This is called when elm_gengrid_item_del() is
8157 * called on an item or elm_gengrid_clear() is called on the
8158 * gengrid. This is intended for use when gengrid items are
8159 * deleted, so any data attached to the item (e.g. its data
8160 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8162 * @section Gengrid_Usage_Hints Usage hints
8164 * If the user wants to have multiple items selected at the same
8165 * time, elm_gengrid_multi_select_set() will permit it. If the
8166 * gengrid is single-selection only (the default), then
8167 * elm_gengrid_select_item_get() will return the selected item or
8168 * @c NULL, if none is selected. If the gengrid is under
8169 * multi-selection, then elm_gengrid_selected_items_get() will
8170 * return a list (that is only valid as long as no items are
8171 * modified (added, deleted, selected or unselected) of child items
8174 * If an item changes (internal (boolean) state, label or content
8175 * changes), then use elm_gengrid_item_update() to have gengrid
8176 * update the item with the new state. A gengrid will re-"realize"
8177 * the item, thus calling the functions in the
8178 * #Elm_Gengrid_Item_Class set for that item.
8180 * To programmatically (un)select an item, use
8181 * elm_gengrid_item_selected_set(). To get its selected state use
8182 * elm_gengrid_item_selected_get(). To make an item disabled
8183 * (unable to be selected and appear differently) use
8184 * elm_gengrid_item_disabled_set() to set this and
8185 * elm_gengrid_item_disabled_get() to get the disabled state.
8187 * Grid cells will only have their selection smart callbacks called
8188 * when firstly getting selected. Any further clicks will do
8189 * nothing, unless you enable the "always select mode", with
8190 * elm_gengrid_always_select_mode_set(), thus making every click to
8191 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8192 * turn off the ability to select items entirely in the widget and
8193 * they will neither appear selected nor call the selection smart
8196 * Remember that you can create new styles and add your own theme
8197 * augmentation per application with elm_theme_extension_add(). If
8198 * you absolutely must have a specific style that overrides any
8199 * theme the user or system sets up you can use
8200 * elm_theme_overlay_add() to add such a file.
8202 * @section Gengrid_Smart_Events Gengrid smart events
8204 * Smart events that you can add callbacks for are:
8205 * - @c "activated" - The user has double-clicked or pressed
8206 * (enter|return|spacebar) on an item. The @c event_info parameter
8207 * is the gengrid item that was activated.
8208 * - @c "clicked,double" - The user has double-clicked an item.
8209 * The @c event_info parameter is the gengrid item that was double-clicked.
8210 * - @c "longpressed" - This is called when the item is pressed for a certain
8211 * amount of time. By default it's 1 second.
8212 * - @c "selected" - The user has made an item selected. The
8213 * @c event_info parameter is the gengrid item that was selected.
8214 * - @c "unselected" - The user has made an item unselected. The
8215 * @c event_info parameter is the gengrid item that was unselected.
8216 * - @c "realized" - This is called when the item in the gengrid
8217 * has its implementing Evas object instantiated, de facto. @c
8218 * event_info is the gengrid item that was created. The object
8219 * may be deleted at any time, so it is highly advised to the
8220 * caller @b not to use the object pointer returned from
8221 * elm_gengrid_item_object_get(), because it may point to freed
8223 * - @c "unrealized" - This is called when the implementing Evas
8224 * object for this item is deleted. @c event_info is the gengrid
8225 * item that was deleted.
8226 * - @c "changed" - Called when an item is added, removed, resized
8227 * or moved and when the gengrid is resized or gets "horizontal"
8229 * - @c "scroll,anim,start" - This is called when scrolling animation has
8231 * - @c "scroll,anim,stop" - This is called when scrolling animation has
8233 * - @c "drag,start,up" - Called when the item in the gengrid has
8234 * been dragged (not scrolled) up.
8235 * - @c "drag,start,down" - Called when the item in the gengrid has
8236 * been dragged (not scrolled) down.
8237 * - @c "drag,start,left" - Called when the item in the gengrid has
8238 * been dragged (not scrolled) left.
8239 * - @c "drag,start,right" - Called when the item in the gengrid has
8240 * been dragged (not scrolled) right.
8241 * - @c "drag,stop" - Called when the item in the gengrid has
8242 * stopped being dragged.
8243 * - @c "drag" - Called when the item in the gengrid is being
8245 * - @c "scroll" - called when the content has been scrolled
8247 * - @c "scroll,drag,start" - called when dragging the content has
8249 * - @c "scroll,drag,stop" - called when dragging the content has
8251 * - @c "edge,top" - This is called when the gengrid is scrolled until
8253 * - @c "edge,bottom" - This is called when the gengrid is scrolled
8254 * until the bottom edge.
8255 * - @c "edge,left" - This is called when the gengrid is scrolled
8256 * until the left edge.
8257 * - @c "edge,right" - This is called when the gengrid is scrolled
8258 * until the right edge.
8260 * List of gengrid examples:
8261 * @li @ref gengrid_example
8265 * @addtogroup Gengrid
8269 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8270 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8271 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8272 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
8273 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. */
8274 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. */
8275 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
8277 /* temporary compatibility code */
8278 typedef Elm_Gengrid_Item_Label_Get_Cb GridItemLabelGetFunc EINA_DEPRECATED;
8279 typedef Elm_Gengrid_Item_Content_Get_Cb GridItemIconGetFunc EINA_DEPRECATED;
8280 typedef Elm_Gengrid_Item_State_Get_Cb GridItemStateGetFunc EINA_DEPRECATED;
8281 typedef Elm_Gengrid_Item_Del_Cb GridItemDelFunc EINA_DEPRECATED;
8284 * @struct _Elm_Gengrid_Item_Class
8286 * Gengrid item class definition. See @ref Gengrid_Item_Class for
8289 struct _Elm_Gengrid_Item_Class
8291 const char *item_style;
8292 struct _Elm_Gengrid_Item_Class_Func
8294 Elm_Gengrid_Item_Label_Get_Cb label_get;
8295 union { /* temporary compatibility code */
8296 Elm_Gengrid_Item_Content_Get_Cb icon_get EINA_DEPRECATED;
8297 Elm_Gengrid_Item_Content_Get_Cb content_get;
8299 Elm_Gengrid_Item_State_Get_Cb state_get;
8300 Elm_Gengrid_Item_Del_Cb del;
8302 }; /**< #Elm_Gengrid_Item_Class member definitions */
8304 * Add a new gengrid widget to the given parent Elementary
8305 * (container) object
8307 * @param parent The parent object
8308 * @return a new gengrid widget handle or @c NULL, on errors
8310 * This function inserts a new gengrid widget on the canvas.
8312 * @see elm_gengrid_item_size_set()
8313 * @see elm_gengrid_group_item_size_set()
8314 * @see elm_gengrid_horizontal_set()
8315 * @see elm_gengrid_item_append()
8316 * @see elm_gengrid_item_del()
8317 * @see elm_gengrid_clear()
8321 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8324 * Set the size for the items of a given gengrid widget
8326 * @param obj The gengrid object.
8327 * @param w The items' width.
8328 * @param h The items' height;
8330 * A gengrid, after creation, has still no information on the size
8331 * to give to each of its cells. So, you most probably will end up
8332 * with squares one @ref Fingers "finger" wide, the default
8333 * size. Use this function to force a custom size for you items,
8334 * making them as big as you wish.
8336 * @see elm_gengrid_item_size_get()
8340 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8343 * Get the size set for the items of a given gengrid widget
8345 * @param obj The gengrid object.
8346 * @param w Pointer to a variable where to store the items' width.
8347 * @param h Pointer to a variable where to store the items' height.
8349 * @note Use @c NULL pointers on the size values you're not
8350 * interested in: they'll be ignored by the function.
8352 * @see elm_gengrid_item_size_get() for more details
8356 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8359 * Set the items grid's alignment within a given gengrid widget
8361 * @param obj The gengrid object.
8362 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8363 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8365 * This sets the alignment of the whole grid of items of a gengrid
8366 * within its given viewport. By default, those values are both
8367 * 0.5, meaning that the gengrid will have its items grid placed
8368 * exactly in the middle of its viewport.
8370 * @note If given alignment values are out of the cited ranges,
8371 * they'll be changed to the nearest boundary values on the valid
8374 * @see elm_gengrid_align_get()
8378 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8381 * Get the items grid's alignment values within a given gengrid
8384 * @param obj The gengrid object.
8385 * @param align_x Pointer to a variable where to store the
8386 * horizontal alignment.
8387 * @param align_y Pointer to a variable where to store the vertical
8390 * @note Use @c NULL pointers on the alignment values you're not
8391 * interested in: they'll be ignored by the function.
8393 * @see elm_gengrid_align_set() for more details
8397 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8400 * Set whether a given gengrid widget is or not able have items
8403 * @param obj The gengrid object
8404 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8405 * @c EINA_FALSE to turn it off
8407 * If a gengrid is set to allow reordering, a click held for more
8408 * than 0.5 over a given item will highlight it specially,
8409 * signalling the gengrid has entered the reordering state. From
8410 * that time on, the user will be able to, while still holding the
8411 * mouse button down, move the item freely in the gengrid's
8412 * viewport, replacing to said item to the locations it goes to.
8413 * The replacements will be animated and, whenever the user
8414 * releases the mouse button, the item being replaced gets a new
8415 * definitive place in the grid.
8417 * @see elm_gengrid_reorder_mode_get()
8421 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8424 * Get whether a given gengrid widget is or not able have items
8427 * @param obj The gengrid object
8428 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8431 * @see elm_gengrid_reorder_mode_set() for more details
8435 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8438 * Append a new item in a given gengrid widget.
8440 * @param obj The gengrid object.
8441 * @param gic The item class for the item.
8442 * @param data The item data.
8443 * @param func Convenience function called when the item is
8445 * @param func_data Data to be passed to @p func.
8446 * @return A handle to the item added or @c NULL, on errors.
8448 * This adds an item to the beginning of the gengrid.
8450 * @see elm_gengrid_item_prepend()
8451 * @see elm_gengrid_item_insert_before()
8452 * @see elm_gengrid_item_insert_after()
8453 * @see elm_gengrid_item_del()
8457 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);
8460 * Prepend a new item in a given gengrid widget.
8462 * @param obj The gengrid object.
8463 * @param gic The item class for the item.
8464 * @param data The item data.
8465 * @param func Convenience function called when the item is
8467 * @param func_data Data to be passed to @p func.
8468 * @return A handle to the item added or @c NULL, on errors.
8470 * This adds an item to the end of the gengrid.
8472 * @see elm_gengrid_item_append()
8473 * @see elm_gengrid_item_insert_before()
8474 * @see elm_gengrid_item_insert_after()
8475 * @see elm_gengrid_item_del()
8479 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);
8482 * Insert an item before another in a gengrid widget
8484 * @param obj The gengrid object.
8485 * @param gic The item class for the item.
8486 * @param data The item data.
8487 * @param relative The item to place this new one before.
8488 * @param func Convenience function called when the item is
8490 * @param func_data Data to be passed to @p func.
8491 * @return A handle to the item added or @c NULL, on errors.
8493 * This inserts an item before another in the gengrid.
8495 * @see elm_gengrid_item_append()
8496 * @see elm_gengrid_item_prepend()
8497 * @see elm_gengrid_item_insert_after()
8498 * @see elm_gengrid_item_del()
8502 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);
8505 * Insert an item after another in a gengrid widget
8507 * @param obj The gengrid object.
8508 * @param gic The item class for the item.
8509 * @param data The item data.
8510 * @param relative The item to place this new one after.
8511 * @param func Convenience function called when the item is
8513 * @param func_data Data to be passed to @p func.
8514 * @return A handle to the item added or @c NULL, on errors.
8516 * This inserts an item after another in the gengrid.
8518 * @see elm_gengrid_item_append()
8519 * @see elm_gengrid_item_prepend()
8520 * @see elm_gengrid_item_insert_after()
8521 * @see elm_gengrid_item_del()
8525 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);
8528 * Insert an item in a gengrid widget using a user-defined sort function.
8530 * @param obj The gengrid object.
8531 * @param gic The item class for the item.
8532 * @param data The item data.
8533 * @param comp User defined comparison function that defines the sort order based on
8534 * Elm_Gen_Item and its data param.
8535 * @param func Convenience function called when the item is selected.
8536 * @param func_data Data to be passed to @p func.
8537 * @return A handle to the item added or @c NULL, on errors.
8539 * This inserts an item in the gengrid based on user defined comparison function.
8541 * @see elm_gengrid_item_append()
8542 * @see elm_gengrid_item_prepend()
8543 * @see elm_gengrid_item_insert_after()
8544 * @see elm_gengrid_item_del()
8545 * @see elm_gengrid_item_direct_sorted_insert()
8549 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);
8552 * Insert an item in a gengrid widget using a user-defined sort function.
8554 * @param obj The gengrid object.
8555 * @param gic The item class for the item.
8556 * @param data The item data.
8557 * @param comp User defined comparison function that defines the sort order based on
8559 * @param func Convenience function called when the item is selected.
8560 * @param func_data Data to be passed to @p func.
8561 * @return A handle to the item added or @c NULL, on errors.
8563 * This inserts an item in the gengrid based on user defined comparison function.
8565 * @see elm_gengrid_item_append()
8566 * @see elm_gengrid_item_prepend()
8567 * @see elm_gengrid_item_insert_after()
8568 * @see elm_gengrid_item_del()
8569 * @see elm_gengrid_item_sorted_insert()
8573 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);
8576 * Set whether items on a given gengrid widget are to get their
8577 * selection callbacks issued for @b every subsequent selection
8578 * click on them or just for the first click.
8580 * @param obj The gengrid object
8581 * @param always_select @c EINA_TRUE to make items "always
8582 * selected", @c EINA_FALSE, otherwise
8584 * By default, grid items will only call their selection callback
8585 * function when firstly getting selected, any subsequent further
8586 * clicks will do nothing. With this call, you make those
8587 * subsequent clicks also to issue the selection callbacks.
8589 * @note <b>Double clicks</b> will @b always be reported on items.
8591 * @see elm_gengrid_always_select_mode_get()
8595 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8598 * Get whether items on a given gengrid widget have their selection
8599 * callbacks issued for @b every subsequent selection click on them
8600 * or just for the first click.
8602 * @param obj The gengrid object.
8603 * @return @c EINA_TRUE if the gengrid items are "always selected",
8604 * @c EINA_FALSE, otherwise
8606 * @see elm_gengrid_always_select_mode_set() for more details
8610 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8613 * Set whether items on a given gengrid widget can be selected or not.
8615 * @param obj The gengrid object
8616 * @param no_select @c EINA_TRUE to make items selectable,
8617 * @c EINA_FALSE otherwise
8619 * This will make items in @p obj selectable or not. In the latter
8620 * case, any user interaction on the gengrid items will neither make
8621 * them appear selected nor them call their selection callback
8624 * @see elm_gengrid_no_select_mode_get()
8628 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8631 * Get whether items on a given gengrid widget can be selected or
8634 * @param obj The gengrid object
8635 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8638 * @see elm_gengrid_no_select_mode_set() for more details
8642 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8645 * Enable or disable multi-selection in a given gengrid widget
8647 * @param obj The gengrid object.
8648 * @param multi @c EINA_TRUE, to enable multi-selection,
8649 * @c EINA_FALSE to disable it.
8651 * Multi-selection is the ability to have @b more than one
8652 * item selected, on a given gengrid, simultaneously. When it is
8653 * enabled, a sequence of clicks on different items will make them
8654 * all selected, progressively. A click on an already selected item
8655 * will unselect it. If interacting via the keyboard,
8656 * multi-selection is enabled while holding the "Shift" key.
8658 * @note By default, multi-selection is @b disabled on gengrids
8660 * @see elm_gengrid_multi_select_get()
8664 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8667 * Get whether multi-selection is enabled or disabled for a given
8670 * @param obj The gengrid object.
8671 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8672 * EINA_FALSE otherwise
8674 * @see elm_gengrid_multi_select_set() for more details
8678 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8681 * Enable or disable bouncing effect for a given gengrid widget
8683 * @param obj The gengrid object
8684 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8685 * @c EINA_FALSE to disable it
8686 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8687 * @c EINA_FALSE to disable it
8689 * The bouncing effect occurs whenever one reaches the gengrid's
8690 * edge's while panning it -- it will scroll past its limits a
8691 * little bit and return to the edge again, in a animated for,
8694 * @note By default, gengrids have bouncing enabled on both axis
8696 * @see elm_gengrid_bounce_get()
8700 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8703 * Get whether bouncing effects are enabled or disabled, for a
8704 * given gengrid widget, on each axis
8706 * @param obj The gengrid object
8707 * @param h_bounce Pointer to a variable where to store the
8708 * horizontal bouncing flag.
8709 * @param v_bounce Pointer to a variable where to store the
8710 * vertical bouncing flag.
8712 * @see elm_gengrid_bounce_set() for more details
8716 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8719 * Set a given gengrid widget's scrolling page size, relative to
8720 * its viewport size.
8722 * @param obj The gengrid object
8723 * @param h_pagerel The horizontal page (relative) size
8724 * @param v_pagerel The vertical page (relative) size
8726 * The gengrid's scroller is capable of binding scrolling by the
8727 * user to "pages". It means that, while scrolling and, specially
8728 * after releasing the mouse button, the grid will @b snap to the
8729 * nearest displaying page's area. When page sizes are set, the
8730 * grid's continuous content area is split into (equal) page sized
8733 * This function sets the size of a page <b>relatively to the
8734 * viewport dimensions</b> of the gengrid, for each axis. A value
8735 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8736 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8737 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8738 * 1.0. Values beyond those will make it behave behave
8739 * inconsistently. If you only want one axis to snap to pages, use
8740 * the value @c 0.0 for the other one.
8742 * There is a function setting page size values in @b absolute
8743 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8744 * is mutually exclusive to this one.
8746 * @see elm_gengrid_page_relative_get()
8750 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8753 * Get a given gengrid widget's scrolling page size, relative to
8754 * its viewport size.
8756 * @param obj The gengrid object
8757 * @param h_pagerel Pointer to a variable where to store the
8758 * horizontal page (relative) size
8759 * @param v_pagerel Pointer to a variable where to store the
8760 * vertical page (relative) size
8762 * @see elm_gengrid_page_relative_set() for more details
8766 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8769 * Set a given gengrid widget's scrolling page size
8771 * @param obj The gengrid object
8772 * @param h_pagerel The horizontal page size, in pixels
8773 * @param v_pagerel The vertical page size, in pixels
8775 * The gengrid's scroller is capable of binding scrolling by the
8776 * user to "pages". It means that, while scrolling and, specially
8777 * after releasing the mouse button, the grid will @b snap to the
8778 * nearest displaying page's area. When page sizes are set, the
8779 * grid's continuous content area is split into (equal) page sized
8782 * This function sets the size of a page of the gengrid, in pixels,
8783 * for each axis. Sane usable values are, between @c 0 and the
8784 * dimensions of @p obj, for each axis. Values beyond those will
8785 * make it behave behave inconsistently. If you only want one axis
8786 * to snap to pages, use the value @c 0 for the other one.
8788 * There is a function setting page size values in @b relative
8789 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8790 * use is mutually exclusive to this one.
8794 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8797 * Set the direction in which a given gengrid widget will expand while
8798 * placing its items.
8800 * @param obj The gengrid object.
8801 * @param setting @c EINA_TRUE to make the gengrid expand
8802 * horizontally, @c EINA_FALSE to expand vertically.
8804 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8805 * in @b columns, from top to bottom and, when the space for a
8806 * column is filled, another one is started on the right, thus
8807 * expanding the grid horizontally. When in "vertical mode"
8808 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8809 * to right and, when the space for a row is filled, another one is
8810 * started below, thus expanding the grid vertically.
8812 * @see elm_gengrid_horizontal_get()
8816 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8819 * Get for what direction a given gengrid widget will expand while
8820 * placing its items.
8822 * @param obj The gengrid object.
8823 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8824 * @c EINA_FALSE if it's set to expand vertically.
8826 * @see elm_gengrid_horizontal_set() for more detais
8830 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8833 * Get the first item in a given gengrid widget
8835 * @param obj The gengrid object
8836 * @return The first item's handle or @c NULL, if there are no
8837 * items in @p obj (and on errors)
8839 * This returns the first item in the @p obj's internal list of
8842 * @see elm_gengrid_last_item_get()
8846 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8849 * Get the last item in a given gengrid widget
8851 * @param obj The gengrid object
8852 * @return The last item's handle or @c NULL, if there are no
8853 * items in @p obj (and on errors)
8855 * This returns the last item in the @p obj's internal list of
8858 * @see elm_gengrid_first_item_get()
8862 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8865 * Get the @b next item in a gengrid widget's internal list of items,
8866 * given a handle to one of those items.
8868 * @param item The gengrid item to fetch next from
8869 * @return The item after @p item, or @c NULL if there's none (and
8872 * This returns the item placed after the @p item, on the container
8875 * @see elm_gengrid_item_prev_get()
8879 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8882 * Get the @b previous item in a gengrid widget's internal list of items,
8883 * given a handle to one of those items.
8885 * @param item The gengrid item to fetch previous from
8886 * @return The item before @p item, or @c NULL if there's none (and
8889 * This returns the item placed before the @p item, on the container
8892 * @see elm_gengrid_item_next_get()
8896 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8899 * Get the gengrid object's handle which contains a given gengrid
8902 * @param item The item to fetch the container from
8903 * @return The gengrid (parent) object
8905 * This returns the gengrid object itself that an item belongs to.
8909 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8912 * Remove a gengrid item from its parent, deleting it.
8914 * @param item The item to be removed.
8915 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8917 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8922 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8925 * Update the contents of a given gengrid item
8927 * @param item The gengrid item
8929 * This updates an item by calling all the item class functions
8930 * again to get the contents, labels and states. Use this when the
8931 * original item data has changed and you want the changes to be
8936 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8939 * Get the Gengrid Item class for the given Gengrid Item.
8941 * @param item The gengrid item
8943 * This returns the Gengrid_Item_Class for the given item. It can be used to examine
8944 * the function pointers and item_style.
8948 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8951 * Get the Gengrid Item class for the given Gengrid Item.
8953 * This sets the Gengrid_Item_Class for the given item. It can be used to examine
8954 * the function pointers and item_style.
8956 * @param item The gengrid item
8957 * @param gic The gengrid item class describing the function pointers and the item style.
8961 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8964 * Return the data associated to a given gengrid item
8966 * @param item The gengrid item.
8967 * @return the data associated with this item.
8969 * This returns the @c data value passed on the
8970 * elm_gengrid_item_append() and related item addition calls.
8972 * @see elm_gengrid_item_append()
8973 * @see elm_gengrid_item_data_set()
8977 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8980 * Set the data associated with a given gengrid item
8982 * @param item The gengrid item
8983 * @param data The data pointer to set on it
8985 * This @b overrides the @c data value passed on the
8986 * elm_gengrid_item_append() and related item addition calls. This
8987 * function @b won't call elm_gengrid_item_update() automatically,
8988 * so you'd issue it afterwards if you want to have the item
8989 * updated to reflect the new data.
8991 * @see elm_gengrid_item_data_get()
8992 * @see elm_gengrid_item_update()
8996 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8999 * Get a given gengrid item's position, relative to the whole
9000 * gengrid's grid area.
9002 * @param item The Gengrid item.
9003 * @param x Pointer to variable to store the item's <b>row number</b>.
9004 * @param y Pointer to variable to store the item's <b>column number</b>.
9006 * This returns the "logical" position of the item within the
9007 * gengrid. For example, @c (0, 1) would stand for first row,
9012 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9015 * Set whether a given gengrid item is selected or not
9017 * @param item The gengrid item
9018 * @param selected Use @c EINA_TRUE, to make it selected, @c
9019 * EINA_FALSE to make it unselected
9021 * This sets the selected state of an item. If multi-selection is
9022 * not enabled on the containing gengrid and @p selected is @c
9023 * EINA_TRUE, any other previously selected items will get
9024 * unselected in favor of this new one.
9026 * @see elm_gengrid_item_selected_get()
9030 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9033 * Get whether a given gengrid item is selected or not
9035 * @param item The gengrid item
9036 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9038 * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9040 * @see elm_gengrid_item_selected_set() for more details
9044 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9047 * Get the real Evas object created to implement the view of a
9048 * given gengrid item
9050 * @param item The gengrid item.
9051 * @return the Evas object implementing this item's view.
9053 * This returns the actual Evas object used to implement the
9054 * specified gengrid item's view. This may be @c NULL, as it may
9055 * not have been created or may have been deleted, at any time, by
9056 * the gengrid. <b>Do not modify this object</b> (move, resize,
9057 * show, hide, etc.), as the gengrid is controlling it. This
9058 * function is for querying, emitting custom signals or hooking
9059 * lower level callbacks for events on that object. Do not delete
9060 * this object under any circumstances.
9062 * @see elm_gengrid_item_data_get()
9066 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9069 * Show the portion of a gengrid's internal grid containing a given
9070 * item, @b immediately.
9072 * @param item The item to display
9074 * This causes gengrid to @b redraw its viewport's contents to the
9075 * region contining the given @p item item, if it is not fully
9078 * @see elm_gengrid_item_bring_in()
9082 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9085 * Animatedly bring in, to the visible area of a gengrid, a given
9088 * @param item The gengrid item to display
9090 * This causes gengrid to jump to the given @p item and show
9091 * it (by scrolling), if it is not fully visible. This will use
9092 * animation to do so and take a period of time to complete.
9094 * @see elm_gengrid_item_show()
9098 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9101 * Set whether a given gengrid item is disabled or not.
9103 * @param item The gengrid item
9104 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9105 * to enable it back.
9107 * A disabled item cannot be selected or unselected. It will also
9108 * change its appearance, to signal the user it's disabled.
9110 * @see elm_gengrid_item_disabled_get()
9114 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9117 * Get whether a given gengrid item is disabled or not.
9119 * @param item The gengrid item
9120 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9123 * @see elm_gengrid_item_disabled_set() for more details
9127 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9130 * Set the text to be shown in a given gengrid item's tooltips.
9132 * @param item The gengrid item
9133 * @param text The text to set in the content
9135 * This call will setup the text to be used as tooltip to that item
9136 * (analogous to elm_object_tooltip_text_set(), but being item
9137 * tooltips with higher precedence than object tooltips). It can
9138 * have only one tooltip at a time, so any previous tooltip data
9143 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9146 * Set the content to be shown in a given gengrid item's tooltip
9148 * @param item The gengrid item.
9149 * @param func The function returning the tooltip contents.
9150 * @param data What to provide to @a func as callback data/context.
9151 * @param del_cb Called when data is not needed anymore, either when
9152 * another callback replaces @p func, the tooltip is unset with
9153 * elm_gengrid_item_tooltip_unset() or the owner @p item
9154 * dies. This callback receives as its first parameter the
9155 * given @p data, being @c event_info the item handle.
9157 * This call will setup the tooltip's contents to @p item
9158 * (analogous to elm_object_tooltip_content_cb_set(), but being
9159 * item tooltips with higher precedence than object tooltips). It
9160 * can have only one tooltip at a time, so any previous tooltip
9161 * content will get removed. @p func (with @p data) will be called
9162 * every time Elementary needs to show the tooltip and it should
9163 * return a valid Evas object, which will be fully managed by the
9164 * tooltip system, getting deleted when the tooltip is gone.
9168 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);
9171 * Unset a tooltip from a given gengrid item
9173 * @param item gengrid item to remove a previously set tooltip from.
9175 * This call removes any tooltip set on @p item. The callback
9176 * provided as @c del_cb to
9177 * elm_gengrid_item_tooltip_content_cb_set() will be called to
9178 * notify it is not used anymore (and have resources cleaned, if
9181 * @see elm_gengrid_item_tooltip_content_cb_set()
9185 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9188 * Set a different @b style for a given gengrid item's tooltip.
9190 * @param item gengrid item with tooltip set
9191 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9192 * "default", @c "transparent", etc)
9194 * Tooltips can have <b>alternate styles</b> to be displayed on,
9195 * which are defined by the theme set on Elementary. This function
9196 * works analogously as elm_object_tooltip_style_set(), but here
9197 * applied only to gengrid item objects. The default style for
9198 * tooltips is @c "default".
9200 * @note before you set a style you should define a tooltip with
9201 * elm_gengrid_item_tooltip_content_cb_set() or
9202 * elm_gengrid_item_tooltip_text_set()
9204 * @see elm_gengrid_item_tooltip_style_get()
9208 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9211 * Get the style set a given gengrid item's tooltip.
9213 * @param item gengrid item with tooltip already set on.
9214 * @return style the theme style in use, which defaults to
9215 * "default". If the object does not have a tooltip set,
9216 * then @c NULL is returned.
9218 * @see elm_gengrid_item_tooltip_style_set() for more details
9222 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9224 * Set the type of mouse pointer/cursor decoration to be shown,
9225 * when the mouse pointer is over the given gengrid widget item
9227 * @param item gengrid item to customize cursor on
9228 * @param cursor the cursor type's name
9230 * This function works analogously as elm_object_cursor_set(), but
9231 * here the cursor's changing area is restricted to the item's
9232 * area, and not the whole widget's. Note that that item cursors
9233 * have precedence over widget cursors, so that a mouse over @p
9234 * item will always show cursor @p type.
9236 * If this function is called twice for an object, a previously set
9237 * cursor will be unset on the second call.
9239 * @see elm_object_cursor_set()
9240 * @see elm_gengrid_item_cursor_get()
9241 * @see elm_gengrid_item_cursor_unset()
9245 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9248 * Get the type of mouse pointer/cursor decoration set to be shown,
9249 * when the mouse pointer is over the given gengrid widget item
9251 * @param item gengrid item with custom cursor set
9252 * @return the cursor type's name or @c NULL, if no custom cursors
9253 * were set to @p item (and on errors)
9255 * @see elm_object_cursor_get()
9256 * @see elm_gengrid_item_cursor_set() for more details
9257 * @see elm_gengrid_item_cursor_unset()
9261 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9264 * Unset any custom mouse pointer/cursor decoration set to be
9265 * shown, when the mouse pointer is over the given gengrid widget
9266 * item, thus making it show the @b default cursor again.
9268 * @param item a gengrid item
9270 * Use this call to undo any custom settings on this item's cursor
9271 * decoration, bringing it back to defaults (no custom style set).
9273 * @see elm_object_cursor_unset()
9274 * @see elm_gengrid_item_cursor_set() for more details
9278 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9281 * Set a different @b style for a given custom cursor set for a
9284 * @param item gengrid item with custom cursor set
9285 * @param style the <b>theme style</b> to use (e.g. @c "default",
9286 * @c "transparent", etc)
9288 * This function only makes sense when one is using custom mouse
9289 * cursor decorations <b>defined in a theme file</b> , which can
9290 * have, given a cursor name/type, <b>alternate styles</b> on
9291 * it. It works analogously as elm_object_cursor_style_set(), but
9292 * here applied only to gengrid item objects.
9294 * @warning Before you set a cursor style you should have defined a
9295 * custom cursor previously on the item, with
9296 * elm_gengrid_item_cursor_set()
9298 * @see elm_gengrid_item_cursor_engine_only_set()
9299 * @see elm_gengrid_item_cursor_style_get()
9303 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9306 * Get the current @b style set for a given gengrid item's custom
9309 * @param item gengrid item with custom cursor set.
9310 * @return style the cursor style in use. If the object does not
9311 * have a cursor set, then @c NULL is returned.
9313 * @see elm_gengrid_item_cursor_style_set() for more details
9317 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9320 * Set if the (custom) cursor for a given gengrid item should be
9321 * searched in its theme, also, or should only rely on the
9324 * @param item item with custom (custom) cursor already set on
9325 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9326 * only on those provided by the rendering engine, @c EINA_FALSE to
9327 * have them searched on the widget's theme, as well.
9329 * @note This call is of use only if you've set a custom cursor
9330 * for gengrid items, with elm_gengrid_item_cursor_set().
9332 * @note By default, cursors will only be looked for between those
9333 * provided by the rendering engine.
9337 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9340 * Get if the (custom) cursor for a given gengrid item is being
9341 * searched in its theme, also, or is only relying on the rendering
9344 * @param item a gengrid item
9345 * @return @c EINA_TRUE, if cursors are being looked for only on
9346 * those provided by the rendering engine, @c EINA_FALSE if they
9347 * are being searched on the widget's theme, as well.
9349 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9353 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9356 * Remove all items from a given gengrid widget
9358 * @param obj The gengrid object.
9360 * This removes (and deletes) all items in @p obj, leaving it
9363 * @see elm_gengrid_item_del(), to remove just one item.
9367 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9370 * Get the selected item in a given gengrid widget
9372 * @param obj The gengrid object.
9373 * @return The selected item's handleor @c NULL, if none is
9374 * selected at the moment (and on errors)
9376 * This returns the selected item in @p obj. If multi selection is
9377 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9378 * the first item in the list is selected, which might not be very
9379 * useful. For that case, see elm_gengrid_selected_items_get().
9383 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9386 * Get <b>a list</b> of selected items in a given gengrid
9388 * @param obj The gengrid object.
9389 * @return The list of selected items or @c NULL, if none is
9390 * selected at the moment (and on errors)
9392 * This returns a list of the selected items, in the order that
9393 * they appear in the grid. This list is only valid as long as no
9394 * more items are selected or unselected (or unselected implictly
9395 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9398 * @see elm_gengrid_selected_item_get()
9402 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9409 * @defgroup Clock Clock
9411 * @image html img/widget/clock/preview-00.png
9412 * @image latex img/widget/clock/preview-00.eps
9414 * This is a @b digital clock widget. In its default theme, it has a
9415 * vintage "flipping numbers clock" appearance, which will animate
9416 * sheets of individual algarisms individually as time goes by.
9418 * A newly created clock will fetch system's time (already
9419 * considering local time adjustments) to start with, and will tick
9420 * accondingly. It may or may not show seconds.
9422 * Clocks have an @b edition mode. When in it, the sheets will
9423 * display extra arrow indications on the top and bottom and the
9424 * user may click on them to raise or lower the time values. After
9425 * it's told to exit edition mode, it will keep ticking with that
9426 * new time set (it keeps the difference from local time).
9428 * Also, when under edition mode, user clicks on the cited arrows
9429 * which are @b held for some time will make the clock to flip the
9430 * sheet, thus editing the time, continuosly and automatically for
9431 * the user. The interval between sheet flips will keep growing in
9432 * time, so that it helps the user to reach a time which is distant
9435 * The time display is, by default, in military mode (24h), but an
9436 * am/pm indicator may be optionally shown, too, when it will
9439 * Smart callbacks one can register to:
9440 * - "changed" - the clock's user changed the time
9442 * Here is an example on its usage:
9443 * @li @ref clock_example
9452 * Identifiers for which clock digits should be editable, when a
9453 * clock widget is in edition mode. Values may be ORed together to
9454 * make a mask, naturally.
9456 * @see elm_clock_edit_set()
9457 * @see elm_clock_digit_edit_set()
9459 typedef enum _Elm_Clock_Digedit
9461 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9462 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9463 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9464 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9465 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9466 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9467 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9468 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9469 } Elm_Clock_Digedit;
9472 * Add a new clock widget to the given parent Elementary
9473 * (container) object
9475 * @param parent The parent object
9476 * @return a new clock widget handle or @c NULL, on errors
9478 * This function inserts a new clock widget on the canvas.
9482 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9485 * Set a clock widget's time, programmatically
9487 * @param obj The clock widget object
9488 * @param hrs The hours to set
9489 * @param min The minutes to set
9490 * @param sec The secondes to set
9492 * This function updates the time that is showed by the clock
9495 * Values @b must be set within the following ranges:
9496 * - 0 - 23, for hours
9497 * - 0 - 59, for minutes
9498 * - 0 - 59, for seconds,
9500 * even if the clock is not in "military" mode.
9502 * @warning The behavior for values set out of those ranges is @b
9507 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9510 * Get a clock widget's time values
9512 * @param obj The clock object
9513 * @param[out] hrs Pointer to the variable to get the hours value
9514 * @param[out] min Pointer to the variable to get the minutes value
9515 * @param[out] sec Pointer to the variable to get the seconds value
9517 * This function gets the time set for @p obj, returning
9518 * it on the variables passed as the arguments to function
9520 * @note Use @c NULL pointers on the time values you're not
9521 * interested in: they'll be ignored by the function.
9525 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9528 * Set whether a given clock widget is under <b>edition mode</b> or
9529 * under (default) displaying-only mode.
9531 * @param obj The clock object
9532 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9533 * put it back to "displaying only" mode
9535 * This function makes a clock's time to be editable or not <b>by
9536 * user interaction</b>. When in edition mode, clocks @b stop
9537 * ticking, until one brings them back to canonical mode. The
9538 * elm_clock_digit_edit_set() function will influence which digits
9539 * of the clock will be editable. By default, all of them will be
9540 * (#ELM_CLOCK_NONE).
9542 * @note am/pm sheets, if being shown, will @b always be editable
9543 * under edition mode.
9545 * @see elm_clock_edit_get()
9549 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9552 * Retrieve whether a given clock widget is under <b>edition
9553 * mode</b> or under (default) displaying-only mode.
9555 * @param obj The clock object
9556 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9559 * This function retrieves whether the clock's time can be edited
9560 * or not by user interaction.
9562 * @see elm_clock_edit_set() for more details
9566 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9569 * Set what digits of the given clock widget should be editable
9570 * when in edition mode.
9572 * @param obj The clock object
9573 * @param digedit Bit mask indicating the digits to be editable
9574 * (values in #Elm_Clock_Digedit).
9576 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9577 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9580 * @see elm_clock_digit_edit_get()
9584 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9587 * Retrieve what digits of the given clock widget should be
9588 * editable when in edition mode.
9590 * @param obj The clock object
9591 * @return Bit mask indicating the digits to be editable
9592 * (values in #Elm_Clock_Digedit).
9594 * @see elm_clock_digit_edit_set() for more details
9598 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9601 * Set if the given clock widget must show hours in military or
9604 * @param obj The clock object
9605 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9608 * This function sets if the clock must show hours in military or
9609 * am/pm mode. In some countries like Brazil the military mode
9610 * (00-24h-format) is used, in opposition to the USA, where the
9611 * am/pm mode is more commonly used.
9613 * @see elm_clock_show_am_pm_get()
9617 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9620 * Get if the given clock widget shows hours in military or am/pm
9623 * @param obj The clock object
9624 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9627 * This function gets if the clock shows hours in military or am/pm
9630 * @see elm_clock_show_am_pm_set() for more details
9634 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9637 * Set if the given clock widget must show time with seconds or not
9639 * @param obj The clock object
9640 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9642 * This function sets if the given clock must show or not elapsed
9643 * seconds. By default, they are @b not shown.
9645 * @see elm_clock_show_seconds_get()
9649 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9652 * Get whether the given clock widget is showing time with seconds
9655 * @param obj The clock object
9656 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9658 * This function gets whether @p obj is showing or not the elapsed
9661 * @see elm_clock_show_seconds_set()
9665 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9668 * Set the interval on time updates for an user mouse button hold
9669 * on clock widgets' time edition.
9671 * @param obj The clock object
9672 * @param interval The (first) interval value in seconds
9674 * This interval value is @b decreased while the user holds the
9675 * mouse pointer either incrementing or decrementing a given the
9676 * clock digit's value.
9678 * This helps the user to get to a given time distant from the
9679 * current one easier/faster, as it will start to flip quicker and
9680 * quicker on mouse button holds.
9682 * The calculation for the next flip interval value, starting from
9683 * the one set with this call, is the previous interval divided by
9684 * 1.05, so it decreases a little bit.
9686 * The default starting interval value for automatic flips is
9689 * @see elm_clock_interval_get()
9693 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9696 * Get the interval on time updates for an user mouse button hold
9697 * on clock widgets' time edition.
9699 * @param obj The clock object
9700 * @return The (first) interval value, in seconds, set on it
9702 * @see elm_clock_interval_set() for more details
9706 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9713 * @defgroup Layout Layout
9715 * @image html img/widget/layout/preview-00.png
9716 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9718 * @image html img/layout-predefined.png
9719 * @image latex img/layout-predefined.eps width=\textwidth
9721 * This is a container widget that takes a standard Edje design file and
9722 * wraps it very thinly in a widget.
9724 * An Edje design (theme) file has a very wide range of possibilities to
9725 * describe the behavior of elements added to the Layout. Check out the Edje
9726 * documentation and the EDC reference to get more information about what can
9727 * be done with Edje.
9729 * Just like @ref List, @ref Box, and other container widgets, any
9730 * object added to the Layout will become its child, meaning that it will be
9731 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9733 * The Layout widget can contain as many Contents, Boxes or Tables as
9734 * described in its theme file. For instance, objects can be added to
9735 * different Tables by specifying the respective Table part names. The same
9736 * is valid for Content and Box.
9738 * The objects added as child of the Layout will behave as described in the
9739 * part description where they were added. There are 3 possible types of
9740 * parts where a child can be added:
9742 * @section secContent Content (SWALLOW part)
9744 * Only one object can be added to the @c SWALLOW part (but you still can
9745 * have many @c SWALLOW parts and one object on each of them). Use the @c
9746 * elm_object_content_set/get/unset functions to set, retrieve and unset
9747 * objects as content of the @c SWALLOW. After being set to this part, the
9748 * object size, position, visibility, clipping and other description
9749 * properties will be totally controled by the description of the given part
9750 * (inside the Edje theme file).
9752 * One can use @c evas_object_size_hint_* functions on the child to have some
9753 * kind of control over its behavior, but the resulting behavior will still
9754 * depend heavily on the @c SWALLOW part description.
9756 * The Edje theme also can change the part description, based on signals or
9757 * scripts running inside the theme. This change can also be animated. All of
9758 * this will affect the child object set as content accordingly. The object
9759 * size will be changed if the part size is changed, it will animate move if
9760 * the part is moving, and so on.
9762 * The following picture demonstrates a Layout widget with a child object
9763 * added to its @c SWALLOW:
9765 * @image html layout_swallow.png
9766 * @image latex layout_swallow.eps width=\textwidth
9768 * @section secBox Box (BOX part)
9770 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9771 * allows one to add objects to the box and have them distributed along its
9772 * area, accordingly to the specified @a layout property (now by @a layout we
9773 * mean the chosen layouting design of the Box, not the Layout widget
9776 * A similar effect for having a box with its position, size and other things
9777 * controled by the Layout theme would be to create an Elementary @ref Box
9778 * widget and add it as a Content in the @c SWALLOW part.
9780 * The main difference of using the Layout Box is that its behavior, the box
9781 * properties like layouting format, padding, align, etc. will be all
9782 * controled by the theme. This means, for example, that a signal could be
9783 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9784 * handled the signal by changing the box padding, or align, or both. Using
9785 * the Elementary @ref Box widget is not necessarily harder or easier, it
9786 * just depends on the circunstances and requirements.
9788 * The Layout Box can be used through the @c elm_layout_box_* set of
9791 * The following picture demonstrates a Layout widget with many child objects
9792 * added to its @c BOX part:
9794 * @image html layout_box.png
9795 * @image latex layout_box.eps width=\textwidth
9797 * @section secTable Table (TABLE part)
9799 * Just like the @ref secBox, the Layout Table is very similar to the
9800 * Elementary @ref Table widget. It allows one to add objects to the Table
9801 * specifying the row and column where the object should be added, and any
9802 * column or row span if necessary.
9804 * Again, we could have this design by adding a @ref Table widget to the @c
9805 * SWALLOW part using elm_object_content_part_set(). The same difference happens
9806 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9807 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9809 * The Layout Table can be used through the @c elm_layout_table_* set of
9812 * The following picture demonstrates a Layout widget with many child objects
9813 * added to its @c TABLE part:
9815 * @image html layout_table.png
9816 * @image latex layout_table.eps width=\textwidth
9818 * @section secPredef Predefined Layouts
9820 * Another interesting thing about the Layout widget is that it offers some
9821 * predefined themes that come with the default Elementary theme. These
9822 * themes can be set by the call elm_layout_theme_set(), and provide some
9823 * basic functionality depending on the theme used.
9825 * Most of them already send some signals, some already provide a toolbar or
9826 * back and next buttons.
9828 * These are available predefined theme layouts. All of them have class = @c
9829 * layout, group = @c application, and style = one of the following options:
9831 * @li @c toolbar-content - application with toolbar and main content area
9832 * @li @c toolbar-content-back - application with toolbar and main content
9833 * area with a back button and title area
9834 * @li @c toolbar-content-back-next - application with toolbar and main
9835 * content area with a back and next buttons and title area
9836 * @li @c content-back - application with a main content area with a back
9837 * button and title area
9838 * @li @c content-back-next - application with a main content area with a
9839 * back and next buttons and title area
9840 * @li @c toolbar-vbox - application with toolbar and main content area as a
9842 * @li @c toolbar-table - application with toolbar and main content area as a
9845 * @section secExamples Examples
9847 * Some examples of the Layout widget can be found here:
9848 * @li @ref layout_example_01
9849 * @li @ref layout_example_02
9850 * @li @ref layout_example_03
9851 * @li @ref layout_example_edc
9856 * Add a new layout to the parent
9858 * @param parent The parent object
9859 * @return The new object or NULL if it cannot be created
9861 * @see elm_layout_file_set()
9862 * @see elm_layout_theme_set()
9866 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9868 * Set the file that will be used as layout
9870 * @param obj The layout object
9871 * @param file The path to file (edj) that will be used as layout
9872 * @param group The group that the layout belongs in edje file
9874 * @return (1 = success, 0 = error)
9878 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9880 * Set the edje group from the elementary theme that will be used as layout
9882 * @param obj The layout object
9883 * @param clas the clas of the group
9884 * @param group the group
9885 * @param style the style to used
9887 * @return (1 = success, 0 = error)
9891 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9893 * Set the layout content.
9895 * @param obj The layout object
9896 * @param swallow The swallow part name in the edje file
9897 * @param content The child that will be added in this layout object
9899 * Once the content object is set, a previously set one will be deleted.
9900 * If you want to keep that old content object, use the
9901 * elm_object_content_part_unset() function.
9903 * @note In an Edje theme, the part used as a content container is called @c
9904 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9905 * expected to be a part name just like the second parameter of
9906 * elm_layout_box_append().
9908 * @see elm_layout_box_append()
9909 * @see elm_object_content_part_get()
9910 * @see elm_object_content_part_unset()
9915 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9917 * Get the child object in the given content part.
9919 * @param obj The layout object
9920 * @param swallow The SWALLOW part to get its content
9922 * @return The swallowed object or NULL if none or an error occurred
9924 * @see elm_object_content_part_set()
9928 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9930 * Unset the layout content.
9932 * @param obj The layout object
9933 * @param swallow The swallow part name in the edje file
9934 * @return The content that was being used
9936 * Unparent and return the content object which was set for this part.
9938 * @see elm_object_content_part_set()
9942 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9944 * Set the text of the given part
9946 * @param obj The layout object
9947 * @param part The TEXT part where to set the text
9948 * @param text The text to set
9951 * @deprecated use elm_object_text_part_set() instead.
9953 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9955 * Get the text set in the given part
9957 * @param obj The layout object
9958 * @param part The TEXT part to retrieve the text off
9960 * @return The text set in @p part
9963 * @deprecated use elm_object_text_part_get() instead.
9965 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9967 * Append child to layout box part.
9969 * @param obj the layout object
9970 * @param part the box part to which the object will be appended.
9971 * @param child the child object to append to box.
9973 * Once the object is appended, it will become child of the layout. Its
9974 * lifetime will be bound to the layout, whenever the layout dies the child
9975 * will be deleted automatically. One should use elm_layout_box_remove() to
9976 * make this layout forget about the object.
9978 * @see elm_layout_box_prepend()
9979 * @see elm_layout_box_insert_before()
9980 * @see elm_layout_box_insert_at()
9981 * @see elm_layout_box_remove()
9985 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9987 * Prepend child to layout box part.
9989 * @param obj the layout object
9990 * @param part the box part to prepend.
9991 * @param child the child object to prepend to box.
9993 * Once the object is prepended, it will become child of the layout. Its
9994 * lifetime will be bound to the layout, whenever the layout dies the child
9995 * will be deleted automatically. One should use elm_layout_box_remove() to
9996 * make this layout forget about the object.
9998 * @see elm_layout_box_append()
9999 * @see elm_layout_box_insert_before()
10000 * @see elm_layout_box_insert_at()
10001 * @see elm_layout_box_remove()
10005 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10007 * Insert child to layout box part before a reference object.
10009 * @param obj the layout object
10010 * @param part the box part to insert.
10011 * @param child the child object to insert into box.
10012 * @param reference another reference object to insert before in box.
10014 * Once the object is inserted, it will become child of the layout. Its
10015 * lifetime will be bound to the layout, whenever the layout dies the child
10016 * will be deleted automatically. One should use elm_layout_box_remove() to
10017 * make this layout forget about the object.
10019 * @see elm_layout_box_append()
10020 * @see elm_layout_box_prepend()
10021 * @see elm_layout_box_insert_before()
10022 * @see elm_layout_box_remove()
10026 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10028 * Insert child to layout box part at a given position.
10030 * @param obj the layout object
10031 * @param part the box part to insert.
10032 * @param child the child object to insert into box.
10033 * @param pos the numeric position >=0 to insert the child.
10035 * Once the object is inserted, it will become child of the layout. Its
10036 * lifetime will be bound to the layout, whenever the layout dies the child
10037 * will be deleted automatically. One should use elm_layout_box_remove() to
10038 * make this layout forget about the object.
10040 * @see elm_layout_box_append()
10041 * @see elm_layout_box_prepend()
10042 * @see elm_layout_box_insert_before()
10043 * @see elm_layout_box_remove()
10047 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10049 * Remove a child of the given part box.
10051 * @param obj The layout object
10052 * @param part The box part name to remove child.
10053 * @param child The object to remove from box.
10054 * @return The object that was being used, or NULL if not found.
10056 * The object will be removed from the box part and its lifetime will
10057 * not be handled by the layout anymore. This is equivalent to
10058 * elm_object_content_part_unset() for box.
10060 * @see elm_layout_box_append()
10061 * @see elm_layout_box_remove_all()
10065 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10067 * Remove all child of the given part box.
10069 * @param obj The layout object
10070 * @param part The box part name to remove child.
10071 * @param clear If EINA_TRUE, then all objects will be deleted as
10072 * well, otherwise they will just be removed and will be
10073 * dangling on the canvas.
10075 * The objects will be removed from the box part and their lifetime will
10076 * not be handled by the layout anymore. This is equivalent to
10077 * elm_layout_box_remove() for all box children.
10079 * @see elm_layout_box_append()
10080 * @see elm_layout_box_remove()
10084 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10086 * Insert child to layout table part.
10088 * @param obj the layout object
10089 * @param part the box part to pack child.
10090 * @param child_obj the child object to pack into table.
10091 * @param col the column to which the child should be added. (>= 0)
10092 * @param row the row to which the child should be added. (>= 0)
10093 * @param colspan how many columns should be used to store this object. (>=
10095 * @param rowspan how many rows should be used to store this object. (>= 1)
10097 * Once the object is inserted, it will become child of the table. Its
10098 * lifetime will be bound to the layout, and whenever the layout dies the
10099 * child will be deleted automatically. One should use
10100 * elm_layout_table_remove() to make this layout forget about the object.
10102 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10103 * more space than a single cell. For instance, the following code:
10105 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10108 * Would result in an object being added like the following picture:
10110 * @image html layout_colspan.png
10111 * @image latex layout_colspan.eps width=\textwidth
10113 * @see elm_layout_table_unpack()
10114 * @see elm_layout_table_clear()
10118 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);
10120 * Unpack (remove) a child of the given part table.
10122 * @param obj The layout object
10123 * @param part The table part name to remove child.
10124 * @param child_obj The object to remove from table.
10125 * @return The object that was being used, or NULL if not found.
10127 * The object will be unpacked from the table part and its lifetime
10128 * will not be handled by the layout anymore. This is equivalent to
10129 * elm_object_content_part_unset() for table.
10131 * @see elm_layout_table_pack()
10132 * @see elm_layout_table_clear()
10136 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10138 * Remove all child of the given part table.
10140 * @param obj The layout object
10141 * @param part The table part name to remove child.
10142 * @param clear If EINA_TRUE, then all objects will be deleted as
10143 * well, otherwise they will just be removed and will be
10144 * dangling on the canvas.
10146 * The objects will be removed from the table part and their lifetime will
10147 * not be handled by the layout anymore. This is equivalent to
10148 * elm_layout_table_unpack() for all table children.
10150 * @see elm_layout_table_pack()
10151 * @see elm_layout_table_unpack()
10155 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10157 * Get the edje layout
10159 * @param obj The layout object
10161 * @return A Evas_Object with the edje layout settings loaded
10162 * with function elm_layout_file_set
10164 * This returns the edje object. It is not expected to be used to then
10165 * swallow objects via edje_object_part_swallow() for example. Use
10166 * elm_object_content_part_set() instead so child object handling and sizing is
10169 * @note This function should only be used if you really need to call some
10170 * low level Edje function on this edje object. All the common stuff (setting
10171 * text, emitting signals, hooking callbacks to signals, etc.) can be done
10172 * with proper elementary functions.
10174 * @see elm_object_signal_callback_add()
10175 * @see elm_object_signal_emit()
10176 * @see elm_object_text_part_set()
10177 * @see elm_object_content_part_set()
10178 * @see elm_layout_box_append()
10179 * @see elm_layout_table_pack()
10180 * @see elm_layout_data_get()
10184 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10186 * Get the edje data from the given layout
10188 * @param obj The layout object
10189 * @param key The data key
10191 * @return The edje data string
10193 * This function fetches data specified inside the edje theme of this layout.
10194 * This function return NULL if data is not found.
10196 * In EDC this comes from a data block within the group block that @p
10197 * obj was loaded from. E.g.
10204 * item: "key1" "value1";
10205 * item: "key2" "value2";
10213 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10217 * @param obj The layout object
10219 * Manually forces a sizing re-evaluation. This is useful when the minimum
10220 * size required by the edje theme of this layout has changed. The change on
10221 * the minimum size required by the edje theme is not immediately reported to
10222 * the elementary layout, so one needs to call this function in order to tell
10223 * the widget (layout) that it needs to reevaluate its own size.
10225 * The minimum size of the theme is calculated based on minimum size of
10226 * parts, the size of elements inside containers like box and table, etc. All
10227 * of this can change due to state changes, and that's when this function
10228 * should be called.
10230 * Also note that a standard signal of "size,eval" "elm" emitted from the
10231 * edje object will cause this to happen too.
10235 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10238 * Sets a specific cursor for an edje part.
10240 * @param obj The layout object.
10241 * @param part_name a part from loaded edje group.
10242 * @param cursor cursor name to use, see Elementary_Cursor.h
10244 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10245 * part not exists or it has "mouse_events: 0".
10249 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10252 * Get the cursor to be shown when mouse is over an edje part
10254 * @param obj The layout object.
10255 * @param part_name a part from loaded edje group.
10256 * @return the cursor name.
10260 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10263 * Unsets a cursor previously set with elm_layout_part_cursor_set().
10265 * @param obj The layout object.
10266 * @param part_name a part from loaded edje group, that had a cursor set
10267 * with elm_layout_part_cursor_set().
10271 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10274 * Sets a specific cursor style for an edje part.
10276 * @param obj The layout object.
10277 * @param part_name a part from loaded edje group.
10278 * @param style the theme style to use (default, transparent, ...)
10280 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10281 * part not exists or it did not had a cursor set.
10285 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10288 * Gets a specific cursor style for an edje part.
10290 * @param obj The layout object.
10291 * @param part_name a part from loaded edje group.
10293 * @return the theme style in use, defaults to "default". If the
10294 * object does not have a cursor set, then NULL is returned.
10298 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10301 * Sets if the cursor set should be searched on the theme or should use
10302 * the provided by the engine, only.
10304 * @note before you set if should look on theme you should define a
10305 * cursor with elm_layout_part_cursor_set(). By default it will only
10306 * look for cursors provided by the engine.
10308 * @param obj The layout object.
10309 * @param part_name a part from loaded edje group.
10310 * @param engine_only if cursors should be just provided by the engine
10311 * or should also search on widget's theme as well
10313 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10314 * part not exists or it did not had a cursor set.
10318 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);
10321 * Gets a specific cursor engine_only for an edje part.
10323 * @param obj The layout object.
10324 * @param part_name a part from loaded edje group.
10326 * @return whenever the cursor is just provided by engine or also from theme.
10330 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10333 * @def elm_layout_icon_set
10334 * Convienience macro to set the icon object in a layout that follows the
10335 * Elementary naming convention for its parts.
10339 #define elm_layout_icon_set(_ly, _obj) \
10342 elm_object_content_part_set((_ly), "elm.swallow.icon", (_obj)); \
10343 if ((_obj)) sig = "elm,state,icon,visible"; \
10344 else sig = "elm,state,icon,hidden"; \
10345 elm_object_signal_emit((_ly), sig, "elm"); \
10349 * @def elm_layout_icon_get
10350 * Convienience macro to get the icon object from a layout that follows the
10351 * Elementary naming convention for its parts.
10355 #define elm_layout_icon_get(_ly) \
10356 elm_object_content_part_get((_ly), "elm.swallow.icon")
10359 * @def elm_layout_end_set
10360 * Convienience macro to set the end object in a layout that follows the
10361 * Elementary naming convention for its parts.
10365 #define elm_layout_end_set(_ly, _obj) \
10368 elm_object_content_part_set((_ly), "elm.swallow.end", (_obj)); \
10369 if ((_obj)) sig = "elm,state,end,visible"; \
10370 else sig = "elm,state,end,hidden"; \
10371 elm_object_signal_emit((_ly), sig, "elm"); \
10375 * @def elm_layout_end_get
10376 * Convienience macro to get the end object in a layout that follows the
10377 * Elementary naming convention for its parts.
10381 #define elm_layout_end_get(_ly) \
10382 elm_object_content_part_get((_ly), "elm.swallow.end")
10385 * @def elm_layout_label_set
10386 * Convienience macro to set the label in a layout that follows the
10387 * Elementary naming convention for its parts.
10390 * @deprecated use elm_object_text_set() instead.
10392 #define elm_layout_label_set(_ly, _txt) \
10393 elm_layout_text_set((_ly), "elm.text", (_txt))
10396 * @def elm_layout_label_get
10397 * Convenience macro to get the label in a layout that follows the
10398 * Elementary naming convention for its parts.
10401 * @deprecated use elm_object_text_set() instead.
10403 #define elm_layout_label_get(_ly) \
10404 elm_layout_text_get((_ly), "elm.text")
10406 /* smart callbacks called:
10407 * "theme,changed" - when elm theme is changed.
10411 * @defgroup Notify Notify
10413 * @image html img/widget/notify/preview-00.png
10414 * @image latex img/widget/notify/preview-00.eps
10416 * Display a container in a particular region of the parent(top, bottom,
10417 * etc). A timeout can be set to automatically hide the notify. This is so
10418 * that, after an evas_object_show() on a notify object, if a timeout was set
10419 * on it, it will @b automatically get hidden after that time.
10421 * Signals that you can add callbacks for are:
10422 * @li "timeout" - when timeout happens on notify and it's hidden
10423 * @li "block,clicked" - when a click outside of the notify happens
10425 * Default contents parts of the notify widget that you can use for are:
10426 * @li "elm.swallow.content" - A content of the notify
10428 * @ref tutorial_notify show usage of the API.
10433 * @brief Possible orient values for notify.
10435 * This values should be used in conjunction to elm_notify_orient_set() to
10436 * set the position in which the notify should appear(relative to its parent)
10437 * and in conjunction with elm_notify_orient_get() to know where the notify
10440 typedef enum _Elm_Notify_Orient
10442 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10443 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10444 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10445 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10446 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10447 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10448 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10449 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10450 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10451 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10452 } Elm_Notify_Orient;
10454 * @brief Add a new notify to the parent
10456 * @param parent The parent object
10457 * @return The new object or NULL if it cannot be created
10459 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10461 * @brief Set the content of the notify widget
10463 * @param obj The notify object
10464 * @param content The content will be filled in this notify object
10466 * Once the content object is set, a previously set one will be deleted. If
10467 * you want to keep that old content object, use the
10468 * elm_notify_content_unset() function.
10470 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10472 * @brief Unset the content of the notify widget
10474 * @param obj The notify object
10475 * @return The content that was being used
10477 * Unparent and return the content object which was set for this widget
10479 * @see elm_notify_content_set()
10481 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10483 * @brief Return the content of the notify widget
10485 * @param obj The notify object
10486 * @return The content that is being used
10488 * @see elm_notify_content_set()
10490 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10492 * @brief Set the notify parent
10494 * @param obj The notify object
10495 * @param content The new parent
10497 * Once the parent object is set, a previously set one will be disconnected
10500 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10502 * @brief Get the notify parent
10504 * @param obj The notify object
10505 * @return The parent
10507 * @see elm_notify_parent_set()
10509 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10511 * @brief Set the orientation
10513 * @param obj The notify object
10514 * @param orient The new orientation
10516 * Sets the position in which the notify will appear in its parent.
10518 * @see @ref Elm_Notify_Orient for possible values.
10520 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10522 * @brief Return the orientation
10523 * @param obj The notify object
10524 * @return The orientation of the notification
10526 * @see elm_notify_orient_set()
10527 * @see Elm_Notify_Orient
10529 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10531 * @brief Set the time interval after which the notify window is going to be
10534 * @param obj The notify object
10535 * @param time The timeout in seconds
10537 * This function sets a timeout and starts the timer controlling when the
10538 * notify is hidden. Since calling evas_object_show() on a notify restarts
10539 * the timer controlling when the notify is hidden, setting this before the
10540 * notify is shown will in effect mean starting the timer when the notify is
10543 * @note Set a value <= 0.0 to disable a running timer.
10545 * @note If the value > 0.0 and the notify is previously visible, the
10546 * timer will be started with this value, canceling any running timer.
10548 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10550 * @brief Return the timeout value (in seconds)
10551 * @param obj the notify object
10553 * @see elm_notify_timeout_set()
10555 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10557 * @brief Sets whether events should be passed to by a click outside
10560 * @param obj The notify object
10561 * @param repeats EINA_TRUE Events are repeats, else no
10563 * When true if the user clicks outside the window the events will be caught
10564 * by the others widgets, else the events are blocked.
10566 * @note The default value is EINA_TRUE.
10568 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10570 * @brief Return true if events are repeat below the notify object
10571 * @param obj the notify object
10573 * @see elm_notify_repeat_events_set()
10575 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10581 * @defgroup Hover Hover
10583 * @image html img/widget/hover/preview-00.png
10584 * @image latex img/widget/hover/preview-00.eps
10586 * A Hover object will hover over its @p parent object at the @p target
10587 * location. Anything in the background will be given a darker coloring to
10588 * indicate that the hover object is on top (at the default theme). When the
10589 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10590 * clicked that @b doesn't cause the hover to be dismissed.
10592 * A Hover object has two parents. One parent that owns it during creation
10593 * and the other parent being the one over which the hover object spans.
10596 * @note The hover object will take up the entire space of @p target
10599 * Elementary has the following styles for the hover widget:
10603 * @li hoversel_vertical
10605 * The following are the available position for content:
10617 * Signals that you can add callbacks for are:
10618 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10619 * @li "smart,changed" - a content object placed under the "smart"
10620 * policy was replaced to a new slot direction.
10622 * See @ref tutorial_hover for more information.
10626 typedef enum _Elm_Hover_Axis
10628 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10629 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10630 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10631 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10634 * @brief Adds a hover object to @p parent
10636 * @param parent The parent object
10637 * @return The hover object or NULL if one could not be created
10639 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10641 * @brief Sets the target object for the hover.
10643 * @param obj The hover object
10644 * @param target The object to center the hover onto. The hover
10646 * This function will cause the hover to be centered on the target object.
10648 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10650 * @brief Gets the target object for the hover.
10652 * @param obj The hover object
10653 * @param parent The object to locate the hover over.
10655 * @see elm_hover_target_set()
10657 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10659 * @brief Sets the parent object for the hover.
10661 * @param obj The hover object
10662 * @param parent The object to locate the hover over.
10664 * This function will cause the hover to take up the entire space that the
10665 * parent object fills.
10667 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10669 * @brief Gets the parent object for the hover.
10671 * @param obj The hover object
10672 * @return The parent object to locate the hover over.
10674 * @see elm_hover_parent_set()
10676 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10678 * @brief Sets the content of the hover object and the direction in which it
10681 * @param obj The hover object
10682 * @param swallow The direction that the object will be displayed
10683 * at. Accepted values are "left", "top-left", "top", "top-right",
10684 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10686 * @param content The content to place at @p swallow
10688 * Once the content object is set for a given direction, a previously
10689 * set one (on the same direction) will be deleted. If you want to
10690 * keep that old content object, use the elm_hover_content_unset()
10693 * All directions may have contents at the same time, except for
10694 * "smart". This is a special placement hint and its use case
10695 * independs of the calculations coming from
10696 * elm_hover_best_content_location_get(). Its use is for cases when
10697 * one desires only one hover content, but with a dinamic special
10698 * placement within the hover area. The content's geometry, whenever
10699 * it changes, will be used to decide on a best location not
10700 * extrapolating the hover's parent object view to show it in (still
10701 * being the hover's target determinant of its medium part -- move and
10702 * resize it to simulate finger sizes, for example). If one of the
10703 * directions other than "smart" are used, a previously content set
10704 * using it will be deleted, and vice-versa.
10706 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10708 * @brief Get the content of the hover object, in a given direction.
10710 * Return the content object which was set for this widget in the
10711 * @p swallow direction.
10713 * @param obj The hover object
10714 * @param swallow The direction that the object was display at.
10715 * @return The content that was being used
10717 * @see elm_hover_content_set()
10719 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10721 * @brief Unset the content of the hover object, in a given direction.
10723 * Unparent and return the content object set at @p swallow direction.
10725 * @param obj The hover object
10726 * @param swallow The direction that the object was display at.
10727 * @return The content that was being used.
10729 * @see elm_hover_content_set()
10731 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10733 * @brief Returns the best swallow location for content in the hover.
10735 * @param obj The hover object
10736 * @param pref_axis The preferred orientation axis for the hover object to use
10737 * @return The edje location to place content into the hover or @c
10740 * Best is defined here as the location at which there is the most available
10743 * @p pref_axis may be one of
10744 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10745 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10746 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10747 * - @c ELM_HOVER_AXIS_BOTH -- both
10749 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10750 * nescessarily be along the horizontal axis("left" or "right"). If
10751 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10752 * be along the vertical axis("top" or "bottom"). Chossing
10753 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10754 * returned position may be in either axis.
10756 * @see elm_hover_content_set()
10758 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10765 * @defgroup Entry Entry
10767 * @image html img/widget/entry/preview-00.png
10768 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10769 * @image html img/widget/entry/preview-01.png
10770 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10771 * @image html img/widget/entry/preview-02.png
10772 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10773 * @image html img/widget/entry/preview-03.png
10774 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10776 * An entry is a convenience widget which shows a box that the user can
10777 * enter text into. Entries by default don't scroll, so they grow to
10778 * accomodate the entire text, resizing the parent window as needed. This
10779 * can be changed with the elm_entry_scrollable_set() function.
10781 * They can also be single line or multi line (the default) and when set
10782 * to multi line mode they support text wrapping in any of the modes
10783 * indicated by #Elm_Wrap_Type.
10785 * Other features include password mode, filtering of inserted text with
10786 * elm_entry_text_filter_append() and related functions, inline "items" and
10787 * formatted markup text.
10789 * @section entry-markup Formatted text
10791 * The markup tags supported by the Entry are defined by the theme, but
10792 * even when writing new themes or extensions it's a good idea to stick to
10793 * a sane default, to maintain coherency and avoid application breakages.
10794 * Currently defined by the default theme are the following tags:
10795 * @li \<br\>: Inserts a line break.
10796 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10798 * @li \<tab\>: Inserts a tab.
10799 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10801 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10802 * @li \<link\>...\</link\>: Underlines the enclosed text.
10803 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10805 * @section entry-special Special markups
10807 * Besides those used to format text, entries support two special markup
10808 * tags used to insert clickable portions of text or items inlined within
10811 * @subsection entry-anchors Anchors
10813 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10814 * \</a\> tags and an event will be generated when this text is clicked,
10818 * This text is outside <a href=anc-01>but this one is an anchor</a>
10821 * The @c href attribute in the opening tag gives the name that will be
10822 * used to identify the anchor and it can be any valid utf8 string.
10824 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10825 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10826 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10827 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10830 * @subsection entry-items Items
10832 * Inlined in the text, any other @c Evas_Object can be inserted by using
10833 * \<item\> tags this way:
10836 * <item size=16x16 vsize=full href=emoticon/haha></item>
10839 * Just like with anchors, the @c href identifies each item, but these need,
10840 * in addition, to indicate their size, which is done using any one of
10841 * @c size, @c absize or @c relsize attributes. These attributes take their
10842 * value in the WxH format, where W is the width and H the height of the
10845 * @li absize: Absolute pixel size for the item. Whatever value is set will
10846 * be the item's size regardless of any scale value the object may have
10847 * been set to. The final line height will be adjusted to fit larger items.
10848 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10850 * @li relsize: Size is adjusted for the item to fit within the current
10853 * Besides their size, items are specificed a @c vsize value that affects
10854 * how their final size and position are calculated. The possible values
10856 * @li ascent: Item will be placed within the line's baseline and its
10857 * ascent. That is, the height between the line where all characters are
10858 * positioned and the highest point in the line. For @c size and @c absize
10859 * items, the descent value will be added to the total line height to make
10860 * them fit. @c relsize items will be adjusted to fit within this space.
10861 * @li full: Items will be placed between the descent and ascent, or the
10862 * lowest point in the line and its highest.
10864 * The next image shows different configurations of items and how they
10865 * are the previously mentioned options affect their sizes. In all cases,
10866 * the green line indicates the ascent, blue for the baseline and red for
10869 * @image html entry_item.png
10870 * @image latex entry_item.eps width=\textwidth
10872 * And another one to show how size differs from absize. In the first one,
10873 * the scale value is set to 1.0, while the second one is using one of 2.0.
10875 * @image html entry_item_scale.png
10876 * @image latex entry_item_scale.eps width=\textwidth
10878 * After the size for an item is calculated, the entry will request an
10879 * object to place in its space. For this, the functions set with
10880 * elm_entry_item_provider_append() and related functions will be called
10881 * in order until one of them returns a @c non-NULL value. If no providers
10882 * are available, or all of them return @c NULL, then the entry falls back
10883 * to one of the internal defaults, provided the name matches with one of
10886 * All of the following are currently supported:
10889 * - emoticon/angry-shout
10890 * - emoticon/crazy-laugh
10891 * - emoticon/evil-laugh
10893 * - emoticon/goggle-smile
10894 * - emoticon/grumpy
10895 * - emoticon/grumpy-smile
10896 * - emoticon/guilty
10897 * - emoticon/guilty-smile
10899 * - emoticon/half-smile
10900 * - emoticon/happy-panting
10902 * - emoticon/indifferent
10904 * - emoticon/knowing-grin
10906 * - emoticon/little-bit-sorry
10907 * - emoticon/love-lots
10909 * - emoticon/minimal-smile
10910 * - emoticon/not-happy
10911 * - emoticon/not-impressed
10913 * - emoticon/opensmile
10916 * - emoticon/squint-laugh
10917 * - emoticon/surprised
10918 * - emoticon/suspicious
10919 * - emoticon/tongue-dangling
10920 * - emoticon/tongue-poke
10922 * - emoticon/unhappy
10923 * - emoticon/very-sorry
10926 * - emoticon/worried
10929 * Alternatively, an item may reference an image by its path, using
10930 * the URI form @c file:///path/to/an/image.png and the entry will then
10931 * use that image for the item.
10933 * @section entry-files Loading and saving files
10935 * Entries have convinience functions to load text from a file and save
10936 * changes back to it after a short delay. The automatic saving is enabled
10937 * by default, but can be disabled with elm_entry_autosave_set() and files
10938 * can be loaded directly as plain text or have any markup in them
10939 * recognized. See elm_entry_file_set() for more details.
10941 * @section entry-signals Emitted signals
10943 * This widget emits the following signals:
10945 * @li "changed": The text within the entry was changed.
10946 * @li "changed,user": The text within the entry was changed because of user interaction.
10947 * @li "activated": The enter key was pressed on a single line entry.
10948 * @li "press": A mouse button has been pressed on the entry.
10949 * @li "longpressed": A mouse button has been pressed and held for a couple
10951 * @li "clicked": The entry has been clicked (mouse press and release).
10952 * @li "clicked,double": The entry has been double clicked.
10953 * @li "clicked,triple": The entry has been triple clicked.
10954 * @li "focused": The entry has received focus.
10955 * @li "unfocused": The entry has lost focus.
10956 * @li "selection,paste": A paste of the clipboard contents was requested.
10957 * @li "selection,copy": A copy of the selected text into the clipboard was
10959 * @li "selection,cut": A cut of the selected text into the clipboard was
10961 * @li "selection,start": A selection has begun and no previous selection
10963 * @li "selection,changed": The current selection has changed.
10964 * @li "selection,cleared": The current selection has been cleared.
10965 * @li "cursor,changed": The cursor has changed position.
10966 * @li "anchor,clicked": An anchor has been clicked. The event_info
10967 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10968 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10969 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10970 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10971 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10972 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10973 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10974 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10975 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10976 * @li "preedit,changed": The preedit string has changed.
10977 * @li "language,changed": Program language changed.
10979 * @section entry-examples
10981 * An overview of the Entry API can be seen in @ref entry_example_01
10986 * @typedef Elm_Entry_Anchor_Info
10988 * The info sent in the callback for the "anchor,clicked" signals emitted
10991 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10993 * @struct _Elm_Entry_Anchor_Info
10995 * The info sent in the callback for the "anchor,clicked" signals emitted
10998 struct _Elm_Entry_Anchor_Info
11000 const char *name; /**< The name of the anchor, as stated in its href */
11001 int button; /**< The mouse button used to click on it */
11002 Evas_Coord x, /**< Anchor geometry, relative to canvas */
11003 y, /**< Anchor geometry, relative to canvas */
11004 w, /**< Anchor geometry, relative to canvas */
11005 h; /**< Anchor geometry, relative to canvas */
11008 * @typedef Elm_Entry_Filter_Cb
11009 * This callback type is used by entry filters to modify text.
11010 * @param data The data specified as the last param when adding the filter
11011 * @param entry The entry object
11012 * @param text A pointer to the location of the text being filtered. This data can be modified,
11013 * but any additional allocations must be managed by the user.
11014 * @see elm_entry_text_filter_append
11015 * @see elm_entry_text_filter_prepend
11017 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11020 * This adds an entry to @p parent object.
11022 * By default, entries are:
11026 * @li autosave is enabled
11028 * @param parent The parent object
11029 * @return The new object or NULL if it cannot be created
11031 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11033 * Sets the entry to single line mode.
11035 * In single line mode, entries don't ever wrap when the text reaches the
11036 * edge, and instead they keep growing horizontally. Pressing the @c Enter
11037 * key will generate an @c "activate" event instead of adding a new line.
11039 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11040 * and pressing enter will break the text into a different line
11041 * without generating any events.
11043 * @param obj The entry object
11044 * @param single_line If true, the text in the entry
11045 * will be on a single line.
11047 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11049 * Gets whether the entry is set to be single line.
11051 * @param obj The entry object
11052 * @return single_line If true, the text in the entry is set to display
11053 * on a single line.
11055 * @see elm_entry_single_line_set()
11057 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11059 * Sets the entry to password mode.
11061 * In password mode, entries are implicitly single line and the display of
11062 * any text in them is replaced with asterisks (*).
11064 * @param obj The entry object
11065 * @param password If true, password mode is enabled.
11067 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11069 * Gets whether the entry is set to password mode.
11071 * @param obj The entry object
11072 * @return If true, the entry is set to display all characters
11073 * as asterisks (*).
11075 * @see elm_entry_password_set()
11077 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11079 * This sets the text displayed within the entry to @p entry.
11081 * @param obj The entry object
11082 * @param entry The text to be displayed
11084 * @deprecated Use elm_object_text_set() instead.
11085 * @note Using this function bypasses text filters
11087 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11089 * This returns the text currently shown in object @p entry.
11090 * See also elm_entry_entry_set().
11092 * @param obj The entry object
11093 * @return The currently displayed text or NULL on failure
11095 * @deprecated Use elm_object_text_get() instead.
11097 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11099 * Appends @p entry to the text of the entry.
11101 * Adds the text in @p entry to the end of any text already present in the
11104 * The appended text is subject to any filters set for the widget.
11106 * @param obj The entry object
11107 * @param entry The text to be displayed
11109 * @see elm_entry_text_filter_append()
11111 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11113 * Gets whether the entry is empty.
11115 * Empty means no text at all. If there are any markup tags, like an item
11116 * tag for which no provider finds anything, and no text is displayed, this
11117 * function still returns EINA_FALSE.
11119 * @param obj The entry object
11120 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11122 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11124 * Gets any selected text within the entry.
11126 * If there's any selected text in the entry, this function returns it as
11127 * a string in markup format. NULL is returned if no selection exists or
11128 * if an error occurred.
11130 * The returned value points to an internal string and should not be freed
11131 * or modified in any way. If the @p entry object is deleted or its
11132 * contents are changed, the returned pointer should be considered invalid.
11134 * @param obj The entry object
11135 * @return The selected text within the entry or NULL on failure
11137 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11139 * Inserts the given text into the entry at the current cursor position.
11141 * This inserts text at the cursor position as if it was typed
11142 * by the user (note that this also allows markup which a user
11143 * can't just "type" as it would be converted to escaped text, so this
11144 * call can be used to insert things like emoticon items or bold push/pop
11145 * tags, other font and color change tags etc.)
11147 * If any selection exists, it will be replaced by the inserted text.
11149 * The inserted text is subject to any filters set for the widget.
11151 * @param obj The entry object
11152 * @param entry The text to insert
11154 * @see elm_entry_text_filter_append()
11156 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11158 * Set the line wrap type to use on multi-line entries.
11160 * Sets the wrap type used by the entry to any of the specified in
11161 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11162 * line (without inserting a line break or paragraph separator) when it
11163 * reaches the far edge of the widget.
11165 * Note that this only makes sense for multi-line entries. A widget set
11166 * to be single line will never wrap.
11168 * @param obj The entry object
11169 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11171 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11172 EINA_DEPRECATED EAPI void elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
11174 * Gets the wrap mode the entry was set to use.
11176 * @param obj The entry object
11177 * @return Wrap type
11179 * @see also elm_entry_line_wrap_set()
11181 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11183 * Sets if the entry is to be editable or not.
11185 * By default, entries are editable and when focused, any text input by the
11186 * user will be inserted at the current cursor position. But calling this
11187 * function with @p editable as EINA_FALSE will prevent the user from
11188 * inputting text into the entry.
11190 * The only way to change the text of a non-editable entry is to use
11191 * elm_object_text_set(), elm_entry_entry_insert() and other related
11194 * @param obj The entry object
11195 * @param editable If EINA_TRUE, user input will be inserted in the entry,
11196 * if not, the entry is read-only and no user input is allowed.
11198 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11200 * Gets whether the entry is editable or not.
11202 * @param obj The entry object
11203 * @return If true, the entry is editable by the user.
11204 * If false, it is not editable by the user
11206 * @see elm_entry_editable_set()
11208 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11210 * This drops any existing text selection within the entry.
11212 * @param obj The entry object
11214 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11216 * This selects all text within the entry.
11218 * @param obj The entry object
11220 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11222 * This moves the cursor one place to the right within the entry.
11224 * @param obj The entry object
11225 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11227 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11229 * This moves the cursor one place to the left within the entry.
11231 * @param obj The entry object
11232 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11234 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11236 * This moves the cursor one line up within the entry.
11238 * @param obj The entry object
11239 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11241 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11243 * This moves the cursor one line down within the entry.
11245 * @param obj The entry object
11246 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11248 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11250 * This moves the cursor to the beginning of the entry.
11252 * @param obj The entry object
11254 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11256 * This moves the cursor to the end of the entry.
11258 * @param obj The entry object
11260 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11262 * This moves the cursor to the beginning of the current line.
11264 * @param obj The entry object
11266 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11268 * This moves the cursor to the end of the current line.
11270 * @param obj The entry object
11272 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11274 * This begins a selection within the entry as though
11275 * the user were holding down the mouse button to make a selection.
11277 * @param obj The entry object
11279 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11281 * This ends a selection within the entry as though
11282 * the user had just released the mouse button while making a selection.
11284 * @param obj The entry object
11286 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11288 * Gets whether a format node exists at the current cursor position.
11290 * A format node is anything that defines how the text is rendered. It can
11291 * be a visible format node, such as a line break or a paragraph separator,
11292 * or an invisible one, such as bold begin or end tag.
11293 * This function returns whether any format node exists at the current
11296 * @param obj The entry object
11297 * @return EINA_TRUE if the current cursor position contains a format node,
11298 * EINA_FALSE otherwise.
11300 * @see elm_entry_cursor_is_visible_format_get()
11302 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11304 * Gets if the current cursor position holds a visible format node.
11306 * @param obj The entry object
11307 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11308 * if it's an invisible one or no format exists.
11310 * @see elm_entry_cursor_is_format_get()
11312 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11314 * Gets the character pointed by the cursor at its current position.
11316 * This function returns a string with the utf8 character stored at the
11317 * current cursor position.
11318 * Only the text is returned, any format that may exist will not be part
11319 * of the return value.
11321 * @param obj The entry object
11322 * @return The text pointed by the cursors.
11324 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11326 * This function returns the geometry of the cursor.
11328 * It's useful if you want to draw something on the cursor (or where it is),
11329 * or for example in the case of scrolled entry where you want to show the
11332 * @param obj The entry object
11333 * @param x returned geometry
11334 * @param y returned geometry
11335 * @param w returned geometry
11336 * @param h returned geometry
11337 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11339 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);
11341 * Sets the cursor position in the entry to the given value
11343 * The value in @p pos is the index of the character position within the
11344 * contents of the string as returned by elm_entry_cursor_pos_get().
11346 * @param obj The entry object
11347 * @param pos The position of the cursor
11349 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11351 * Retrieves the current position of the cursor in the entry
11353 * @param obj The entry object
11354 * @return The cursor position
11356 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11358 * This executes a "cut" action on the selected text in the entry.
11360 * @param obj The entry object
11362 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11364 * This executes a "copy" action on the selected text in the entry.
11366 * @param obj The entry object
11368 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11370 * This executes a "paste" action in the entry.
11372 * @param obj The entry object
11374 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11376 * This clears and frees the items in a entry's contextual (longpress)
11379 * @param obj The entry object
11381 * @see elm_entry_context_menu_item_add()
11383 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11385 * This adds an item to the entry's contextual menu.
11387 * A longpress on an entry will make the contextual menu show up, if this
11388 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11389 * By default, this menu provides a few options like enabling selection mode,
11390 * which is useful on embedded devices that need to be explicit about it,
11391 * and when a selection exists it also shows the copy and cut actions.
11393 * With this function, developers can add other options to this menu to
11394 * perform any action they deem necessary.
11396 * @param obj The entry object
11397 * @param label The item's text label
11398 * @param icon_file The item's icon file
11399 * @param icon_type The item's icon type
11400 * @param func The callback to execute when the item is clicked
11401 * @param data The data to associate with the item for related functions
11403 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);
11405 * This disables the entry's contextual (longpress) menu.
11407 * @param obj The entry object
11408 * @param disabled If true, the menu is disabled
11410 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11412 * This returns whether the entry's contextual (longpress) menu is
11415 * @param obj The entry object
11416 * @return If true, the menu is disabled
11418 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11420 * This appends a custom item provider to the list for that entry
11422 * This appends the given callback. The list is walked from beginning to end
11423 * with each function called given the item href string in the text. If the
11424 * function returns an object handle other than NULL (it should create an
11425 * object to do this), then this object is used to replace that item. If
11426 * not the next provider is called until one provides an item object, or the
11427 * default provider in entry does.
11429 * @param obj The entry object
11430 * @param func The function called to provide the item object
11431 * @param data The data passed to @p func
11433 * @see @ref entry-items
11435 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);
11437 * This prepends a custom item provider to the list for that entry
11439 * This prepends the given callback. See elm_entry_item_provider_append() for
11442 * @param obj The entry object
11443 * @param func The function called to provide the item object
11444 * @param data The data passed to @p func
11446 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);
11448 * This removes a custom item provider to the list for that entry
11450 * This removes the given callback. See elm_entry_item_provider_append() for
11453 * @param obj The entry object
11454 * @param func The function called to provide the item object
11455 * @param data The data passed to @p func
11457 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);
11459 * Append a filter function for text inserted in the entry
11461 * Append the given callback to the list. This functions will be called
11462 * whenever any text is inserted into the entry, with the text to be inserted
11463 * as a parameter. The callback function is free to alter the text in any way
11464 * it wants, but it must remember to free the given pointer and update it.
11465 * If the new text is to be discarded, the function can free it and set its
11466 * text parameter to NULL. This will also prevent any following filters from
11469 * @param obj The entry object
11470 * @param func The function to use as text filter
11471 * @param data User data to pass to @p func
11473 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11475 * Prepend a filter function for text insdrted in the entry
11477 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11478 * for more information
11480 * @param obj The entry object
11481 * @param func The function to use as text filter
11482 * @param data User data to pass to @p func
11484 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11486 * Remove a filter from the list
11488 * Removes the given callback from the filter list. See
11489 * elm_entry_text_filter_append() for more information.
11491 * @param obj The entry object
11492 * @param func The filter function to remove
11493 * @param data The user data passed when adding the function
11495 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11497 * This converts a markup (HTML-like) string into UTF-8.
11499 * The returned string is a malloc'ed buffer and it should be freed when
11500 * not needed anymore.
11502 * @param s The string (in markup) to be converted
11503 * @return The converted string (in UTF-8). It should be freed.
11505 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11507 * This converts a UTF-8 string into markup (HTML-like).
11509 * The returned string is a malloc'ed buffer and it should be freed when
11510 * not needed anymore.
11512 * @param s The string (in UTF-8) to be converted
11513 * @return The converted string (in markup). It should be freed.
11515 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11517 * This sets the file (and implicitly loads it) for the text to display and
11518 * then edit. All changes are written back to the file after a short delay if
11519 * the entry object is set to autosave (which is the default).
11521 * If the entry had any other file set previously, any changes made to it
11522 * will be saved if the autosave feature is enabled, otherwise, the file
11523 * will be silently discarded and any non-saved changes will be lost.
11525 * @param obj The entry object
11526 * @param file The path to the file to load and save
11527 * @param format The file format
11529 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11531 * Gets the file being edited by the entry.
11533 * This function can be used to retrieve any file set on the entry for
11534 * edition, along with the format used to load and save it.
11536 * @param obj The entry object
11537 * @param file The path to the file to load and save
11538 * @param format The file format
11540 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11542 * This function writes any changes made to the file set with
11543 * elm_entry_file_set()
11545 * @param obj The entry object
11547 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11549 * This sets the entry object to 'autosave' the loaded text file or not.
11551 * @param obj The entry object
11552 * @param autosave Autosave the loaded file or not
11554 * @see elm_entry_file_set()
11556 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11558 * This gets the entry object's 'autosave' status.
11560 * @param obj The entry object
11561 * @return Autosave the loaded file or not
11563 * @see elm_entry_file_set()
11565 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11567 * Control pasting of text and images for the widget.
11569 * Normally the entry allows both text and images to be pasted. By setting
11570 * textonly to be true, this prevents images from being pasted.
11572 * Note this only changes the behaviour of text.
11574 * @param obj The entry object
11575 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11576 * text+image+other.
11578 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11580 * Getting elm_entry text paste/drop mode.
11582 * In textonly mode, only text may be pasted or dropped into the widget.
11584 * @param obj The entry object
11585 * @return If the widget only accepts text from pastes.
11587 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11589 * Enable or disable scrolling in entry
11591 * Normally the entry is not scrollable unless you enable it with this call.
11593 * @param obj The entry object
11594 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11596 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11598 * Get the scrollable state of the entry
11600 * Normally the entry is not scrollable. This gets the scrollable state
11601 * of the entry. See elm_entry_scrollable_set() for more information.
11603 * @param obj The entry object
11604 * @return The scrollable state
11606 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11608 * This sets a widget to be displayed to the left of a scrolled entry.
11610 * @param obj The scrolled entry object
11611 * @param icon The widget to display on the left side of the scrolled
11614 * @note A previously set widget will be destroyed.
11615 * @note If the object being set does not have minimum size hints set,
11616 * it won't get properly displayed.
11618 * @see elm_entry_end_set()
11620 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11622 * Gets the leftmost widget of the scrolled entry. This object is
11623 * owned by the scrolled entry and should not be modified.
11625 * @param obj The scrolled entry object
11626 * @return the left widget inside the scroller
11628 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11630 * Unset the leftmost widget of the scrolled entry, unparenting and
11633 * @param obj The scrolled entry object
11634 * @return the previously set icon sub-object of this entry, on
11637 * @see elm_entry_icon_set()
11639 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11641 * Sets the visibility of the left-side widget of the scrolled entry,
11642 * set by elm_entry_icon_set().
11644 * @param obj The scrolled entry object
11645 * @param setting EINA_TRUE if the object should be displayed,
11646 * EINA_FALSE if not.
11648 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11650 * This sets a widget to be displayed to the end of a scrolled entry.
11652 * @param obj The scrolled entry object
11653 * @param end The widget to display on the right side of the scrolled
11656 * @note A previously set widget will be destroyed.
11657 * @note If the object being set does not have minimum size hints set,
11658 * it won't get properly displayed.
11660 * @see elm_entry_icon_set
11662 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11664 * Gets the endmost widget of the scrolled entry. This object is owned
11665 * by the scrolled entry and should not be modified.
11667 * @param obj The scrolled entry object
11668 * @return the right widget inside the scroller
11670 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11672 * Unset the endmost widget of the scrolled entry, unparenting and
11675 * @param obj The scrolled entry object
11676 * @return the previously set icon sub-object of this entry, on
11679 * @see elm_entry_icon_set()
11681 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11683 * Sets the visibility of the end widget of the scrolled entry, set by
11684 * elm_entry_end_set().
11686 * @param obj The scrolled entry object
11687 * @param setting EINA_TRUE if the object should be displayed,
11688 * EINA_FALSE if not.
11690 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11692 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11695 * Setting an entry to single-line mode with elm_entry_single_line_set()
11696 * will automatically disable the display of scrollbars when the entry
11697 * moves inside its scroller.
11699 * @param obj The scrolled entry object
11700 * @param h The horizontal scrollbar policy to apply
11701 * @param v The vertical scrollbar policy to apply
11703 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11705 * This enables/disables bouncing within the entry.
11707 * This function sets whether the entry will bounce when scrolling reaches
11708 * the end of the contained entry.
11710 * @param obj The scrolled entry object
11711 * @param h The horizontal bounce state
11712 * @param v The vertical bounce state
11714 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11716 * Get the bounce mode
11718 * @param obj The Entry object
11719 * @param h_bounce Allow bounce horizontally
11720 * @param v_bounce Allow bounce vertically
11722 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11724 /* pre-made filters for entries */
11726 * @typedef Elm_Entry_Filter_Limit_Size
11728 * Data for the elm_entry_filter_limit_size() entry filter.
11730 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11732 * @struct _Elm_Entry_Filter_Limit_Size
11734 * Data for the elm_entry_filter_limit_size() entry filter.
11736 struct _Elm_Entry_Filter_Limit_Size
11738 int max_char_count; /**< The maximum number of characters allowed. */
11739 int max_byte_count; /**< The maximum number of bytes allowed*/
11742 * Filter inserted text based on user defined character and byte limits
11744 * Add this filter to an entry to limit the characters that it will accept
11745 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11746 * The funtion works on the UTF-8 representation of the string, converting
11747 * it from the set markup, thus not accounting for any format in it.
11749 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11750 * it as data when setting the filter. In it, it's possible to set limits
11751 * by character count or bytes (any of them is disabled if 0), and both can
11752 * be set at the same time. In that case, it first checks for characters,
11755 * The function will cut the inserted text in order to allow only the first
11756 * number of characters that are still allowed. The cut is made in
11757 * characters, even when limiting by bytes, in order to always contain
11758 * valid ones and avoid half unicode characters making it in.
11760 * This filter, like any others, does not apply when setting the entry text
11761 * directly with elm_object_text_set() (or the deprecated
11762 * elm_entry_entry_set()).
11764 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11766 * @typedef Elm_Entry_Filter_Accept_Set
11768 * Data for the elm_entry_filter_accept_set() entry filter.
11770 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11772 * @struct _Elm_Entry_Filter_Accept_Set
11774 * Data for the elm_entry_filter_accept_set() entry filter.
11776 struct _Elm_Entry_Filter_Accept_Set
11778 const char *accepted; /**< Set of characters accepted in the entry. */
11779 const char *rejected; /**< Set of characters rejected from the entry. */
11782 * Filter inserted text based on accepted or rejected sets of characters
11784 * Add this filter to an entry to restrict the set of accepted characters
11785 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11786 * This structure contains both accepted and rejected sets, but they are
11787 * mutually exclusive.
11789 * The @c accepted set takes preference, so if it is set, the filter will
11790 * only work based on the accepted characters, ignoring anything in the
11791 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11793 * In both cases, the function filters by matching utf8 characters to the
11794 * raw markup text, so it can be used to remove formatting tags.
11796 * This filter, like any others, does not apply when setting the entry text
11797 * directly with elm_object_text_set() (or the deprecated
11798 * elm_entry_entry_set()).
11800 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11802 * Set the input panel layout of the entry
11804 * @param obj The entry object
11805 * @param layout layout type
11807 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11809 * Get the input panel layout of the entry
11811 * @param obj The entry object
11812 * @return layout type
11814 * @see elm_entry_input_panel_layout_set
11816 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11818 * Set the autocapitalization type on the immodule.
11820 * @param obj The entry object
11821 * @param autocapital_type The type of autocapitalization
11823 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
11825 * Retrieve the autocapitalization type on the immodule.
11827 * @param obj The entry object
11828 * @return autocapitalization type
11830 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11832 * Sets the attribute to show the input panel automatically.
11834 * @param obj The entry object
11835 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
11837 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
11839 * Retrieve the attribute to show the input panel automatically.
11841 * @param obj The entry object
11842 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
11844 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11846 EAPI void elm_entry_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11847 EAPI void elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
11848 EAPI void elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
11849 EAPI void elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
11850 EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
11851 EAPI void elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
11852 EAPI void elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
11854 EINA_DEPRECATED EAPI void elm_entry_wrap_width_set(Evas_Object *obj, Evas_Coord w);
11855 EINA_DEPRECATED EAPI Evas_Coord elm_entry_wrap_width_get(const Evas_Object *obj);
11856 EINA_DEPRECATED EAPI void elm_entry_fontsize_set(Evas_Object *obj, int fontsize);
11857 EINA_DEPRECATED EAPI void elm_entry_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11858 EINA_DEPRECATED EAPI void elm_entry_text_align_set(Evas_Object *obj, const char *alignmode);
11864 /* composite widgets - these basically put together basic widgets above
11865 * in convenient packages that do more than basic stuff */
11869 * @defgroup Anchorview Anchorview
11871 * @image html img/widget/anchorview/preview-00.png
11872 * @image latex img/widget/anchorview/preview-00.eps
11874 * Anchorview is for displaying text that contains markup with anchors
11875 * like <c>\<a href=1234\>something\</\></c> in it.
11877 * Besides being styled differently, the anchorview widget provides the
11878 * necessary functionality so that clicking on these anchors brings up a
11879 * popup with user defined content such as "call", "add to contacts" or
11880 * "open web page". This popup is provided using the @ref Hover widget.
11882 * This widget is very similar to @ref Anchorblock, so refer to that
11883 * widget for an example. The only difference Anchorview has is that the
11884 * widget is already provided with scrolling functionality, so if the
11885 * text set to it is too large to fit in the given space, it will scroll,
11886 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11887 * text can be displayed.
11889 * This widget emits the following signals:
11890 * @li "anchor,clicked": will be called when an anchor is clicked. The
11891 * @p event_info parameter on the callback will be a pointer of type
11892 * ::Elm_Entry_Anchorview_Info.
11894 * See @ref Anchorblock for an example on how to use both of them.
11903 * @typedef Elm_Entry_Anchorview_Info
11905 * The info sent in the callback for "anchor,clicked" signals emitted by
11906 * the Anchorview widget.
11908 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11910 * @struct _Elm_Entry_Anchorview_Info
11912 * The info sent in the callback for "anchor,clicked" signals emitted by
11913 * the Anchorview widget.
11915 struct _Elm_Entry_Anchorview_Info
11917 const char *name; /**< Name of the anchor, as indicated in its href
11919 int button; /**< The mouse button used to click on it */
11920 Evas_Object *hover; /**< The hover object to use for the popup */
11922 Evas_Coord x, y, w, h;
11923 } anchor, /**< Geometry selection of text used as anchor */
11924 hover_parent; /**< Geometry of the object used as parent by the
11926 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11927 for content on the left side of
11928 the hover. Before calling the
11929 callback, the widget will make the
11930 necessary calculations to check
11931 which sides are fit to be set with
11932 content, based on the position the
11933 hover is activated and its distance
11934 to the edges of its parent object
11936 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11937 the right side of the hover.
11938 See @ref hover_left */
11939 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11940 of the hover. See @ref hover_left */
11941 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11942 below the hover. See @ref
11946 * Add a new Anchorview object
11948 * @param parent The parent object
11949 * @return The new object or NULL if it cannot be created
11951 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11953 * Set the text to show in the anchorview
11955 * Sets the text of the anchorview to @p text. This text can include markup
11956 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11957 * text that will be specially styled and react to click events, ended with
11958 * either of \</a\> or \</\>. When clicked, the anchor will emit an
11959 * "anchor,clicked" signal that you can attach a callback to with
11960 * evas_object_smart_callback_add(). The name of the anchor given in the
11961 * event info struct will be the one set in the href attribute, in this
11962 * case, anchorname.
11964 * Other markup can be used to style the text in different ways, but it's
11965 * up to the style defined in the theme which tags do what.
11966 * @deprecated use elm_object_text_set() instead.
11968 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11970 * Get the markup text set for the anchorview
11972 * Retrieves the text set on the anchorview, with markup tags included.
11974 * @param obj The anchorview object
11975 * @return The markup text set or @c NULL if nothing was set or an error
11977 * @deprecated use elm_object_text_set() instead.
11979 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11981 * Set the parent of the hover popup
11983 * Sets the parent object to use by the hover created by the anchorview
11984 * when an anchor is clicked. See @ref Hover for more details on this.
11985 * If no parent is set, the same anchorview object will be used.
11987 * @param obj The anchorview object
11988 * @param parent The object to use as parent for the hover
11990 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11992 * Get the parent of the hover popup
11994 * Get the object used as parent for the hover created by the anchorview
11995 * widget. See @ref Hover for more details on this.
11997 * @param obj The anchorview object
11998 * @return The object used as parent for the hover, NULL if none is set.
12000 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12002 * Set the style that the hover should use
12004 * When creating the popup hover, anchorview will request that it's
12005 * themed according to @p style.
12007 * @param obj The anchorview object
12008 * @param style The style to use for the underlying hover
12010 * @see elm_object_style_set()
12012 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12014 * Get the style that the hover should use
12016 * Get the style the hover created by anchorview will use.
12018 * @param obj The anchorview object
12019 * @return The style to use by the hover. NULL means the default is used.
12021 * @see elm_object_style_set()
12023 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12025 * Ends the hover popup in the anchorview
12027 * When an anchor is clicked, the anchorview widget will create a hover
12028 * object to use as a popup with user provided content. This function
12029 * terminates this popup, returning the anchorview to its normal state.
12031 * @param obj The anchorview object
12033 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12035 * Set bouncing behaviour when the scrolled content reaches an edge
12037 * Tell the internal scroller object whether it should bounce or not
12038 * when it reaches the respective edges for each axis.
12040 * @param obj The anchorview object
12041 * @param h_bounce Whether to bounce or not in the horizontal axis
12042 * @param v_bounce Whether to bounce or not in the vertical axis
12044 * @see elm_scroller_bounce_set()
12046 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12048 * Get the set bouncing behaviour of the internal scroller
12050 * Get whether the internal scroller should bounce when the edge of each
12051 * axis is reached scrolling.
12053 * @param obj The anchorview object
12054 * @param h_bounce Pointer where to store the bounce state of the horizontal
12056 * @param v_bounce Pointer where to store the bounce state of the vertical
12059 * @see elm_scroller_bounce_get()
12061 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12063 * Appends a custom item provider to the given anchorview
12065 * Appends the given function to the list of items providers. This list is
12066 * called, one function at a time, with the given @p data pointer, the
12067 * anchorview object and, in the @p item parameter, the item name as
12068 * referenced in its href string. Following functions in the list will be
12069 * called in order until one of them returns something different to NULL,
12070 * which should be an Evas_Object which will be used in place of the item
12073 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12074 * href=item/name\>\</item\>
12076 * @param obj The anchorview object
12077 * @param func The function to add to the list of providers
12078 * @param data User data that will be passed to the callback function
12080 * @see elm_entry_item_provider_append()
12082 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);
12084 * Prepend a custom item provider to the given anchorview
12086 * Like elm_anchorview_item_provider_append(), but it adds the function
12087 * @p func to the beginning of the list, instead of the end.
12089 * @param obj The anchorview object
12090 * @param func The function to add to the list of providers
12091 * @param data User data that will be passed to the callback function
12093 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);
12095 * Remove a custom item provider from the list of the given anchorview
12097 * Removes the function and data pairing that matches @p func and @p data.
12098 * That is, unless the same function and same user data are given, the
12099 * function will not be removed from the list. This allows us to add the
12100 * same callback several times, with different @p data pointers and be
12101 * able to remove them later without conflicts.
12103 * @param obj The anchorview object
12104 * @param func The function to remove from the list
12105 * @param data The data matching the function to remove from the list
12107 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);
12114 * @defgroup Anchorblock Anchorblock
12116 * @image html img/widget/anchorblock/preview-00.png
12117 * @image latex img/widget/anchorblock/preview-00.eps
12119 * Anchorblock is for displaying text that contains markup with anchors
12120 * like <c>\<a href=1234\>something\</\></c> in it.
12122 * Besides being styled differently, the anchorblock widget provides the
12123 * necessary functionality so that clicking on these anchors brings up a
12124 * popup with user defined content such as "call", "add to contacts" or
12125 * "open web page". This popup is provided using the @ref Hover widget.
12127 * This widget emits the following signals:
12128 * @li "anchor,clicked": will be called when an anchor is clicked. The
12129 * @p event_info parameter on the callback will be a pointer of type
12130 * ::Elm_Entry_Anchorblock_Info.
12136 * Since examples are usually better than plain words, we might as well
12137 * try @ref tutorial_anchorblock_example "one".
12140 * @addtogroup Anchorblock
12144 * @typedef Elm_Entry_Anchorblock_Info
12146 * The info sent in the callback for "anchor,clicked" signals emitted by
12147 * the Anchorblock widget.
12149 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12151 * @struct _Elm_Entry_Anchorblock_Info
12153 * The info sent in the callback for "anchor,clicked" signals emitted by
12154 * the Anchorblock widget.
12156 struct _Elm_Entry_Anchorblock_Info
12158 const char *name; /**< Name of the anchor, as indicated in its href
12160 int button; /**< The mouse button used to click on it */
12161 Evas_Object *hover; /**< The hover object to use for the popup */
12163 Evas_Coord x, y, w, h;
12164 } anchor, /**< Geometry selection of text used as anchor */
12165 hover_parent; /**< Geometry of the object used as parent by the
12167 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12168 for content on the left side of
12169 the hover. Before calling the
12170 callback, the widget will make the
12171 necessary calculations to check
12172 which sides are fit to be set with
12173 content, based on the position the
12174 hover is activated and its distance
12175 to the edges of its parent object
12177 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12178 the right side of the hover.
12179 See @ref hover_left */
12180 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12181 of the hover. See @ref hover_left */
12182 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12183 below the hover. See @ref
12187 * Add a new Anchorblock object
12189 * @param parent The parent object
12190 * @return The new object or NULL if it cannot be created
12192 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12194 * Set the text to show in the anchorblock
12196 * Sets the text of the anchorblock to @p text. This text can include markup
12197 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12198 * of text that will be specially styled and react to click events, ended
12199 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12200 * "anchor,clicked" signal that you can attach a callback to with
12201 * evas_object_smart_callback_add(). The name of the anchor given in the
12202 * event info struct will be the one set in the href attribute, in this
12203 * case, anchorname.
12205 * Other markup can be used to style the text in different ways, but it's
12206 * up to the style defined in the theme which tags do what.
12207 * @deprecated use elm_object_text_set() instead.
12209 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12211 * Get the markup text set for the anchorblock
12213 * Retrieves the text set on the anchorblock, with markup tags included.
12215 * @param obj The anchorblock object
12216 * @return The markup text set or @c NULL if nothing was set or an error
12218 * @deprecated use elm_object_text_set() instead.
12220 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12222 * Set the parent of the hover popup
12224 * Sets the parent object to use by the hover created by the anchorblock
12225 * when an anchor is clicked. See @ref Hover for more details on this.
12227 * @param obj The anchorblock object
12228 * @param parent The object to use as parent for the hover
12230 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12232 * Get the parent of the hover popup
12234 * Get the object used as parent for the hover created by the anchorblock
12235 * widget. See @ref Hover for more details on this.
12236 * If no parent is set, the same anchorblock object will be used.
12238 * @param obj The anchorblock object
12239 * @return The object used as parent for the hover, NULL if none is set.
12241 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12243 * Set the style that the hover should use
12245 * When creating the popup hover, anchorblock will request that it's
12246 * themed according to @p style.
12248 * @param obj The anchorblock object
12249 * @param style The style to use for the underlying hover
12251 * @see elm_object_style_set()
12253 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12255 * Get the style that the hover should use
12257 * Get the style, the hover created by anchorblock will use.
12259 * @param obj The anchorblock object
12260 * @return The style to use by the hover. NULL means the default is used.
12262 * @see elm_object_style_set()
12264 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12266 * Ends the hover popup in the anchorblock
12268 * When an anchor is clicked, the anchorblock widget will create a hover
12269 * object to use as a popup with user provided content. This function
12270 * terminates this popup, returning the anchorblock to its normal state.
12272 * @param obj The anchorblock object
12274 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12276 * Appends a custom item provider to the given anchorblock
12278 * Appends the given function to the list of items providers. This list is
12279 * called, one function at a time, with the given @p data pointer, the
12280 * anchorblock object and, in the @p item parameter, the item name as
12281 * referenced in its href string. Following functions in the list will be
12282 * called in order until one of them returns something different to NULL,
12283 * which should be an Evas_Object which will be used in place of the item
12286 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12287 * href=item/name\>\</item\>
12289 * @param obj The anchorblock object
12290 * @param func The function to add to the list of providers
12291 * @param data User data that will be passed to the callback function
12293 * @see elm_entry_item_provider_append()
12295 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);
12297 * Prepend a custom item provider to the given anchorblock
12299 * Like elm_anchorblock_item_provider_append(), but it adds the function
12300 * @p func to the beginning of the list, instead of the end.
12302 * @param obj The anchorblock object
12303 * @param func The function to add to the list of providers
12304 * @param data User data that will be passed to the callback function
12306 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);
12308 * Remove a custom item provider from the list of the given anchorblock
12310 * Removes the function and data pairing that matches @p func and @p data.
12311 * That is, unless the same function and same user data are given, the
12312 * function will not be removed from the list. This allows us to add the
12313 * same callback several times, with different @p data pointers and be
12314 * able to remove them later without conflicts.
12316 * @param obj The anchorblock object
12317 * @param func The function to remove from the list
12318 * @param data The data matching the function to remove from the list
12320 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);
12326 * @defgroup Bubble Bubble
12328 * @image html img/widget/bubble/preview-00.png
12329 * @image latex img/widget/bubble/preview-00.eps
12330 * @image html img/widget/bubble/preview-01.png
12331 * @image latex img/widget/bubble/preview-01.eps
12332 * @image html img/widget/bubble/preview-02.png
12333 * @image latex img/widget/bubble/preview-02.eps
12335 * @brief The Bubble is a widget to show text similar to how speech is
12336 * represented in comics.
12338 * The bubble widget contains 5 important visual elements:
12339 * @li The frame is a rectangle with rounded edjes and an "arrow".
12340 * @li The @p icon is an image to which the frame's arrow points to.
12341 * @li The @p label is a text which appears to the right of the icon if the
12342 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12344 * @li The @p info is a text which appears to the right of the label. Info's
12345 * font is of a ligther color than label.
12346 * @li The @p content is an evas object that is shown inside the frame.
12348 * The position of the arrow, icon, label and info depends on which corner is
12349 * selected. The four available corners are:
12350 * @li "top_left" - Default
12352 * @li "bottom_left"
12353 * @li "bottom_right"
12355 * Signals that you can add callbacks for are:
12356 * @li "clicked" - This is called when a user has clicked the bubble.
12358 * For an example of using a buble see @ref bubble_01_example_page "this".
12363 #define ELM_BUBBLE_CONTENT_ICON "elm.swallow.icon"
12366 * Add a new bubble to the parent
12368 * @param parent The parent object
12369 * @return The new object or NULL if it cannot be created
12371 * This function adds a text bubble to the given parent evas object.
12373 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12375 * Set the label of the bubble
12377 * @param obj The bubble object
12378 * @param label The string to set in the label
12380 * This function sets the title of the bubble. Where this appears depends on
12381 * the selected corner.
12382 * @deprecated use elm_object_text_set() instead.
12384 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12386 * Get the label of the bubble
12388 * @param obj The bubble object
12389 * @return The string of set in the label
12391 * This function gets the title of the bubble.
12392 * @deprecated use elm_object_text_get() instead.
12394 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12396 * Set the info of the bubble
12398 * @param obj The bubble object
12399 * @param info The given info about the bubble
12401 * This function sets the info of the bubble. Where this appears depends on
12402 * the selected corner.
12403 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12405 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12407 * Get the info of the bubble
12409 * @param obj The bubble object
12411 * @return The "info" string of the bubble
12413 * This function gets the info text.
12414 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12416 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12418 * Set the content to be shown in the bubble
12420 * Once the content object is set, a previously set one will be deleted.
12421 * If you want to keep the old content object, use the
12422 * elm_bubble_content_unset() function.
12424 * @param obj The bubble object
12425 * @param content The given content of the bubble
12427 * This function sets the content shown on the middle of the bubble.
12429 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12431 * Get the content shown in the bubble
12433 * Return the content object which is set for this widget.
12435 * @param obj The bubble object
12436 * @return The content that is being used
12438 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12440 * Unset the content shown in the bubble
12442 * Unparent and return the content object which was set for this widget.
12444 * @param obj The bubble object
12445 * @return The content that was being used
12447 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12449 * Set the icon of the bubble
12451 * Once the icon object is set, a previously set one will be deleted.
12452 * If you want to keep the old content object, use the
12453 * elm_icon_content_unset() function.
12455 * @param obj The bubble object
12456 * @param icon The given icon for the bubble
12458 * @deprecated use elm_object_content_part_set() instead
12461 EINA_DEPRECATED EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12463 * Get the icon of the bubble
12465 * @param obj The bubble object
12466 * @return The icon for the bubble
12468 * This function gets the icon shown on the top left of bubble.
12470 * @deprecated use elm_object_content_part_get() instead
12473 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12475 * Unset the icon of the bubble
12477 * Unparent and return the icon object which was set for this widget.
12479 * @param obj The bubble object
12480 * @return The icon that was being used
12482 * @deprecated use elm_object_content_part_unset() instead
12485 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12487 * Set the corner of the bubble
12489 * @param obj The bubble object.
12490 * @param corner The given corner for the bubble.
12492 * This function sets the corner of the bubble. The corner will be used to
12493 * determine where the arrow in the frame points to and where label, icon and
12496 * Possible values for corner are:
12497 * @li "top_left" - Default
12499 * @li "bottom_left"
12500 * @li "bottom_right"
12502 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12504 * Get the corner of the bubble
12506 * @param obj The bubble object.
12507 * @return The given corner for the bubble.
12509 * This function gets the selected corner of the bubble.
12511 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12513 EINA_DEPRECATED EAPI void elm_bubble_sweep_layout_set(Evas_Object *obj, Evas_Object *sweep) EINA_ARG_NONNULL(1);
12514 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_sweep_layout_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12521 * @defgroup Photo Photo
12523 * For displaying the photo of a person (contact). Simple, yet
12524 * with a very specific purpose.
12526 * Signals that you can add callbacks for are:
12528 * "clicked" - This is called when a user has clicked the photo
12529 * "drag,start" - Someone started dragging the image out of the object
12530 * "drag,end" - Dragged item was dropped (somewhere)
12536 * Add a new photo to the parent
12538 * @param parent The parent object
12539 * @return The new object or NULL if it cannot be created
12543 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12546 * Set the file that will be used as photo
12548 * @param obj The photo object
12549 * @param file The path to file that will be used as photo
12551 * @return (1 = success, 0 = error)
12555 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12558 * Set the file that will be used as thumbnail in the photo.
12560 * @param obj The photo object.
12561 * @param file The path to file that will be used as thumb.
12562 * @param group The key used in case of an EET file.
12566 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12569 * Set the size that will be used on the photo
12571 * @param obj The photo object
12572 * @param size The size that the photo will be
12576 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12579 * Set if the photo should be completely visible or not.
12581 * @param obj The photo object
12582 * @param fill if true the photo will be completely visible
12586 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12589 * Set editability of the photo.
12591 * An editable photo can be dragged to or from, and can be cut or
12592 * pasted too. Note that pasting an image or dropping an item on
12593 * the image will delete the existing content.
12595 * @param obj The photo object.
12596 * @param set To set of clear editablity.
12598 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12604 /* gesture layer */
12606 * @defgroup Elm_Gesture_Layer Gesture Layer
12607 * Gesture Layer Usage:
12609 * Use Gesture Layer to detect gestures.
12610 * The advantage is that you don't have to implement
12611 * gesture detection, just set callbacks of gesture state.
12612 * By using gesture layer we make standard interface.
12614 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12615 * with a parent object parameter.
12616 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12617 * call. Usually with same object as target (2nd parameter).
12619 * Now you need to tell gesture layer what gestures you follow.
12620 * This is done with @ref elm_gesture_layer_cb_set call.
12621 * By setting the callback you actually saying to gesture layer:
12622 * I would like to know when the gesture @ref Elm_Gesture_Types
12623 * switches to state @ref Elm_Gesture_State.
12625 * Next, you need to implement the actual action that follows the input
12626 * in your callback.
12628 * Note that if you like to stop being reported about a gesture, just set
12629 * all callbacks referring this gesture to NULL.
12630 * (again with @ref elm_gesture_layer_cb_set)
12632 * The information reported by gesture layer to your callback is depending
12633 * on @ref Elm_Gesture_Types:
12634 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12635 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12636 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12638 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12639 * @ref ELM_GESTURE_MOMENTUM.
12641 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12642 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12643 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12644 * Note that we consider a flick as a line-gesture that should be completed
12645 * in flick-time-limit as defined in @ref Config.
12647 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12649 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12652 * Gesture Layer Tweaks:
12654 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12655 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12657 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12658 * so gesture starts when user touches (a *DOWN event) touch-surface
12659 * and ends when no fingers touches surface (a *UP event).
12663 * @enum _Elm_Gesture_Types
12664 * Enum of supported gesture types.
12665 * @ingroup Elm_Gesture_Layer
12667 enum _Elm_Gesture_Types
12669 ELM_GESTURE_FIRST = 0,
12671 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12672 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12673 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12674 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12676 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12678 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12679 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12681 ELM_GESTURE_ZOOM, /**< Zoom */
12682 ELM_GESTURE_ROTATE, /**< Rotate */
12688 * @typedef Elm_Gesture_Types
12689 * gesture types enum
12690 * @ingroup Elm_Gesture_Layer
12692 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12695 * @enum _Elm_Gesture_State
12696 * Enum of gesture states.
12697 * @ingroup Elm_Gesture_Layer
12699 enum _Elm_Gesture_State
12701 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12702 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12703 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12704 ELM_GESTURE_STATE_END, /**< Gesture completed */
12705 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12709 * @typedef Elm_Gesture_State
12710 * gesture states enum
12711 * @ingroup Elm_Gesture_Layer
12713 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12716 * @struct _Elm_Gesture_Taps_Info
12717 * Struct holds taps info for user
12718 * @ingroup Elm_Gesture_Layer
12720 struct _Elm_Gesture_Taps_Info
12722 Evas_Coord x, y; /**< Holds center point between fingers */
12723 unsigned int n; /**< Number of fingers tapped */
12724 unsigned int timestamp; /**< event timestamp */
12728 * @typedef Elm_Gesture_Taps_Info
12729 * holds taps info for user
12730 * @ingroup Elm_Gesture_Layer
12732 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12735 * @struct _Elm_Gesture_Momentum_Info
12736 * Struct holds momentum info for user
12737 * x1 and y1 are not necessarily in sync
12738 * x1 holds x value of x direction starting point
12739 * and same holds for y1.
12740 * This is noticeable when doing V-shape movement
12741 * @ingroup Elm_Gesture_Layer
12743 struct _Elm_Gesture_Momentum_Info
12744 { /* Report line ends, timestamps, and momentum computed */
12745 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12746 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12747 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12748 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12750 unsigned int tx; /**< Timestamp of start of final x-swipe */
12751 unsigned int ty; /**< Timestamp of start of final y-swipe */
12753 Evas_Coord mx; /**< Momentum on X */
12754 Evas_Coord my; /**< Momentum on Y */
12756 unsigned int n; /**< Number of fingers */
12760 * @typedef Elm_Gesture_Momentum_Info
12761 * holds momentum info for user
12762 * @ingroup Elm_Gesture_Layer
12764 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12767 * @struct _Elm_Gesture_Line_Info
12768 * Struct holds line info for user
12769 * @ingroup Elm_Gesture_Layer
12771 struct _Elm_Gesture_Line_Info
12772 { /* Report line ends, timestamps, and momentum computed */
12773 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12774 double angle; /**< Angle (direction) of lines */
12778 * @typedef Elm_Gesture_Line_Info
12779 * Holds line info for user
12780 * @ingroup Elm_Gesture_Layer
12782 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12785 * @struct _Elm_Gesture_Zoom_Info
12786 * Struct holds zoom info for user
12787 * @ingroup Elm_Gesture_Layer
12789 struct _Elm_Gesture_Zoom_Info
12791 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12792 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12793 double zoom; /**< Zoom value: 1.0 means no zoom */
12794 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12798 * @typedef Elm_Gesture_Zoom_Info
12799 * Holds zoom info for user
12800 * @ingroup Elm_Gesture_Layer
12802 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12805 * @struct _Elm_Gesture_Rotate_Info
12806 * Struct holds rotation info for user
12807 * @ingroup Elm_Gesture_Layer
12809 struct _Elm_Gesture_Rotate_Info
12811 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12812 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12813 double base_angle; /**< Holds start-angle */
12814 double angle; /**< Rotation value: 0.0 means no rotation */
12815 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12819 * @typedef Elm_Gesture_Rotate_Info
12820 * Holds rotation info for user
12821 * @ingroup Elm_Gesture_Layer
12823 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12826 * @typedef Elm_Gesture_Event_Cb
12827 * User callback used to stream gesture info from gesture layer
12828 * @param data user data
12829 * @param event_info gesture report info
12830 * Returns a flag field to be applied on the causing event.
12831 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12832 * upon the event, in an irreversible way.
12834 * @ingroup Elm_Gesture_Layer
12836 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12839 * Use function to set callbacks to be notified about
12840 * change of state of gesture.
12841 * When a user registers a callback with this function
12842 * this means this gesture has to be tested.
12844 * When ALL callbacks for a gesture are set to NULL
12845 * it means user isn't interested in gesture-state
12846 * and it will not be tested.
12848 * @param obj Pointer to gesture-layer.
12849 * @param idx The gesture you would like to track its state.
12850 * @param cb callback function pointer.
12851 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12852 * @param data user info to be sent to callback (usually, Smart Data)
12854 * @ingroup Elm_Gesture_Layer
12856 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);
12859 * Call this function to get repeat-events settings.
12861 * @param obj Pointer to gesture-layer.
12863 * @return repeat events settings.
12864 * @see elm_gesture_layer_hold_events_set()
12865 * @ingroup Elm_Gesture_Layer
12867 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12870 * This function called in order to make gesture-layer repeat events.
12871 * Set this of you like to get the raw events only if gestures were not detected.
12872 * Clear this if you like gesture layer to fwd events as testing gestures.
12874 * @param obj Pointer to gesture-layer.
12875 * @param r Repeat: TRUE/FALSE
12877 * @ingroup Elm_Gesture_Layer
12879 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12882 * This function sets step-value for zoom action.
12883 * Set step to any positive value.
12884 * Cancel step setting by setting to 0.0
12886 * @param obj Pointer to gesture-layer.
12887 * @param s new zoom step value.
12889 * @ingroup Elm_Gesture_Layer
12891 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12894 * This function sets step-value for rotate action.
12895 * Set step to any positive value.
12896 * Cancel step setting by setting to 0.0
12898 * @param obj Pointer to gesture-layer.
12899 * @param s new roatate step value.
12901 * @ingroup Elm_Gesture_Layer
12903 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12906 * This function called to attach gesture-layer to an Evas_Object.
12907 * @param obj Pointer to gesture-layer.
12908 * @param t Pointer to underlying object (AKA Target)
12910 * @return TRUE, FALSE on success, failure.
12912 * @ingroup Elm_Gesture_Layer
12914 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12917 * Call this function to construct a new gesture-layer object.
12918 * This does not activate the gesture layer. You have to
12919 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12921 * @param parent the parent object.
12923 * @return Pointer to new gesture-layer object.
12925 * @ingroup Elm_Gesture_Layer
12927 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12930 * @defgroup Thumb Thumb
12932 * @image html img/widget/thumb/preview-00.png
12933 * @image latex img/widget/thumb/preview-00.eps
12935 * A thumb object is used for displaying the thumbnail of an image or video.
12936 * You must have compiled Elementary with Ethumb_Client support and the DBus
12937 * service must be present and auto-activated in order to have thumbnails to
12940 * Once the thumbnail object becomes visible, it will check if there is a
12941 * previously generated thumbnail image for the file set on it. If not, it
12942 * will start generating this thumbnail.
12944 * Different config settings will cause different thumbnails to be generated
12945 * even on the same file.
12947 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12948 * Ethumb documentation to change this path, and to see other configuration
12951 * Signals that you can add callbacks for are:
12953 * - "clicked" - This is called when a user has clicked the thumb without dragging
12955 * - "clicked,double" - This is called when a user has double-clicked the thumb.
12956 * - "press" - This is called when a user has pressed down the thumb.
12957 * - "generate,start" - The thumbnail generation started.
12958 * - "generate,stop" - The generation process stopped.
12959 * - "generate,error" - The generation failed.
12960 * - "load,error" - The thumbnail image loading failed.
12962 * available styles:
12966 * An example of use of thumbnail:
12968 * - @ref thumb_example_01
12972 * @addtogroup Thumb
12977 * @enum _Elm_Thumb_Animation_Setting
12978 * @typedef Elm_Thumb_Animation_Setting
12980 * Used to set if a video thumbnail is animating or not.
12984 typedef enum _Elm_Thumb_Animation_Setting
12986 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12987 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
12988 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
12989 ELM_THUMB_ANIMATION_LAST
12990 } Elm_Thumb_Animation_Setting;
12993 * Add a new thumb object to the parent.
12995 * @param parent The parent object.
12996 * @return The new object or NULL if it cannot be created.
12998 * @see elm_thumb_file_set()
12999 * @see elm_thumb_ethumb_client_get()
13003 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13005 * Reload thumbnail if it was generated before.
13007 * @param obj The thumb object to reload
13009 * This is useful if the ethumb client configuration changed, like its
13010 * size, aspect or any other property one set in the handle returned
13011 * by elm_thumb_ethumb_client_get().
13013 * If the options didn't change, the thumbnail won't be generated again, but
13014 * the old one will still be used.
13016 * @see elm_thumb_file_set()
13020 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13022 * Set the file that will be used as thumbnail.
13024 * @param obj The thumb object.
13025 * @param file The path to file that will be used as thumb.
13026 * @param key The key used in case of an EET file.
13028 * The file can be an image or a video (in that case, acceptable extensions are:
13029 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13030 * function elm_thumb_animate().
13032 * @see elm_thumb_file_get()
13033 * @see elm_thumb_reload()
13034 * @see elm_thumb_animate()
13038 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13040 * Get the image or video path and key used to generate the thumbnail.
13042 * @param obj The thumb object.
13043 * @param file Pointer to filename.
13044 * @param key Pointer to key.
13046 * @see elm_thumb_file_set()
13047 * @see elm_thumb_path_get()
13051 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13053 * Get the path and key to the image or video generated by ethumb.
13055 * One just need to make sure that the thumbnail was generated before getting
13056 * its path; otherwise, the path will be NULL. One way to do that is by asking
13057 * for the path when/after the "generate,stop" smart callback is called.
13059 * @param obj The thumb object.
13060 * @param file Pointer to thumb path.
13061 * @param key Pointer to thumb key.
13063 * @see elm_thumb_file_get()
13067 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13069 * Set the animation state for the thumb object. If its content is an animated
13070 * video, you may start/stop the animation or tell it to play continuously and
13073 * @param obj The thumb object.
13074 * @param setting The animation setting.
13076 * @see elm_thumb_file_set()
13080 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13082 * Get the animation state for the thumb object.
13084 * @param obj The thumb object.
13085 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13088 * @see elm_thumb_animate_set()
13092 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13094 * Get the ethumb_client handle so custom configuration can be made.
13096 * @return Ethumb_Client instance or NULL.
13098 * This must be called before the objects are created to be sure no object is
13099 * visible and no generation started.
13101 * Example of usage:
13104 * #include <Elementary.h>
13105 * #ifndef ELM_LIB_QUICKLAUNCH
13107 * elm_main(int argc, char **argv)
13109 * Ethumb_Client *client;
13111 * elm_need_ethumb();
13115 * client = elm_thumb_ethumb_client_get();
13118 * ERR("could not get ethumb_client");
13121 * ethumb_client_size_set(client, 100, 100);
13122 * ethumb_client_crop_align_set(client, 0.5, 0.5);
13125 * // Create elm_thumb objects here
13135 * @note There's only one client handle for Ethumb, so once a configuration
13136 * change is done to it, any other request for thumbnails (for any thumbnail
13137 * object) will use that configuration. Thus, this configuration is global.
13141 EAPI void *elm_thumb_ethumb_client_get(void);
13143 * Get the ethumb_client connection state.
13145 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13148 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
13150 * Make the thumbnail 'editable'.
13152 * @param obj Thumb object.
13153 * @param set Turn on or off editability. Default is @c EINA_FALSE.
13155 * This means the thumbnail is a valid drag target for drag and drop, and can be
13156 * cut or pasted too.
13158 * @see elm_thumb_editable_get()
13162 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13163 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13165 * Make the thumbnail 'editable'.
13167 * @param obj Thumb object.
13168 * @return Editability.
13170 * This means the thumbnail is a valid drag target for drag and drop, and can be
13171 * cut or pasted too.
13173 * @see elm_thumb_editable_set()
13177 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13184 * @defgroup Web Web
13186 * @image html img/widget/web/preview-00.png
13187 * @image latex img/widget/web/preview-00.eps
13189 * A web object is used for displaying web pages (HTML/CSS/JS)
13190 * using WebKit-EFL. You must have compiled Elementary with
13193 * Signals that you can add callbacks for are:
13194 * @li "download,request": A file download has been requested. Event info is
13195 * a pointer to a Elm_Web_Download
13196 * @li "editorclient,contents,changed": Editor client's contents changed
13197 * @li "editorclient,selection,changed": Editor client's selection changed
13198 * @li "frame,created": A new frame was created. Event info is an
13199 * Evas_Object which can be handled with WebKit's ewk_frame API
13200 * @li "icon,received": An icon was received by the main frame
13201 * @li "inputmethod,changed": Input method changed. Event info is an
13202 * Eina_Bool indicating whether it's enabled or not
13203 * @li "js,windowobject,clear": JS window object has been cleared
13204 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13205 * is a char *link[2], where the first string contains the URL the link
13206 * points to, and the second one the title of the link
13207 * @li "link,hover,out": Mouse cursor left the link
13208 * @li "load,document,finished": Loading of a document finished. Event info
13209 * is the frame that finished loading
13210 * @li "load,error": Load failed. Event info is a pointer to
13211 * Elm_Web_Frame_Load_Error
13212 * @li "load,finished": Load finished. Event info is NULL on success, on
13213 * error it's a pointer to Elm_Web_Frame_Load_Error
13214 * @li "load,newwindow,show": A new window was created and is ready to be
13216 * @li "load,progress": Overall load progress. Event info is a pointer to
13217 * a double containing a value between 0.0 and 1.0
13218 * @li "load,provisional": Started provisional load
13219 * @li "load,started": Loading of a document started
13220 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13221 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13222 * the menubar is visible, or EINA_FALSE in case it's not
13223 * @li "menubar,visible,set": Informs menubar visibility. Event info is
13224 * an Eina_Bool indicating the visibility
13225 * @li "popup,created": A dropdown widget was activated, requesting its
13226 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13227 * @li "popup,willdelete": The web object is ready to destroy the popup
13228 * object created. Event info is a pointer to Elm_Web_Menu
13229 * @li "ready": Page is fully loaded
13230 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13231 * info is a pointer to Eina_Bool where the visibility state should be set
13232 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13233 * is an Eina_Bool with the visibility state set
13234 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13235 * a string with the new text
13236 * @li "statusbar,visible,get": Queries visibility of the status bar.
13237 * Event info is a pointer to Eina_Bool where the visibility state should be
13239 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13240 * an Eina_Bool with the visibility value
13241 * @li "title,changed": Title of the main frame changed. Event info is a
13242 * string with the new title
13243 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13244 * is a pointer to Eina_Bool where the visibility state should be set
13245 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13246 * info is an Eina_Bool with the visibility state
13247 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13248 * a string with the text to show
13249 * @li "uri,changed": URI of the main frame changed. Event info is a string
13251 * @li "view,resized": The web object internal's view changed sized
13252 * @li "windows,close,request": A JavaScript request to close the current
13253 * window was requested
13254 * @li "zoom,animated,end": Animated zoom finished
13256 * available styles:
13259 * An example of use of web:
13261 * - @ref web_example_01 TBD
13270 * Structure used to report load errors.
13272 * Load errors are reported as signal by elm_web. All the strings are
13273 * temporary references and should @b not be used after the signal
13274 * callback returns. If it's required, make copies with strdup() or
13275 * eina_stringshare_add() (they are not even guaranteed to be
13276 * stringshared, so must use eina_stringshare_add() and not
13277 * eina_stringshare_ref()).
13279 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13281 * Structure used to report load errors.
13283 * Load errors are reported as signal by elm_web. All the strings are
13284 * temporary references and should @b not be used after the signal
13285 * callback returns. If it's required, make copies with strdup() or
13286 * eina_stringshare_add() (they are not even guaranteed to be
13287 * stringshared, so must use eina_stringshare_add() and not
13288 * eina_stringshare_ref()).
13290 struct _Elm_Web_Frame_Load_Error
13292 int code; /**< Numeric error code */
13293 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13294 const char *domain; /**< Error domain name */
13295 const char *description; /**< Error description (already localized) */
13296 const char *failing_url; /**< The URL that failed to load */
13297 Evas_Object *frame; /**< Frame object that produced the error */
13301 * The possibles types that the items in a menu can be
13303 typedef enum _Elm_Web_Menu_Item_Type
13305 ELM_WEB_MENU_SEPARATOR,
13306 ELM_WEB_MENU_GROUP,
13307 ELM_WEB_MENU_OPTION
13308 } Elm_Web_Menu_Item_Type;
13311 * Structure describing the items in a menu
13313 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13315 * Structure describing the items in a menu
13317 struct _Elm_Web_Menu_Item
13319 const char *text; /**< The text for the item */
13320 Elm_Web_Menu_Item_Type type; /**< The type of the item */
13324 * Structure describing the menu of a popup
13326 * This structure will be passed as the @c event_info for the "popup,create"
13327 * signal, which is emitted when a dropdown menu is opened. Users wanting
13328 * to handle these popups by themselves should listen to this signal and
13329 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13330 * property as @c EINA_FALSE means that the user will not handle the popup
13331 * and the default implementation will be used.
13333 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13334 * will be emitted to notify the user that it can destroy any objects and
13335 * free all data related to it.
13337 * @see elm_web_popup_selected_set()
13338 * @see elm_web_popup_destroy()
13340 typedef struct _Elm_Web_Menu Elm_Web_Menu;
13342 * Structure describing the menu of a popup
13344 * This structure will be passed as the @c event_info for the "popup,create"
13345 * signal, which is emitted when a dropdown menu is opened. Users wanting
13346 * to handle these popups by themselves should listen to this signal and
13347 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13348 * property as @c EINA_FALSE means that the user will not handle the popup
13349 * and the default implementation will be used.
13351 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13352 * will be emitted to notify the user that it can destroy any objects and
13353 * free all data related to it.
13355 * @see elm_web_popup_selected_set()
13356 * @see elm_web_popup_destroy()
13358 struct _Elm_Web_Menu
13360 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13361 int x; /**< The X position of the popup, relative to the elm_web object */
13362 int y; /**< The Y position of the popup, relative to the elm_web object */
13363 int width; /**< Width of the popup menu */
13364 int height; /**< Height of the popup menu */
13366 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. */
13369 typedef struct _Elm_Web_Download Elm_Web_Download;
13370 struct _Elm_Web_Download
13376 * Types of zoom available.
13378 typedef enum _Elm_Web_Zoom_Mode
13380 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13381 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13382 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13383 ELM_WEB_ZOOM_MODE_LAST
13384 } Elm_Web_Zoom_Mode;
13386 * Opaque handler containing the features (such as statusbar, menubar, etc)
13387 * that are to be set on a newly requested window.
13389 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13391 * Callback type for the create_window hook.
13393 * The function parameters are:
13394 * @li @p data User data pointer set when setting the hook function
13395 * @li @p obj The elm_web object requesting the new window
13396 * @li @p js Set to @c EINA_TRUE if the request was originated from
13397 * JavaScript. @c EINA_FALSE otherwise.
13398 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13399 * the features requested for the new window.
13401 * The returned value of the function should be the @c elm_web widget where
13402 * the request will be loaded. That is, if a new window or tab is created,
13403 * the elm_web widget in it should be returned, and @b NOT the window
13405 * Returning @c NULL should cancel the request.
13407 * @see elm_web_window_create_hook_set()
13409 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13411 * Callback type for the JS alert hook.
13413 * The function parameters are:
13414 * @li @p data User data pointer set when setting the hook function
13415 * @li @p obj The elm_web object requesting the new window
13416 * @li @p message The message to show in the alert dialog
13418 * The function should return the object representing the alert dialog.
13419 * Elm_Web will run a second main loop to handle the dialog and normal
13420 * flow of the application will be restored when the object is deleted, so
13421 * the user should handle the popup properly in order to delete the object
13422 * when the action is finished.
13423 * If the function returns @c NULL the popup will be ignored.
13425 * @see elm_web_dialog_alert_hook_set()
13427 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13429 * Callback type for the JS confirm hook.
13431 * The function parameters are:
13432 * @li @p data User data pointer set when setting the hook function
13433 * @li @p obj The elm_web object requesting the new window
13434 * @li @p message The message to show in the confirm dialog
13435 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13436 * the user selected @c Ok, @c EINA_FALSE otherwise.
13438 * The function should return the object representing the confirm dialog.
13439 * Elm_Web will run a second main loop to handle the dialog and normal
13440 * flow of the application will be restored when the object is deleted, so
13441 * the user should handle the popup properly in order to delete the object
13442 * when the action is finished.
13443 * If the function returns @c NULL the popup will be ignored.
13445 * @see elm_web_dialog_confirm_hook_set()
13447 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13449 * Callback type for the JS prompt hook.
13451 * The function parameters are:
13452 * @li @p data User data pointer set when setting the hook function
13453 * @li @p obj The elm_web object requesting the new window
13454 * @li @p message The message to show in the prompt dialog
13455 * @li @p def_value The default value to present the user in the entry
13456 * @li @p value Pointer where to store the value given by the user. Must
13457 * be a malloc'ed string or @c NULL if the user cancelled the popup.
13458 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13459 * the user selected @c Ok, @c EINA_FALSE otherwise.
13461 * The function should return the object representing the prompt dialog.
13462 * Elm_Web will run a second main loop to handle the dialog and normal
13463 * flow of the application will be restored when the object is deleted, so
13464 * the user should handle the popup properly in order to delete the object
13465 * when the action is finished.
13466 * If the function returns @c NULL the popup will be ignored.
13468 * @see elm_web_dialog_prompt_hook_set()
13470 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13472 * Callback type for the JS file selector hook.
13474 * The function parameters are:
13475 * @li @p data User data pointer set when setting the hook function
13476 * @li @p obj The elm_web object requesting the new window
13477 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13478 * @li @p accept_types Mime types accepted
13479 * @li @p selected Pointer where to store the list of malloc'ed strings
13480 * containing the path to each file selected. Must be @c NULL if the file
13481 * dialog is cancelled
13482 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13483 * the user selected @c Ok, @c EINA_FALSE otherwise.
13485 * The function should return the object representing the file selector
13487 * Elm_Web will run a second main loop to handle the dialog and normal
13488 * flow of the application will be restored when the object is deleted, so
13489 * the user should handle the popup properly in order to delete the object
13490 * when the action is finished.
13491 * If the function returns @c NULL the popup will be ignored.
13493 * @see elm_web_dialog_file selector_hook_set()
13495 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);
13497 * Callback type for the JS console message hook.
13499 * When a console message is added from JavaScript, any set function to the
13500 * console message hook will be called for the user to handle. There is no
13501 * default implementation of this hook.
13503 * The function parameters are:
13504 * @li @p data User data pointer set when setting the hook function
13505 * @li @p obj The elm_web object that originated the message
13506 * @li @p message The message sent
13507 * @li @p line_number The line number
13508 * @li @p source_id Source id
13510 * @see elm_web_console_message_hook_set()
13512 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13514 * Add a new web object to the parent.
13516 * @param parent The parent object.
13517 * @return The new object or NULL if it cannot be created.
13519 * @see elm_web_uri_set()
13520 * @see elm_web_webkit_view_get()
13522 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13525 * Get internal ewk_view object from web object.
13527 * Elementary may not provide some low level features of EWebKit,
13528 * instead of cluttering the API with proxy methods we opted to
13529 * return the internal reference. Be careful using it as it may
13530 * interfere with elm_web behavior.
13532 * @param obj The web object.
13533 * @return The internal ewk_view object or NULL if it does not
13534 * exist. (Failure to create or Elementary compiled without
13537 * @see elm_web_add()
13539 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13542 * Sets the function to call when a new window is requested
13544 * This hook will be called when a request to create a new window is
13545 * issued from the web page loaded.
13546 * There is no default implementation for this feature, so leaving this
13547 * unset or passing @c NULL in @p func will prevent new windows from
13550 * @param obj The web object where to set the hook function
13551 * @param func The hook function to be called when a window is requested
13552 * @param data User data
13554 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13556 * Sets the function to call when an alert dialog
13558 * This hook will be called when a JavaScript alert dialog is requested.
13559 * If no function is set or @c NULL is passed in @p func, the default
13560 * implementation will take place.
13562 * @param obj The web object where to set the hook function
13563 * @param func The callback function to be used
13564 * @param data User data
13566 * @see elm_web_inwin_mode_set()
13568 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13570 * Sets the function to call when an confirm dialog
13572 * This hook will be called when a JavaScript confirm dialog is requested.
13573 * If no function is set or @c NULL is passed in @p func, the default
13574 * implementation will take place.
13576 * @param obj The web object where to set the hook function
13577 * @param func The callback function to be used
13578 * @param data User data
13580 * @see elm_web_inwin_mode_set()
13582 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13584 * Sets the function to call when an prompt dialog
13586 * This hook will be called when a JavaScript prompt dialog is requested.
13587 * If no function is set or @c NULL is passed in @p func, the default
13588 * implementation will take place.
13590 * @param obj The web object where to set the hook function
13591 * @param func The callback function to be used
13592 * @param data User data
13594 * @see elm_web_inwin_mode_set()
13596 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13598 * Sets the function to call when an file selector dialog
13600 * This hook will be called when a JavaScript file selector dialog is
13602 * If no function is set or @c NULL is passed in @p func, the default
13603 * implementation will take place.
13605 * @param obj The web object where to set the hook function
13606 * @param func The callback function to be used
13607 * @param data User data
13609 * @see elm_web_inwin_mode_set()
13611 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13613 * Sets the function to call when a console message is emitted from JS
13615 * This hook will be called when a console message is emitted from
13616 * JavaScript. There is no default implementation for this feature.
13618 * @param obj The web object where to set the hook function
13619 * @param func The callback function to be used
13620 * @param data User data
13622 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13624 * Gets the status of the tab propagation
13626 * @param obj The web object to query
13627 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13629 * @see elm_web_tab_propagate_set()
13631 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
13633 * Sets whether to use tab propagation
13635 * If tab propagation is enabled, whenever the user presses the Tab key,
13636 * Elementary will handle it and switch focus to the next widget.
13637 * The default value is disabled, where WebKit will handle the Tab key to
13638 * cycle focus though its internal objects, jumping to the next widget
13639 * only when that cycle ends.
13641 * @param obj The web object
13642 * @param propagate Whether to propagate Tab keys to Elementary or not
13644 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13646 * Sets the URI for the web object
13648 * It must be a full URI, with resource included, in the form
13649 * http://www.enlightenment.org or file:///tmp/something.html
13651 * @param obj The web object
13652 * @param uri The URI to set
13653 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13655 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
13657 * Gets the current URI for the object
13659 * The returned string must not be freed and is guaranteed to be
13662 * @param obj The web object
13663 * @return A stringshared internal string with the current URI, or NULL on
13666 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
13668 * Gets the current title
13670 * The returned string must not be freed and is guaranteed to be
13673 * @param obj The web object
13674 * @return A stringshared internal string with the current title, or NULL on
13677 EAPI const char *elm_web_title_get(const Evas_Object *obj);
13679 * Sets the background color to be used by the web object
13681 * This is the color that will be used by default when the loaded page
13682 * does not set it's own. Color values are pre-multiplied.
13684 * @param obj The web object
13685 * @param r Red component
13686 * @param g Green component
13687 * @param b Blue component
13688 * @param a Alpha component
13690 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13692 * Gets the background color to be used by the web object
13694 * This is the color that will be used by default when the loaded page
13695 * does not set it's own. Color values are pre-multiplied.
13697 * @param obj The web object
13698 * @param r Red component
13699 * @param g Green component
13700 * @param b Blue component
13701 * @param a Alpha component
13703 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13705 * Gets a copy of the currently selected text
13707 * The string returned must be freed by the user when it's done with it.
13709 * @param obj The web object
13710 * @return A newly allocated string, or NULL if nothing is selected or an
13713 EAPI char *elm_view_selection_get(const Evas_Object *obj);
13715 * Tells the web object which index in the currently open popup was selected
13717 * When the user handles the popup creation from the "popup,created" signal,
13718 * it needs to tell the web object which item was selected by calling this
13719 * function with the index corresponding to the item.
13721 * @param obj The web object
13722 * @param index The index selected
13724 * @see elm_web_popup_destroy()
13726 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
13728 * Dismisses an open dropdown popup
13730 * When the popup from a dropdown widget is to be dismissed, either after
13731 * selecting an option or to cancel it, this function must be called, which
13732 * will later emit an "popup,willdelete" signal to notify the user that
13733 * any memory and objects related to this popup can be freed.
13735 * @param obj The web object
13736 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13737 * if there was no menu to destroy
13739 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
13741 * Searches the given string in a document.
13743 * @param obj The web object where to search the text
13744 * @param string String to search
13745 * @param case_sensitive If search should be case sensitive or not
13746 * @param forward If search is from cursor and on or backwards
13747 * @param wrap If search should wrap at the end
13749 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13752 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13754 * Marks matches of the given string in a document.
13756 * @param obj The web object where to search text
13757 * @param string String to match
13758 * @param case_sensitive If match should be case sensitive or not
13759 * @param highlight If matches should be highlighted
13760 * @param limit Maximum amount of matches, or zero to unlimited
13762 * @return number of matched @a string
13764 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13766 * Clears all marked matches in the document
13768 * @param obj The web object
13770 * @return EINA_TRUE on success, EINA_FALSE otherwise
13772 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
13774 * Sets whether to highlight the matched marks
13776 * If enabled, marks set with elm_web_text_matches_mark() will be
13779 * @param obj The web object
13780 * @param highlight Whether to highlight the marks or not
13782 * @return EINA_TRUE on success, EINA_FALSE otherwise
13784 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13786 * Gets whether highlighting marks is enabled
13788 * @param The web object
13790 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13793 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
13795 * Gets the overall loading progress of the page
13797 * Returns the estimated loading progress of the page, with a value between
13798 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13799 * included in the page.
13801 * @param The web object
13803 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13806 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
13808 * Stops loading the current page
13810 * Cancels the loading of the current page in the web object. This will
13811 * cause a "load,error" signal to be emitted, with the is_cancellation
13812 * flag set to EINA_TRUE.
13814 * @param obj The web object
13816 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13818 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
13820 * Requests a reload of the current document in the object
13822 * @param obj The web object
13824 * @return EINA_TRUE on success, EINA_FALSE otherwise
13826 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
13828 * Requests a reload of the current document, avoiding any existing caches
13830 * @param obj The web object
13832 * @return EINA_TRUE on success, EINA_FALSE otherwise
13834 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
13836 * Goes back one step in the browsing history
13838 * This is equivalent to calling elm_web_object_navigate(obj, -1);
13840 * @param obj The web object
13842 * @return EINA_TRUE on success, EINA_FALSE otherwise
13844 * @see elm_web_history_enable_set()
13845 * @see elm_web_back_possible()
13846 * @see elm_web_forward()
13847 * @see elm_web_navigate()
13849 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
13851 * Goes forward one step in the browsing history
13853 * This is equivalent to calling elm_web_object_navigate(obj, 1);
13855 * @param obj The web object
13857 * @return EINA_TRUE on success, EINA_FALSE otherwise
13859 * @see elm_web_history_enable_set()
13860 * @see elm_web_forward_possible()
13861 * @see elm_web_back()
13862 * @see elm_web_navigate()
13864 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
13866 * Jumps the given number of steps in the browsing history
13868 * The @p steps value can be a negative integer to back in history, or a
13869 * positive to move forward.
13871 * @param obj The web object
13872 * @param steps The number of steps to jump
13874 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13875 * history exists to jump the given number of steps
13877 * @see elm_web_history_enable_set()
13878 * @see elm_web_navigate_possible()
13879 * @see elm_web_back()
13880 * @see elm_web_forward()
13882 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
13884 * Queries whether it's possible to go back in history
13886 * @param obj The web object
13888 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13891 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
13893 * Queries whether it's possible to go forward in history
13895 * @param obj The web object
13897 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13900 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
13902 * Queries whether it's possible to jump the given number of steps
13904 * The @p steps value can be a negative integer to back in history, or a
13905 * positive to move forward.
13907 * @param obj The web object
13908 * @param steps The number of steps to check for
13910 * @return EINA_TRUE if enough history exists to perform the given jump,
13911 * EINA_FALSE otherwise
13913 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
13915 * Gets whether browsing history is enabled for the given object
13917 * @param obj The web object
13919 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
13921 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
13923 * Enables or disables the browsing history
13925 * @param obj The web object
13926 * @param enable Whether to enable or disable the browsing history
13928 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
13930 * Sets the zoom level of the web object
13932 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
13933 * values meaning zoom in and lower meaning zoom out. This function will
13934 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
13935 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
13937 * @param obj The web object
13938 * @param zoom The zoom level to set
13940 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
13942 * Gets the current zoom level set on the web object
13944 * Note that this is the zoom level set on the web object and not that
13945 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
13946 * the two zoom levels should match, but for the other two modes the
13947 * Webkit zoom is calculated internally to match the chosen mode without
13948 * changing the zoom level set for the web object.
13950 * @param obj The web object
13952 * @return The zoom level set on the object
13954 EAPI double elm_web_zoom_get(const Evas_Object *obj);
13956 * Sets the zoom mode to use
13958 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
13959 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
13961 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
13962 * with the elm_web_zoom_set() function.
13963 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
13964 * make sure the entirety of the web object's contents are shown.
13965 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
13966 * fit the contents in the web object's size, without leaving any space
13969 * @param obj The web object
13970 * @param mode The mode to set
13972 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
13974 * Gets the currently set zoom mode
13976 * @param obj The web object
13978 * @return The current zoom mode set for the object, or
13979 * ::ELM_WEB_ZOOM_MODE_LAST on error
13981 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
13983 * Shows the given region in the web object
13985 * @param obj The web object
13986 * @param x The x coordinate of the region to show
13987 * @param y The y coordinate of the region to show
13988 * @param w The width of the region to show
13989 * @param h The height of the region to show
13991 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
13993 * Brings in the region to the visible area
13995 * Like elm_web_region_show(), but it animates the scrolling of the object
13998 * @param obj The web object
13999 * @param x The x coordinate of the region to show
14000 * @param y The y coordinate of the region to show
14001 * @param w The width of the region to show
14002 * @param h The height of the region to show
14004 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
14006 * Sets the default dialogs to use an Inwin instead of a normal window
14008 * If set, then the default implementation for the JavaScript dialogs and
14009 * file selector will be opened in an Inwin. Otherwise they will use a
14010 * normal separated window.
14012 * @param obj The web object
14013 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
14015 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
14017 * Gets whether Inwin mode is set for the current object
14019 * @param obj The web object
14021 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
14023 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
14025 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
14026 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
14027 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);
14028 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
14035 * @defgroup Hoversel Hoversel
14037 * @image html img/widget/hoversel/preview-00.png
14038 * @image latex img/widget/hoversel/preview-00.eps
14040 * A hoversel is a button that pops up a list of items (automatically
14041 * choosing the direction to display) that have a label and, optionally, an
14042 * icon to select from. It is a convenience widget to avoid the need to do
14043 * all the piecing together yourself. It is intended for a small number of
14044 * items in the hoversel menu (no more than 8), though is capable of many
14047 * Signals that you can add callbacks for are:
14048 * "clicked" - the user clicked the hoversel button and popped up the sel
14049 * "selected" - an item in the hoversel list is selected. event_info is the item
14050 * "dismissed" - the hover is dismissed
14052 * See @ref tutorial_hoversel for an example.
14055 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
14057 * @brief Add a new Hoversel object
14059 * @param parent The parent object
14060 * @return The new object or NULL if it cannot be created
14062 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14064 * @brief This sets the hoversel to expand horizontally.
14066 * @param obj The hoversel object
14067 * @param horizontal If true, the hover will expand horizontally to the
14070 * @note The initial button will display horizontally regardless of this
14073 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14075 * @brief This returns whether the hoversel is set to expand horizontally.
14077 * @param obj The hoversel object
14078 * @return If true, the hover will expand horizontally to the right.
14080 * @see elm_hoversel_horizontal_set()
14082 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14084 * @brief Set the Hover parent
14086 * @param obj The hoversel object
14087 * @param parent The parent to use
14089 * Sets the hover parent object, the area that will be darkened when the
14090 * hoversel is clicked. Should probably be the window that the hoversel is
14091 * in. See @ref Hover objects for more information.
14093 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14095 * @brief Get the Hover parent
14097 * @param obj The hoversel object
14098 * @return The used parent
14100 * Gets the hover parent object.
14102 * @see elm_hoversel_hover_parent_set()
14104 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14106 * @brief Set the hoversel button label
14108 * @param obj The hoversel object
14109 * @param label The label text.
14111 * This sets the label of the button that is always visible (before it is
14112 * clicked and expanded).
14114 * @deprecated elm_object_text_set()
14116 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14118 * @brief Get the hoversel button label
14120 * @param obj The hoversel object
14121 * @return The label text.
14123 * @deprecated elm_object_text_get()
14125 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14127 * @brief Set the icon of the hoversel button
14129 * @param obj The hoversel object
14130 * @param icon The icon object
14132 * Sets the icon of the button that is always visible (before it is clicked
14133 * and expanded). Once the icon object is set, a previously set one will be
14134 * deleted, if you want to keep that old content object, use the
14135 * elm_hoversel_icon_unset() function.
14137 * @see elm_object_content_set() for the button widget
14139 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14141 * @brief Get the icon of the hoversel button
14143 * @param obj The hoversel object
14144 * @return The icon object
14146 * Get the icon of the button that is always visible (before it is clicked
14147 * and expanded). Also see elm_object_content_get() for the button widget.
14149 * @see elm_hoversel_icon_set()
14151 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14153 * @brief Get and unparent the icon of the hoversel button
14155 * @param obj The hoversel object
14156 * @return The icon object that was being used
14158 * Unparent and return the icon of the button that is always visible
14159 * (before it is clicked and expanded).
14161 * @see elm_hoversel_icon_set()
14162 * @see elm_object_content_unset() for the button widget
14164 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14166 * @brief This triggers the hoversel popup from code, the same as if the user
14167 * had clicked the button.
14169 * @param obj The hoversel object
14171 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14173 * @brief This dismisses the hoversel popup as if the user had clicked
14174 * outside the hover.
14176 * @param obj The hoversel object
14178 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14180 * @brief Returns whether the hoversel is expanded.
14182 * @param obj The hoversel object
14183 * @return This will return EINA_TRUE if the hoversel is expanded or
14184 * EINA_FALSE if it is not expanded.
14186 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14188 * @brief This will remove all the children items from the hoversel.
14190 * @param obj The hoversel object
14192 * @warning Should @b not be called while the hoversel is active; use
14193 * elm_hoversel_expanded_get() to check first.
14195 * @see elm_hoversel_item_del_cb_set()
14196 * @see elm_hoversel_item_del()
14198 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14200 * @brief Get the list of items within the given hoversel.
14202 * @param obj The hoversel object
14203 * @return Returns a list of Elm_Hoversel_Item*
14205 * @see elm_hoversel_item_add()
14207 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14209 * @brief Add an item to the hoversel button
14211 * @param obj The hoversel object
14212 * @param label The text label to use for the item (NULL if not desired)
14213 * @param icon_file An image file path on disk to use for the icon or standard
14214 * icon name (NULL if not desired)
14215 * @param icon_type The icon type if relevant
14216 * @param func Convenience function to call when this item is selected
14217 * @param data Data to pass to item-related functions
14218 * @return A handle to the item added.
14220 * This adds an item to the hoversel to show when it is clicked. Note: if you
14221 * need to use an icon from an edje file then use
14222 * elm_hoversel_item_icon_set() right after the this function, and set
14223 * icon_file to NULL here.
14225 * For more information on what @p icon_file and @p icon_type are see the
14226 * @ref Icon "icon documentation".
14228 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);
14230 * @brief Delete an item from the hoversel
14232 * @param item The item to delete
14234 * This deletes the item from the hoversel (should not be called while the
14235 * hoversel is active; use elm_hoversel_expanded_get() to check first).
14237 * @see elm_hoversel_item_add()
14238 * @see elm_hoversel_item_del_cb_set()
14240 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14242 * @brief Set the function to be called when an item from the hoversel is
14245 * @param item The item to set the callback on
14246 * @param func The function called
14248 * That function will receive these parameters:
14249 * @li void *item_data
14250 * @li Evas_Object *the_item_object
14251 * @li Elm_Hoversel_Item *the_object_struct
14253 * @see elm_hoversel_item_add()
14255 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14257 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14258 * that will be passed to associated function callbacks.
14260 * @param item The item to get the data from
14261 * @return The data pointer set with elm_hoversel_item_add()
14263 * @see elm_hoversel_item_add()
14265 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14267 * @brief This returns the label text of the given hoversel item.
14269 * @param item The item to get the label
14270 * @return The label text of the hoversel item
14272 * @see elm_hoversel_item_add()
14274 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14276 * @brief This sets the icon for the given hoversel item.
14278 * @param item The item to set the icon
14279 * @param icon_file An image file path on disk to use for the icon or standard
14281 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14282 * to NULL if the icon is not an edje file
14283 * @param icon_type The icon type
14285 * The icon can be loaded from the standard set, from an image file, or from
14288 * @see elm_hoversel_item_add()
14290 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);
14292 * @brief Get the icon object of the hoversel item
14294 * @param item The item to get the icon from
14295 * @param icon_file The image file path on disk used for the icon or standard
14297 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14298 * if the icon is not an edje file
14299 * @param icon_type The icon type
14301 * @see elm_hoversel_item_icon_set()
14302 * @see elm_hoversel_item_add()
14304 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);
14310 * @defgroup Toolbar Toolbar
14311 * @ingroup Elementary
14313 * @image html img/widget/toolbar/preview-00.png
14314 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14316 * @image html img/toolbar.png
14317 * @image latex img/toolbar.eps width=\textwidth
14319 * A toolbar is a widget that displays a list of items inside
14320 * a box. It can be scrollable, show a menu with items that don't fit
14321 * to toolbar size or even crop them.
14323 * Only one item can be selected at a time.
14325 * Items can have multiple states, or show menus when selected by the user.
14327 * Smart callbacks one can listen to:
14328 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14329 * - "language,changed" - when the program language changes
14331 * Available styles for it:
14333 * - @c "transparent" - no background or shadow, just show the content
14335 * List of examples:
14336 * @li @ref toolbar_example_01
14337 * @li @ref toolbar_example_02
14338 * @li @ref toolbar_example_03
14342 * @addtogroup Toolbar
14347 * @enum _Elm_Toolbar_Shrink_Mode
14348 * @typedef Elm_Toolbar_Shrink_Mode
14350 * Set toolbar's items display behavior, it can be scrollabel,
14351 * show a menu with exceeding items, or simply hide them.
14353 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14356 * Values <b> don't </b> work as bitmask, only one can be choosen.
14358 * @see elm_toolbar_mode_shrink_set()
14359 * @see elm_toolbar_mode_shrink_get()
14363 typedef enum _Elm_Toolbar_Shrink_Mode
14365 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
14366 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
14367 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14368 ELM_TOOLBAR_SHRINK_MENU, /**< Inserts a button to pop up a menu with exceeding items. */
14369 ELM_TOOLBAR_SHRINK_LAST /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14370 } Elm_Toolbar_Shrink_Mode;
14372 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(). */
14374 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(). */
14377 * Add a new toolbar widget to the given parent Elementary
14378 * (container) object.
14380 * @param parent The parent object.
14381 * @return a new toolbar widget handle or @c NULL, on errors.
14383 * This function inserts a new toolbar widget on the canvas.
14387 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14390 * Set the icon size, in pixels, to be used by toolbar items.
14392 * @param obj The toolbar object
14393 * @param icon_size The icon size in pixels
14395 * @note Default value is @c 32. It reads value from elm config.
14397 * @see elm_toolbar_icon_size_get()
14401 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14404 * Get the icon size, in pixels, to be used by toolbar items.
14406 * @param obj The toolbar object.
14407 * @return The icon size in pixels.
14409 * @see elm_toolbar_icon_size_set() for details.
14413 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14416 * Sets icon lookup order, for toolbar items' icons.
14418 * @param obj The toolbar object.
14419 * @param order The icon lookup order.
14421 * Icons added before calling this function will not be affected.
14422 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14424 * @see elm_toolbar_icon_order_lookup_get()
14428 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14431 * Gets the icon lookup order.
14433 * @param obj The toolbar object.
14434 * @return The icon lookup order.
14436 * @see elm_toolbar_icon_order_lookup_set() for details.
14440 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14443 * Set whether the toolbar should always have an item selected.
14445 * @param obj The toolbar object.
14446 * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14449 * This will cause the toolbar to always have an item selected, and clicking
14450 * the selected item will not cause a selected event to be emitted. Enabling this mode
14451 * will immediately select the first toolbar item.
14453 * Always-selected is disabled by default.
14455 * @see elm_toolbar_always_select_mode_get().
14459 EAPI void elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14462 * Get whether the toolbar should always have an item selected.
14464 * @param obj The toolbar object.
14465 * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14466 * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14468 * @see elm_toolbar_always_select_mode_set() for details.
14472 EAPI Eina_Bool elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14475 * Set whether the toolbar items' should be selected by the user or not.
14477 * @param obj The toolbar object.
14478 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14481 * This will turn off the ability to select items entirely and they will
14482 * neither appear selected nor emit selected signals. The clicked
14483 * callback function will still be called.
14485 * Selection is enabled by default.
14487 * @see elm_toolbar_no_select_mode_get().
14491 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14494 * Set whether the toolbar items' should be selected by the user or not.
14496 * @param obj The toolbar object.
14497 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14498 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14500 * @see elm_toolbar_no_select_mode_set() for details.
14504 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14507 * Append item to the toolbar.
14509 * @param obj The toolbar object.
14510 * @param icon A string with icon name or the absolute path of an image file.
14511 * @param label The label of the item.
14512 * @param func The function to call when the item is clicked.
14513 * @param data The data to associate with the item for related callbacks.
14514 * @return The created item or @c NULL upon failure.
14516 * A new item will be created and appended to the toolbar, i.e., will
14517 * be set as @b last item.
14519 * Items created with this method can be deleted with
14520 * elm_toolbar_item_del().
14522 * Associated @p data can be properly freed when item is deleted if a
14523 * callback function is set with elm_toolbar_item_del_cb_set().
14525 * If a function is passed as argument, it will be called everytime this item
14526 * is selected, i.e., the user clicks over an unselected item.
14527 * If such function isn't needed, just passing
14528 * @c NULL as @p func is enough. The same should be done for @p data.
14530 * Toolbar will load icon image from fdo or current theme.
14531 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14532 * If an absolute path is provided it will load it direct from a file.
14534 * @see elm_toolbar_item_icon_set()
14535 * @see elm_toolbar_item_del()
14536 * @see elm_toolbar_item_del_cb_set()
14540 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);
14543 * Prepend item to the toolbar.
14545 * @param obj The toolbar object.
14546 * @param icon A string with icon name or the absolute path of an image file.
14547 * @param label The label of the item.
14548 * @param func The function to call when the item is clicked.
14549 * @param data The data to associate with the item for related callbacks.
14550 * @return The created item or @c NULL upon failure.
14552 * A new item will be created and prepended to the toolbar, i.e., will
14553 * be set as @b first item.
14555 * Items created with this method can be deleted with
14556 * elm_toolbar_item_del().
14558 * Associated @p data can be properly freed when item is deleted if a
14559 * callback function is set with elm_toolbar_item_del_cb_set().
14561 * If a function is passed as argument, it will be called everytime this item
14562 * is selected, i.e., the user clicks over an unselected item.
14563 * If such function isn't needed, just passing
14564 * @c NULL as @p func is enough. The same should be done for @p data.
14566 * Toolbar will load icon image from fdo or current theme.
14567 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14568 * If an absolute path is provided it will load it direct from a file.
14570 * @see elm_toolbar_item_icon_set()
14571 * @see elm_toolbar_item_del()
14572 * @see elm_toolbar_item_del_cb_set()
14576 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);
14579 * Insert a new item into the toolbar object before item @p before.
14581 * @param obj The toolbar object.
14582 * @param before The toolbar item to insert before.
14583 * @param icon A string with icon name or the absolute path of an image file.
14584 * @param label The label of the item.
14585 * @param func The function to call when the item is clicked.
14586 * @param data The data to associate with the item for related callbacks.
14587 * @return The created item or @c NULL upon failure.
14589 * A new item will be created and added to the toolbar. Its position in
14590 * this toolbar will be just before item @p before.
14592 * Items created with this method can be deleted with
14593 * elm_toolbar_item_del().
14595 * Associated @p data can be properly freed when item is deleted if a
14596 * callback function is set with elm_toolbar_item_del_cb_set().
14598 * If a function is passed as argument, it will be called everytime this item
14599 * is selected, i.e., the user clicks over an unselected item.
14600 * If such function isn't needed, just passing
14601 * @c NULL as @p func is enough. The same should be done for @p data.
14603 * Toolbar will load icon image from fdo or current theme.
14604 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14605 * If an absolute path is provided it will load it direct from a file.
14607 * @see elm_toolbar_item_icon_set()
14608 * @see elm_toolbar_item_del()
14609 * @see elm_toolbar_item_del_cb_set()
14613 EAPI Elm_Toolbar_Item *elm_toolbar_item_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);
14616 * Insert a new item into the toolbar object after item @p after.
14618 * @param obj The toolbar object.
14619 * @param after The toolbar item to insert after.
14620 * @param icon A string with icon name or the absolute path of an image file.
14621 * @param label The label of the item.
14622 * @param func The function to call when the item is clicked.
14623 * @param data The data to associate with the item for related callbacks.
14624 * @return The created item or @c NULL upon failure.
14626 * A new item will be created and added to the toolbar. Its position in
14627 * this toolbar will be just after item @p after.
14629 * Items created with this method can be deleted with
14630 * elm_toolbar_item_del().
14632 * Associated @p data can be properly freed when item is deleted if a
14633 * callback function is set with elm_toolbar_item_del_cb_set().
14635 * If a function is passed as argument, it will be called everytime this item
14636 * is selected, i.e., the user clicks over an unselected item.
14637 * If such function isn't needed, just passing
14638 * @c NULL as @p func is enough. The same should be done for @p data.
14640 * Toolbar will load icon image from fdo or current theme.
14641 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14642 * If an absolute path is provided it will load it direct from a file.
14644 * @see elm_toolbar_item_icon_set()
14645 * @see elm_toolbar_item_del()
14646 * @see elm_toolbar_item_del_cb_set()
14650 EAPI Elm_Toolbar_Item *elm_toolbar_item_insert_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);
14653 * Get the first item in the given toolbar widget's list of
14656 * @param obj The toolbar object
14657 * @return The first item or @c NULL, if it has no items (and on
14660 * @see elm_toolbar_item_append()
14661 * @see elm_toolbar_last_item_get()
14665 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14668 * Get the last item in the given toolbar widget's list of
14671 * @param obj The toolbar object
14672 * @return The last item or @c NULL, if it has no items (and on
14675 * @see elm_toolbar_item_prepend()
14676 * @see elm_toolbar_first_item_get()
14680 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14683 * Get the item after @p item in toolbar.
14685 * @param item The toolbar item.
14686 * @return The item after @p item, or @c NULL if none or on failure.
14688 * @note If it is the last item, @c NULL will be returned.
14690 * @see elm_toolbar_item_append()
14694 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14697 * Get the item before @p item in toolbar.
14699 * @param item The toolbar item.
14700 * @return The item before @p item, or @c NULL if none or on failure.
14702 * @note If it is the first item, @c NULL will be returned.
14704 * @see elm_toolbar_item_prepend()
14708 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14711 * Get the toolbar object from an item.
14713 * @param item The item.
14714 * @return The toolbar object.
14716 * This returns the toolbar object itself that an item belongs to.
14720 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14723 * Set the priority of a toolbar item.
14725 * @param item The toolbar item.
14726 * @param priority The item priority. The default is zero.
14728 * This is used only when the toolbar shrink mode is set to
14729 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14730 * When space is less than required, items with low priority
14731 * will be removed from the toolbar and added to a dynamically-created menu,
14732 * while items with higher priority will remain on the toolbar,
14733 * with the same order they were added.
14735 * @see elm_toolbar_item_priority_get()
14739 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14742 * Get the priority of a toolbar item.
14744 * @param item The toolbar item.
14745 * @return The @p item priority, or @c 0 on failure.
14747 * @see elm_toolbar_item_priority_set() for details.
14751 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14754 * Get the label of item.
14756 * @param item The item of toolbar.
14757 * @return The label of item.
14759 * The return value is a pointer to the label associated to @p item when
14760 * it was created, with function elm_toolbar_item_append() or similar,
14762 * with function elm_toolbar_item_label_set. If no label
14763 * was passed as argument, it will return @c NULL.
14765 * @see elm_toolbar_item_label_set() for more details.
14766 * @see elm_toolbar_item_append()
14770 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14773 * Set the label of item.
14775 * @param item The item of toolbar.
14776 * @param text The label of item.
14778 * The label to be displayed by the item.
14779 * Label will be placed at icons bottom (if set).
14781 * If a label was passed as argument on item creation, with function
14782 * elm_toolbar_item_append() or similar, it will be already
14783 * displayed by the item.
14785 * @see elm_toolbar_item_label_get()
14786 * @see elm_toolbar_item_append()
14790 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14793 * Return the data associated with a given toolbar widget item.
14795 * @param item The toolbar widget item handle.
14796 * @return The data associated with @p item.
14798 * @see elm_toolbar_item_data_set()
14802 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14805 * Set the data associated with a given toolbar widget item.
14807 * @param item The toolbar widget item handle.
14808 * @param data The new data pointer to set to @p item.
14810 * This sets new item data on @p item.
14812 * @warning The old data pointer won't be touched by this function, so
14813 * the user had better to free that old data himself/herself.
14817 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14820 * Returns a pointer to a toolbar item by its label.
14822 * @param obj The toolbar object.
14823 * @param label The label of the item to find.
14825 * @return The pointer to the toolbar item matching @p label or @c NULL
14830 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14833 * Get whether the @p item is selected or not.
14835 * @param item The toolbar item.
14836 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14837 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14839 * @see elm_toolbar_selected_item_set() for details.
14840 * @see elm_toolbar_item_selected_get()
14844 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14847 * Set the selected state of an item.
14849 * @param item The toolbar item
14850 * @param selected The selected state
14852 * This sets the selected state of the given item @p it.
14853 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14855 * If a new item is selected the previosly selected will be unselected.
14856 * Previoulsy selected item can be get with function
14857 * elm_toolbar_selected_item_get().
14859 * Selected items will be highlighted.
14861 * @see elm_toolbar_item_selected_get()
14862 * @see elm_toolbar_selected_item_get()
14866 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14869 * Get the selected item.
14871 * @param obj The toolbar object.
14872 * @return The selected toolbar item.
14874 * The selected item can be unselected with function
14875 * elm_toolbar_item_selected_set().
14877 * The selected item always will be highlighted on toolbar.
14879 * @see elm_toolbar_selected_items_get()
14883 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14886 * Set the icon associated with @p item.
14888 * @param obj The parent of this item.
14889 * @param item The toolbar item.
14890 * @param icon A string with icon name or the absolute path of an image file.
14892 * Toolbar will load icon image from fdo or current theme.
14893 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14894 * If an absolute path is provided it will load it direct from a file.
14896 * @see elm_toolbar_icon_order_lookup_set()
14897 * @see elm_toolbar_icon_order_lookup_get()
14901 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
14904 * Get the string used to set the icon of @p item.
14906 * @param item The toolbar item.
14907 * @return The string associated with the icon object.
14909 * @see elm_toolbar_item_icon_set() for details.
14913 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14916 * Get the object of @p item.
14918 * @param item The toolbar item.
14919 * @return The object
14923 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14926 * Get the icon object of @p item.
14928 * @param item The toolbar item.
14929 * @return The icon object
14931 * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
14935 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14938 * Set the icon associated with @p item to an image in a binary buffer.
14940 * @param item The toolbar item.
14941 * @param img The binary data that will be used as an image
14942 * @param size The size of binary data @p img
14943 * @param format Optional format of @p img to pass to the image loader
14944 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
14946 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
14948 * @note The icon image set by this function can be changed by
14949 * elm_toolbar_item_icon_set().
14953 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);
14956 * Delete them item from the toolbar.
14958 * @param item The item of toolbar to be deleted.
14960 * @see elm_toolbar_item_append()
14961 * @see elm_toolbar_item_del_cb_set()
14965 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14968 * Set the function called when a toolbar item is freed.
14970 * @param item The item to set the callback on.
14971 * @param func The function called.
14973 * If there is a @p func, then it will be called prior item's memory release.
14974 * That will be called with the following arguments:
14976 * @li item's Evas object;
14979 * This way, a data associated to a toolbar item could be properly freed.
14983 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14986 * Get a value whether toolbar item is disabled or not.
14988 * @param item The item.
14989 * @return The disabled state.
14991 * @see elm_toolbar_item_disabled_set() for more details.
14995 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14998 * Sets the disabled/enabled state of a toolbar item.
15000 * @param item The item.
15001 * @param disabled The disabled state.
15003 * A disabled item cannot be selected or unselected. It will also
15004 * change its appearance (generally greyed out). This sets the
15005 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15010 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15013 * Set or unset item as a separator.
15015 * @param item The toolbar item.
15016 * @param setting @c EINA_TRUE to set item @p item as separator or
15017 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15019 * Items aren't set as separator by default.
15021 * If set as separator it will display separator theme, so won't display
15024 * @see elm_toolbar_item_separator_get()
15028 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
15031 * Get a value whether item is a separator or not.
15033 * @param item The toolbar item.
15034 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15035 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15037 * @see elm_toolbar_item_separator_set() for details.
15041 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15044 * Set the shrink state of toolbar @p obj.
15046 * @param obj The toolbar object.
15047 * @param shrink_mode Toolbar's items display behavior.
15049 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
15050 * but will enforce a minimun size so all the items will fit, won't scroll
15051 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
15052 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
15053 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
15057 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15060 * Get the shrink mode of toolbar @p obj.
15062 * @param obj The toolbar object.
15063 * @return Toolbar's items display behavior.
15065 * @see elm_toolbar_mode_shrink_set() for details.
15069 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15072 * Enable/disable homogenous mode.
15074 * @param obj The toolbar object
15075 * @param homogeneous Assume the items within the toolbar are of the
15076 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15078 * This will enable the homogeneous mode where items are of the same size.
15079 * @see elm_toolbar_homogeneous_get()
15083 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15086 * Get whether the homogenous mode is enabled.
15088 * @param obj The toolbar object.
15089 * @return Assume the items within the toolbar are of the same height
15090 * and width (EINA_TRUE = on, EINA_FALSE = off).
15092 * @see elm_toolbar_homogeneous_set()
15096 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15099 * Enable/disable homogenous mode.
15101 * @param obj The toolbar object
15102 * @param homogeneous Assume the items within the toolbar are of the
15103 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15105 * This will enable the homogeneous mode where items are of the same size.
15106 * @see elm_toolbar_homogeneous_get()
15108 * @deprecated use elm_toolbar_homogeneous_set() instead.
15112 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
15115 * Get whether the homogenous mode is enabled.
15117 * @param obj The toolbar object.
15118 * @return Assume the items within the toolbar are of the same height
15119 * and width (EINA_TRUE = on, EINA_FALSE = off).
15121 * @see elm_toolbar_homogeneous_set()
15122 * @deprecated use elm_toolbar_homogeneous_get() instead.
15126 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15129 * Set the parent object of the toolbar items' menus.
15131 * @param obj The toolbar object.
15132 * @param parent The parent of the menu objects.
15134 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15136 * For more details about setting the parent for toolbar menus, see
15137 * elm_menu_parent_set().
15139 * @see elm_menu_parent_set() for details.
15140 * @see elm_toolbar_item_menu_set() for details.
15144 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15147 * Get the parent object of the toolbar items' menus.
15149 * @param obj The toolbar object.
15150 * @return The parent of the menu objects.
15152 * @see elm_toolbar_menu_parent_set() for details.
15156 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15159 * Set the alignment of the items.
15161 * @param obj The toolbar object.
15162 * @param align The new alignment, a float between <tt> 0.0 </tt>
15163 * and <tt> 1.0 </tt>.
15165 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15166 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15169 * Centered items by default.
15171 * @see elm_toolbar_align_get()
15175 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15178 * Get the alignment of the items.
15180 * @param obj The toolbar object.
15181 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15184 * @see elm_toolbar_align_set() for details.
15188 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15191 * Set whether the toolbar item opens a menu.
15193 * @param item The toolbar item.
15194 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15196 * A toolbar item can be set to be a menu, using this function.
15198 * Once it is set to be a menu, it can be manipulated through the
15199 * menu-like function elm_toolbar_menu_parent_set() and the other
15200 * elm_menu functions, using the Evas_Object @c menu returned by
15201 * elm_toolbar_item_menu_get().
15203 * So, items to be displayed in this item's menu should be added with
15204 * elm_menu_item_add().
15206 * The following code exemplifies the most basic usage:
15208 * tb = elm_toolbar_add(win)
15209 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15210 * elm_toolbar_item_menu_set(item, EINA_TRUE);
15211 * elm_toolbar_menu_parent_set(tb, win);
15212 * menu = elm_toolbar_item_menu_get(item);
15213 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15214 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15218 * @see elm_toolbar_item_menu_get()
15222 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15225 * Get toolbar item's menu.
15227 * @param item The toolbar item.
15228 * @return Item's menu object or @c NULL on failure.
15230 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15231 * this function will set it.
15233 * @see elm_toolbar_item_menu_set() for details.
15237 EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15240 * Add a new state to @p item.
15242 * @param item The item.
15243 * @param icon A string with icon name or the absolute path of an image file.
15244 * @param label The label of the new state.
15245 * @param func The function to call when the item is clicked when this
15246 * state is selected.
15247 * @param data The data to associate with the state.
15248 * @return The toolbar item state, or @c NULL upon failure.
15250 * Toolbar will load icon image from fdo or current theme.
15251 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15252 * If an absolute path is provided it will load it direct from a file.
15254 * States created with this function can be removed with
15255 * elm_toolbar_item_state_del().
15257 * @see elm_toolbar_item_state_del()
15258 * @see elm_toolbar_item_state_sel()
15259 * @see elm_toolbar_item_state_get()
15263 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);
15266 * Delete a previoulsy added state to @p item.
15268 * @param item The toolbar item.
15269 * @param state The state to be deleted.
15270 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15272 * @see elm_toolbar_item_state_add()
15274 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15277 * Set @p state as the current state of @p it.
15279 * @param it The item.
15280 * @param state The state to use.
15281 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15283 * If @p state is @c NULL, it won't select any state and the default item's
15284 * icon and label will be used. It's the same behaviour than
15285 * elm_toolbar_item_state_unser().
15287 * @see elm_toolbar_item_state_unset()
15291 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15294 * Unset the state of @p it.
15296 * @param it The item.
15298 * The default icon and label from this item will be displayed.
15300 * @see elm_toolbar_item_state_set() for more details.
15304 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15307 * Get the current state of @p it.
15309 * @param item The item.
15310 * @return The selected state or @c NULL if none is selected or on failure.
15312 * @see elm_toolbar_item_state_set() for details.
15313 * @see elm_toolbar_item_state_unset()
15314 * @see elm_toolbar_item_state_add()
15318 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15321 * Get the state after selected state in toolbar's @p item.
15323 * @param it The toolbar item to change state.
15324 * @return The state after current state, or @c NULL on failure.
15326 * If last state is selected, this function will return first state.
15328 * @see elm_toolbar_item_state_set()
15329 * @see elm_toolbar_item_state_add()
15333 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15336 * Get the state before selected state in toolbar's @p item.
15338 * @param it The toolbar item to change state.
15339 * @return The state before current state, or @c NULL on failure.
15341 * If first state is selected, this function will return last state.
15343 * @see elm_toolbar_item_state_set()
15344 * @see elm_toolbar_item_state_add()
15348 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15351 * Set the text to be shown in a given toolbar item's tooltips.
15353 * @param item Target item.
15354 * @param text The text to set in the content.
15356 * Setup the text as tooltip to object. The item can have only one tooltip,
15357 * so any previous tooltip data - set with this function or
15358 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15360 * @see elm_object_tooltip_text_set() for more details.
15364 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15367 * Set the content to be shown in the tooltip item.
15369 * Setup the tooltip to item. The item can have only one tooltip,
15370 * so any previous tooltip data is removed. @p func(with @p data) will
15371 * be called every time that need show the tooltip and it should
15372 * return a valid Evas_Object. This object is then managed fully by
15373 * tooltip system and is deleted when the tooltip is gone.
15375 * @param item the toolbar item being attached a tooltip.
15376 * @param func the function used to create the tooltip contents.
15377 * @param data what to provide to @a func as callback data/context.
15378 * @param del_cb called when data is not needed anymore, either when
15379 * another callback replaces @a func, the tooltip is unset with
15380 * elm_toolbar_item_tooltip_unset() or the owner @a item
15381 * dies. This callback receives as the first parameter the
15382 * given @a data, and @c event_info is the item.
15384 * @see elm_object_tooltip_content_cb_set() for more details.
15388 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);
15391 * Unset tooltip from item.
15393 * @param item toolbar item to remove previously set tooltip.
15395 * Remove tooltip from item. The callback provided as del_cb to
15396 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15397 * it is not used anymore.
15399 * @see elm_object_tooltip_unset() for more details.
15400 * @see elm_toolbar_item_tooltip_content_cb_set()
15404 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15407 * Sets a different style for this item tooltip.
15409 * @note before you set a style you should define a tooltip with
15410 * elm_toolbar_item_tooltip_content_cb_set() or
15411 * elm_toolbar_item_tooltip_text_set()
15413 * @param item toolbar item with tooltip already set.
15414 * @param style the theme style to use (default, transparent, ...)
15416 * @see elm_object_tooltip_style_set() for more details.
15420 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15423 * Get the style for this item tooltip.
15425 * @param item toolbar item with tooltip already set.
15426 * @return style the theme style in use, defaults to "default". If the
15427 * object does not have a tooltip set, then NULL is returned.
15429 * @see elm_object_tooltip_style_get() for more details.
15430 * @see elm_toolbar_item_tooltip_style_set()
15434 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15437 * Set the type of mouse pointer/cursor decoration to be shown,
15438 * when the mouse pointer is over the given toolbar widget item
15440 * @param item toolbar item to customize cursor on
15441 * @param cursor the cursor type's name
15443 * This function works analogously as elm_object_cursor_set(), but
15444 * here the cursor's changing area is restricted to the item's
15445 * area, and not the whole widget's. Note that that item cursors
15446 * have precedence over widget cursors, so that a mouse over an
15447 * item with custom cursor set will always show @b that cursor.
15449 * If this function is called twice for an object, a previously set
15450 * cursor will be unset on the second call.
15452 * @see elm_object_cursor_set()
15453 * @see elm_toolbar_item_cursor_get()
15454 * @see elm_toolbar_item_cursor_unset()
15458 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15461 * Get the type of mouse pointer/cursor decoration set to be shown,
15462 * when the mouse pointer is over the given toolbar widget item
15464 * @param item toolbar item with custom cursor set
15465 * @return the cursor type's name or @c NULL, if no custom cursors
15466 * were set to @p item (and on errors)
15468 * @see elm_object_cursor_get()
15469 * @see elm_toolbar_item_cursor_set()
15470 * @see elm_toolbar_item_cursor_unset()
15474 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15477 * Unset any custom mouse pointer/cursor decoration set to be
15478 * shown, when the mouse pointer is over the given toolbar widget
15479 * item, thus making it show the @b default cursor again.
15481 * @param item a toolbar item
15483 * Use this call to undo any custom settings on this item's cursor
15484 * decoration, bringing it back to defaults (no custom style set).
15486 * @see elm_object_cursor_unset()
15487 * @see elm_toolbar_item_cursor_set()
15491 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15494 * Set a different @b style for a given custom cursor set for a
15497 * @param item toolbar item with custom cursor set
15498 * @param style the <b>theme style</b> to use (e.g. @c "default",
15499 * @c "transparent", etc)
15501 * This function only makes sense when one is using custom mouse
15502 * cursor decorations <b>defined in a theme file</b>, which can have,
15503 * given a cursor name/type, <b>alternate styles</b> on it. It
15504 * works analogously as elm_object_cursor_style_set(), but here
15505 * applyed only to toolbar item objects.
15507 * @warning Before you set a cursor style you should have definen a
15508 * custom cursor previously on the item, with
15509 * elm_toolbar_item_cursor_set()
15511 * @see elm_toolbar_item_cursor_engine_only_set()
15512 * @see elm_toolbar_item_cursor_style_get()
15516 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15519 * Get the current @b style set for a given toolbar item's custom
15522 * @param item toolbar item with custom cursor set.
15523 * @return style the cursor style in use. If the object does not
15524 * have a cursor set, then @c NULL is returned.
15526 * @see elm_toolbar_item_cursor_style_set() for more details
15530 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15533 * Set if the (custom)cursor for a given toolbar item should be
15534 * searched in its theme, also, or should only rely on the
15535 * rendering engine.
15537 * @param item item with custom (custom) cursor already set on
15538 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15539 * only on those provided by the rendering engine, @c EINA_FALSE to
15540 * have them searched on the widget's theme, as well.
15542 * @note This call is of use only if you've set a custom cursor
15543 * for toolbar items, with elm_toolbar_item_cursor_set().
15545 * @note By default, cursors will only be looked for between those
15546 * provided by the rendering engine.
15550 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15553 * Get if the (custom) cursor for a given toolbar item is being
15554 * searched in its theme, also, or is only relying on the rendering
15557 * @param item a toolbar item
15558 * @return @c EINA_TRUE, if cursors are being looked for only on
15559 * those provided by the rendering engine, @c EINA_FALSE if they
15560 * are being searched on the widget's theme, as well.
15562 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15566 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15569 * Change a toolbar's orientation
15570 * @param obj The toolbar object
15571 * @param vertical If @c EINA_TRUE, the toolbar is vertical
15572 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15574 * @deprecated use elm_toolbar_horizontal_set() instead.
15576 EINA_DEPRECATED EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15579 * Change a toolbar's orientation
15580 * @param obj The toolbar object
15581 * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15582 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15585 EAPI void elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15588 * Get a toolbar's orientation
15589 * @param obj The toolbar object
15590 * @return If @c EINA_TRUE, the toolbar is vertical
15591 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15593 * @deprecated use elm_toolbar_horizontal_get() instead.
15595 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15598 * Get a toolbar's orientation
15599 * @param obj The toolbar object
15600 * @return If @c EINA_TRUE, the toolbar is horizontal
15601 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15604 EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15610 * @defgroup Tooltips Tooltips
15612 * The Tooltip is an (internal, for now) smart object used to show a
15613 * content in a frame on mouse hover of objects(or widgets), with
15614 * tips/information about them.
15619 EAPI double elm_tooltip_delay_get(void);
15620 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
15621 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15622 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15623 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15624 EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15625 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15626 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);
15627 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15628 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15629 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15632 * @defgroup Cursors Cursors
15634 * The Elementary cursor is an internal smart object used to
15635 * customize the mouse cursor displayed over objects (or
15636 * widgets). In the most common scenario, the cursor decoration
15637 * comes from the graphical @b engine Elementary is running
15638 * on. Those engines may provide different decorations for cursors,
15639 * and Elementary provides functions to choose them (think of X11
15640 * cursors, as an example).
15642 * There's also the possibility of, besides using engine provided
15643 * cursors, also use ones coming from Edje theming files. Both
15644 * globally and per widget, Elementary makes it possible for one to
15645 * make the cursors lookup to be held on engines only or on
15646 * Elementary's theme file, too. To set cursor's hot spot,
15647 * two data items should be added to cursor's theme: "hot_x" and
15648 * "hot_y", that are the offset from upper-left corner of the cursor
15649 * (coordinates 0,0).
15655 * Set the cursor to be shown when mouse is over the object
15657 * Set the cursor that will be displayed when mouse is over the
15658 * object. The object can have only one cursor set to it, so if
15659 * this function is called twice for an object, the previous set
15661 * If using X cursors, a definition of all the valid cursor names
15662 * is listed on Elementary_Cursors.h. If an invalid name is set
15663 * the default cursor will be used.
15665 * @param obj the object being set a cursor.
15666 * @param cursor the cursor name to be used.
15670 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15673 * Get the cursor to be shown when mouse is over the object
15675 * @param obj an object with cursor already set.
15676 * @return the cursor name.
15680 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15683 * Unset cursor for object
15685 * Unset cursor for object, and set the cursor to default if the mouse
15686 * was over this object.
15688 * @param obj Target object
15689 * @see elm_object_cursor_set()
15693 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15696 * Sets a different style for this object cursor.
15698 * @note before you set a style you should define a cursor with
15699 * elm_object_cursor_set()
15701 * @param obj an object with cursor already set.
15702 * @param style the theme style to use (default, transparent, ...)
15706 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15709 * Get the style for this object cursor.
15711 * @param obj an object with cursor already set.
15712 * @return style the theme style in use, defaults to "default". If the
15713 * object does not have a cursor set, then NULL is returned.
15717 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15720 * Set if the cursor set should be searched on the theme or should use
15721 * the provided by the engine, only.
15723 * @note before you set if should look on theme you should define a cursor
15724 * with elm_object_cursor_set(). By default it will only look for cursors
15725 * provided by the engine.
15727 * @param obj an object with cursor already set.
15728 * @param engine_only boolean to define it cursors should be looked only
15729 * between the provided by the engine or searched on widget's theme as well.
15733 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15736 * Get the cursor engine only usage for this object cursor.
15738 * @param obj an object with cursor already set.
15739 * @return engine_only boolean to define it cursors should be
15740 * looked only between the provided by the engine or searched on
15741 * widget's theme as well. If the object does not have a cursor
15742 * set, then EINA_FALSE is returned.
15746 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15749 * Get the configured cursor engine only usage
15751 * This gets the globally configured exclusive usage of engine cursors.
15753 * @return 1 if only engine cursors should be used
15756 EAPI int elm_cursor_engine_only_get(void);
15759 * Set the configured cursor engine only usage
15761 * This sets the globally configured exclusive usage of engine cursors.
15762 * It won't affect cursors set before changing this value.
15764 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15765 * look for them on theme before.
15766 * @return EINA_TRUE if value is valid and setted (0 or 1)
15769 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
15776 * @defgroup Menu Menu
15778 * @image html img/widget/menu/preview-00.png
15779 * @image latex img/widget/menu/preview-00.eps
15781 * A menu is a list of items displayed above its parent. When the menu is
15782 * showing its parent is darkened. Each item can have a sub-menu. The menu
15783 * object can be used to display a menu on a right click event, in a toolbar,
15786 * Signals that you can add callbacks for are:
15787 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15788 * event_info is NULL.
15790 * @see @ref tutorial_menu
15793 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15795 * @brief Add a new menu to the parent
15797 * @param parent The parent object.
15798 * @return The new object or NULL if it cannot be created.
15800 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15802 * @brief Set the parent for the given menu widget
15804 * @param obj The menu object.
15805 * @param parent The new parent.
15807 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15809 * @brief Get the parent for the given menu widget
15811 * @param obj The menu object.
15812 * @return The parent.
15814 * @see elm_menu_parent_set()
15816 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15818 * @brief Move the menu to a new position
15820 * @param obj The menu object.
15821 * @param x The new position.
15822 * @param y The new position.
15824 * Sets the top-left position of the menu to (@p x,@p y).
15826 * @note @p x and @p y coordinates are relative to parent.
15828 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15830 * @brief Close a opened menu
15832 * @param obj the menu object
15835 * Hides the menu and all it's sub-menus.
15837 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15839 * @brief Returns a list of @p item's items.
15841 * @param obj The menu object
15842 * @return An Eina_List* of @p item's items
15844 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15846 * @brief Get the Evas_Object of an Elm_Menu_Item
15848 * @param item The menu item object.
15849 * @return The edje object containing the swallowed content
15851 * @warning Don't manipulate this object!
15853 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15855 * @brief Add an item at the end of the given menu widget
15857 * @param obj The menu object.
15858 * @param parent The parent menu item (optional)
15859 * @param icon A icon display on the item. The icon will be destryed by the menu.
15860 * @param label The label of the item.
15861 * @param func Function called when the user select the item.
15862 * @param data Data sent by the callback.
15863 * @return Returns the new item.
15865 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);
15867 * @brief Add an object swallowed in an item at the end of the given menu
15870 * @param obj The menu object.
15871 * @param parent The parent menu item (optional)
15872 * @param subobj The object to swallow
15873 * @param func Function called when the user select the item.
15874 * @param data Data sent by the callback.
15875 * @return Returns the new item.
15877 * Add an evas object as an item to the menu.
15879 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);
15881 * @brief Set the label of a menu item
15883 * @param item The menu item object.
15884 * @param label The label to set for @p item
15886 * @warning Don't use this funcion on items created with
15887 * elm_menu_item_add_object() or elm_menu_item_separator_add().
15889 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15891 * @brief Get the label of a menu item
15893 * @param item The menu item object.
15894 * @return The label of @p item
15896 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15898 * @brief Set the icon of a menu item to the standard icon with name @p icon
15900 * @param item The menu item object.
15901 * @param icon The icon object to set for the content of @p item
15903 * Once this icon is set, any previously set icon will be deleted.
15905 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
15907 * @brief Get the string representation from the icon of a menu item
15909 * @param item The menu item object.
15910 * @return The string representation of @p item's icon or NULL
15912 * @see elm_menu_item_object_icon_name_set()
15914 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15916 * @brief Set the content object of a menu item
15918 * @param item The menu item object
15919 * @param The content object or NULL
15920 * @return EINA_TRUE on success, else EINA_FALSE
15922 * Use this function to change the object swallowed by a menu item, deleting
15923 * any previously swallowed object.
15925 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
15927 * @brief Get the content object of a menu item
15929 * @param item The menu item object
15930 * @return The content object or NULL
15931 * @note If @p item was added with elm_menu_item_add_object, this
15932 * function will return the object passed, else it will return the
15935 * @see elm_menu_item_object_content_set()
15937 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15939 EINA_DEPRECATED extern inline void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2)
15941 elm_menu_item_object_icon_name_set(item, icon);
15944 EINA_DEPRECATED extern inline Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1)
15946 return elm_menu_item_object_content_get(item);
15949 EINA_DEPRECATED extern inline const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1)
15951 return elm_menu_item_object_icon_name_get(item);
15955 * @brief Set the selected state of @p item.
15957 * @param item The menu item object.
15958 * @param selected The selected/unselected state of the item
15960 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15962 * @brief Get the selected state of @p item.
15964 * @param item The menu item object.
15965 * @return The selected/unselected state of the item
15967 * @see elm_menu_item_selected_set()
15969 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15971 * @brief Set the disabled state of @p item.
15973 * @param item The menu item object.
15974 * @param disabled The enabled/disabled state of the item
15976 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15978 * @brief Get the disabled state of @p item.
15980 * @param item The menu item object.
15981 * @return The enabled/disabled state of the item
15983 * @see elm_menu_item_disabled_set()
15985 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15987 * @brief Add a separator item to menu @p obj under @p parent.
15989 * @param obj The menu object
15990 * @param parent The item to add the separator under
15991 * @return The created item or NULL on failure
15993 * This is item is a @ref Separator.
15995 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
15997 * @brief Returns whether @p item is a separator.
15999 * @param item The item to check
16000 * @return If true, @p item is a separator
16002 * @see elm_menu_item_separator_add()
16004 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16006 * @brief Deletes an item from the menu.
16008 * @param item The item to delete.
16010 * @see elm_menu_item_add()
16012 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16014 * @brief Set the function called when a menu item is deleted.
16016 * @param item The item to set the callback on
16017 * @param func The function called
16019 * @see elm_menu_item_add()
16020 * @see elm_menu_item_del()
16022 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16024 * @brief Returns the data associated with menu item @p item.
16026 * @param item The item
16027 * @return The data associated with @p item or NULL if none was set.
16029 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
16031 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16033 * @brief Sets the data to be associated with menu item @p item.
16035 * @param item The item
16036 * @param data The data to be associated with @p item
16038 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
16040 * @brief Returns a list of @p item's subitems.
16042 * @param item The item
16043 * @return An Eina_List* of @p item's subitems
16045 * @see elm_menu_add()
16047 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16049 * @brief Get the position of a menu item
16051 * @param item The menu item
16052 * @return The item's index
16054 * This function returns the index position of a menu item in a menu.
16055 * For a sub-menu, this number is relative to the first item in the sub-menu.
16057 * @note Index values begin with 0
16059 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16061 * @brief @brief Return a menu item's owner menu
16063 * @param item The menu item
16064 * @return The menu object owning @p item, or NULL on failure
16066 * Use this function to get the menu object owning an item.
16068 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16070 * @brief Get the selected item in the menu
16072 * @param obj The menu object
16073 * @return The selected item, or NULL if none
16075 * @see elm_menu_item_selected_get()
16076 * @see elm_menu_item_selected_set()
16078 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16080 * @brief Get the last item in the menu
16082 * @param obj The menu object
16083 * @return The last item, or NULL if none
16085 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16087 * @brief Get the first item in the menu
16089 * @param obj The menu object
16090 * @return The first item, or NULL if none
16092 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16094 * @brief Get the next item in the menu.
16096 * @param item The menu item object.
16097 * @return The item after it, or NULL if none
16099 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16101 * @brief Get the previous item in the menu.
16103 * @param item The menu item object.
16104 * @return The item before it, or NULL if none
16106 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16112 * @defgroup List List
16113 * @ingroup Elementary
16115 * @image html img/widget/list/preview-00.png
16116 * @image latex img/widget/list/preview-00.eps width=\textwidth
16118 * @image html img/list.png
16119 * @image latex img/list.eps width=\textwidth
16121 * A list widget is a container whose children are displayed vertically or
16122 * horizontally, in order, and can be selected.
16123 * The list can accept only one or multiple items selection. Also has many
16124 * modes of items displaying.
16126 * A list is a very simple type of list widget. For more robust
16127 * lists, @ref Genlist should probably be used.
16129 * Smart callbacks one can listen to:
16130 * - @c "activated" - The user has double-clicked or pressed
16131 * (enter|return|spacebar) on an item. The @c event_info parameter
16132 * is the item that was activated.
16133 * - @c "clicked,double" - The user has double-clicked an item.
16134 * The @c event_info parameter is the item that was double-clicked.
16135 * - "selected" - when the user selected an item
16136 * - "unselected" - when the user unselected an item
16137 * - "longpressed" - an item in the list is long-pressed
16138 * - "edge,top" - the list is scrolled until the top edge
16139 * - "edge,bottom" - the list is scrolled until the bottom edge
16140 * - "edge,left" - the list is scrolled until the left edge
16141 * - "edge,right" - the list is scrolled until the right edge
16142 * - "language,changed" - the program's language changed
16144 * Available styles for it:
16147 * List of examples:
16148 * @li @ref list_example_01
16149 * @li @ref list_example_02
16150 * @li @ref list_example_03
16159 * @enum _Elm_List_Mode
16160 * @typedef Elm_List_Mode
16162 * Set list's resize behavior, transverse axis scroll and
16163 * items cropping. See each mode's description for more details.
16165 * @note Default value is #ELM_LIST_SCROLL.
16167 * Values <b> don't </b> work as bitmask, only one can be choosen.
16169 * @see elm_list_mode_set()
16170 * @see elm_list_mode_get()
16174 typedef enum _Elm_List_Mode
16176 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. */
16177 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). */
16178 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. */
16179 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. */
16180 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16183 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(). */
16186 * Add a new list widget to the given parent Elementary
16187 * (container) object.
16189 * @param parent The parent object.
16190 * @return a new list widget handle or @c NULL, on errors.
16192 * This function inserts a new list widget on the canvas.
16196 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16201 * @param obj The list object
16203 * @note Call before running show() on the list object.
16204 * @warning If not called, it won't display the list properly.
16207 * li = elm_list_add(win);
16208 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16209 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16211 * evas_object_show(li);
16216 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16219 * Enable or disable multiple items selection on the list object.
16221 * @param obj The list object
16222 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16225 * Disabled by default. If disabled, the user can select a single item of
16226 * the list each time. Selected items are highlighted on list.
16227 * If enabled, many items can be selected.
16229 * If a selected item is selected again, it will be unselected.
16231 * @see elm_list_multi_select_get()
16235 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16238 * Get a value whether multiple items selection is enabled or not.
16240 * @see elm_list_multi_select_set() for details.
16242 * @param obj The list object.
16243 * @return @c EINA_TRUE means multiple items selection is enabled.
16244 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16245 * @c EINA_FALSE is returned.
16249 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16252 * Set which mode to use for the list object.
16254 * @param obj The list object
16255 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16256 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16258 * Set list's resize behavior, transverse axis scroll and
16259 * items cropping. See each mode's description for more details.
16261 * @note Default value is #ELM_LIST_SCROLL.
16263 * Only one can be set, if a previous one was set, it will be changed
16264 * by the new mode set. Bitmask won't work as well.
16266 * @see elm_list_mode_get()
16270 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16273 * Get the mode the list is at.
16275 * @param obj The list object
16276 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16277 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16279 * @note see elm_list_mode_set() for more information.
16283 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16286 * Enable or disable horizontal mode on the list object.
16288 * @param obj The list object.
16289 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16290 * disable it, i.e., to enable vertical mode.
16292 * @note Vertical mode is set by default.
16294 * On horizontal mode items are displayed on list from left to right,
16295 * instead of from top to bottom. Also, the list will scroll horizontally.
16296 * Each item will presents left icon on top and right icon, or end, at
16299 * @see elm_list_horizontal_get()
16303 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16306 * Get a value whether horizontal mode is enabled or not.
16308 * @param obj The list object.
16309 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16310 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16311 * @c EINA_FALSE is returned.
16313 * @see elm_list_horizontal_set() for details.
16317 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16320 * Enable or disable always select mode on the list object.
16322 * @param obj The list object
16323 * @param always_select @c EINA_TRUE to enable always select mode or
16324 * @c EINA_FALSE to disable it.
16326 * @note Always select mode is disabled by default.
16328 * Default behavior of list items is to only call its callback function
16329 * the first time it's pressed, i.e., when it is selected. If a selected
16330 * item is pressed again, and multi-select is disabled, it won't call
16331 * this function (if multi-select is enabled it will unselect the item).
16333 * If always select is enabled, it will call the callback function
16334 * everytime a item is pressed, so it will call when the item is selected,
16335 * and again when a selected item is pressed.
16337 * @see elm_list_always_select_mode_get()
16338 * @see elm_list_multi_select_set()
16342 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16345 * Get a value whether always select mode is enabled or not, meaning that
16346 * an item will always call its callback function, even if already selected.
16348 * @param obj The list object
16349 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16350 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16351 * @c EINA_FALSE is returned.
16353 * @see elm_list_always_select_mode_set() for details.
16357 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16360 * Set bouncing behaviour when the scrolled content reaches an edge.
16362 * Tell the internal scroller object whether it should bounce or not
16363 * when it reaches the respective edges for each axis.
16365 * @param obj The list object
16366 * @param h_bounce Whether to bounce or not in the horizontal axis.
16367 * @param v_bounce Whether to bounce or not in the vertical axis.
16369 * @see elm_scroller_bounce_set()
16373 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16376 * Get the bouncing behaviour of the internal scroller.
16378 * Get whether the internal scroller should bounce when the edge of each
16379 * axis is reached scrolling.
16381 * @param obj The list object.
16382 * @param h_bounce Pointer where to store the bounce state of the horizontal
16384 * @param v_bounce Pointer where to store the bounce state of the vertical
16387 * @see elm_scroller_bounce_get()
16388 * @see elm_list_bounce_set()
16392 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16395 * Set the scrollbar policy.
16397 * @param obj The list object
16398 * @param policy_h Horizontal scrollbar policy.
16399 * @param policy_v Vertical scrollbar policy.
16401 * This sets the scrollbar visibility policy for the given scroller.
16402 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16403 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16404 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16405 * This applies respectively for the horizontal and vertical scrollbars.
16407 * The both are disabled by default, i.e., are set to
16408 * #ELM_SCROLLER_POLICY_OFF.
16412 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16415 * Get the scrollbar policy.
16417 * @see elm_list_scroller_policy_get() for details.
16419 * @param obj The list object.
16420 * @param policy_h Pointer where to store horizontal scrollbar policy.
16421 * @param policy_v Pointer where to store vertical scrollbar policy.
16425 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);
16428 * Append a new item to the list object.
16430 * @param obj The list object.
16431 * @param label The label of the list item.
16432 * @param icon The icon object to use for the left side of the item. An
16433 * icon can be any Evas object, but usually it is an icon created
16434 * with elm_icon_add().
16435 * @param end The icon object to use for the right side of the item. An
16436 * icon can be any Evas object.
16437 * @param func The function to call when the item is clicked.
16438 * @param data The data to associate with the item for related callbacks.
16440 * @return The created item or @c NULL upon failure.
16442 * A new item will be created and appended to the list, i.e., will
16443 * be set as @b last item.
16445 * Items created with this method can be deleted with
16446 * elm_list_item_del().
16448 * Associated @p data can be properly freed when item is deleted if a
16449 * callback function is set with elm_list_item_del_cb_set().
16451 * If a function is passed as argument, it will be called everytime this item
16452 * is selected, i.e., the user clicks over an unselected item.
16453 * If always select is enabled it will call this function every time
16454 * user clicks over an item (already selected or not).
16455 * If such function isn't needed, just passing
16456 * @c NULL as @p func is enough. The same should be done for @p data.
16458 * Simple example (with no function callback or data associated):
16460 * li = elm_list_add(win);
16461 * ic = elm_icon_add(win);
16462 * elm_icon_file_set(ic, "path/to/image", NULL);
16463 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16464 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16466 * evas_object_show(li);
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_append(Evas_Object *obj, const char *label, Evas_Object *icon, Evas_Object *end, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
16480 * Prepend a new item to the 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.
16492 * @return The created item or @c NULL upon failure.
16494 * A new item will be created and prepended to the list, i.e., will
16495 * be set as @b first item.
16497 * Items created with this method can be deleted with
16498 * elm_list_item_del().
16500 * Associated @p data can be properly freed when item is deleted if a
16501 * callback function is set with elm_list_item_del_cb_set().
16503 * If a function is passed as argument, it will be called everytime this item
16504 * is selected, i.e., the user clicks over an unselected item.
16505 * If always select is enabled it will call this function every time
16506 * user clicks over an item (already selected or not).
16507 * If such function isn't needed, just passing
16508 * @c NULL as @p func is enough. The same should be done for @p data.
16510 * @see elm_list_item_append() for a simple code example.
16511 * @see elm_list_always_select_mode_set()
16512 * @see elm_list_item_del()
16513 * @see elm_list_item_del_cb_set()
16514 * @see elm_list_clear()
16515 * @see elm_icon_add()
16519 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);
16522 * Insert a new item into the list object before item @p before.
16524 * @param obj The list object.
16525 * @param before The list item to insert before.
16526 * @param label The label of the list item.
16527 * @param icon The icon object to use for the left side of the item. An
16528 * icon can be any Evas object, but usually it is an icon created
16529 * with elm_icon_add().
16530 * @param end The icon object to use for the right side of the item. An
16531 * icon can be any Evas object.
16532 * @param func The function to call when the item is clicked.
16533 * @param data The data to associate with the item for related callbacks.
16535 * @return The created item or @c NULL upon failure.
16537 * A new item will be created and added to the list. Its position in
16538 * this list will be just before item @p before.
16540 * Items created with this method can be deleted with
16541 * elm_list_item_del().
16543 * Associated @p data can be properly freed when item is deleted if a
16544 * callback function is set with elm_list_item_del_cb_set().
16546 * If a function is passed as argument, it will be called everytime this item
16547 * is selected, i.e., the user clicks over an unselected item.
16548 * If always select is enabled it will call this function every time
16549 * user clicks over an item (already selected or not).
16550 * If such function isn't needed, just passing
16551 * @c NULL as @p func is enough. The same should be done for @p data.
16553 * @see elm_list_item_append() for a simple code example.
16554 * @see elm_list_always_select_mode_set()
16555 * @see elm_list_item_del()
16556 * @see elm_list_item_del_cb_set()
16557 * @see elm_list_clear()
16558 * @see elm_icon_add()
16562 EAPI Elm_List_Item *elm_list_item_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);
16565 * Insert a new item into the list object after item @p after.
16567 * @param obj The list object.
16568 * @param after The list item to insert after.
16569 * @param label The label of the list item.
16570 * @param icon The icon object to use for the left side of the item. An
16571 * icon can be any Evas object, but usually it is an icon created
16572 * with elm_icon_add().
16573 * @param end The icon object to use for the right side of the item. An
16574 * icon can be any Evas object.
16575 * @param func The function to call when the item is clicked.
16576 * @param data The data to associate with the item for related callbacks.
16578 * @return The created item or @c NULL upon failure.
16580 * A new item will be created and added to the list. Its position in
16581 * this list will be just after item @p after.
16583 * Items created with this method can be deleted with
16584 * elm_list_item_del().
16586 * Associated @p data can be properly freed when item is deleted if a
16587 * callback function is set with elm_list_item_del_cb_set().
16589 * If a function is passed as argument, it will be called everytime this item
16590 * is selected, i.e., the user clicks over an unselected item.
16591 * If always select is enabled it will call this function every time
16592 * user clicks over an item (already selected or not).
16593 * If such function isn't needed, just passing
16594 * @c NULL as @p func is enough. The same should be done for @p data.
16596 * @see elm_list_item_append() for a simple code example.
16597 * @see elm_list_always_select_mode_set()
16598 * @see elm_list_item_del()
16599 * @see elm_list_item_del_cb_set()
16600 * @see elm_list_clear()
16601 * @see elm_icon_add()
16605 EAPI Elm_List_Item *elm_list_item_insert_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);
16608 * Insert a new item into the sorted list object.
16610 * @param obj The list object.
16611 * @param label The label of the list item.
16612 * @param icon The icon object to use for the left side of the item. An
16613 * icon can be any Evas object, but usually it is an icon created
16614 * with elm_icon_add().
16615 * @param end The icon object to use for the right side of the item. An
16616 * icon can be any Evas object.
16617 * @param func The function to call when the item is clicked.
16618 * @param data The data to associate with the item for related callbacks.
16619 * @param cmp_func The comparing function to be used to sort list
16620 * items <b>by #Elm_List_Item item handles</b>. This function will
16621 * receive two items and compare them, returning a non-negative integer
16622 * if the second item should be place after the first, or negative value
16623 * if should be placed before.
16625 * @return The created item or @c NULL upon failure.
16627 * @note This function inserts values into a list object assuming it was
16628 * sorted and the result will be sorted.
16630 * A new item will be created and added to the list. Its position in
16631 * this list will be found comparing the new item with previously inserted
16632 * items using function @p cmp_func.
16634 * Items created with this method can be deleted with
16635 * elm_list_item_del().
16637 * Associated @p data can be properly freed when item is deleted if a
16638 * callback function is set with elm_list_item_del_cb_set().
16640 * If a function is passed as argument, it will be called everytime this item
16641 * is selected, i.e., the user clicks over an unselected item.
16642 * If always select is enabled it will call this function every time
16643 * user clicks over an item (already selected or not).
16644 * If such function isn't needed, just passing
16645 * @c NULL as @p func is enough. The same should be done for @p data.
16647 * @see elm_list_item_append() for a simple code example.
16648 * @see elm_list_always_select_mode_set()
16649 * @see elm_list_item_del()
16650 * @see elm_list_item_del_cb_set()
16651 * @see elm_list_clear()
16652 * @see elm_icon_add()
16656 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);
16659 * Remove all list's items.
16661 * @param obj The list object
16663 * @see elm_list_item_del()
16664 * @see elm_list_item_append()
16668 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16671 * Get a list of all the list items.
16673 * @param obj The list object
16674 * @return An @c Eina_List of list items, #Elm_List_Item,
16675 * or @c NULL on failure.
16677 * @see elm_list_item_append()
16678 * @see elm_list_item_del()
16679 * @see elm_list_clear()
16683 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16686 * Get the selected item.
16688 * @param obj The list object.
16689 * @return The selected list item.
16691 * The selected item can be unselected with function
16692 * elm_list_item_selected_set().
16694 * The selected item always will be highlighted on list.
16696 * @see elm_list_selected_items_get()
16700 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16703 * Return a list of the currently selected list items.
16705 * @param obj The list object.
16706 * @return An @c Eina_List of list items, #Elm_List_Item,
16707 * or @c NULL on failure.
16709 * Multiple items can be selected if multi select is enabled. It can be
16710 * done with elm_list_multi_select_set().
16712 * @see elm_list_selected_item_get()
16713 * @see elm_list_multi_select_set()
16717 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16720 * Set the selected state of an item.
16722 * @param item The list item
16723 * @param selected The selected state
16725 * This sets the selected state of the given item @p it.
16726 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16728 * If a new item is selected the previosly selected will be unselected,
16729 * unless multiple selection is enabled with elm_list_multi_select_set().
16730 * Previoulsy selected item can be get with function
16731 * elm_list_selected_item_get().
16733 * Selected items will be highlighted.
16735 * @see elm_list_item_selected_get()
16736 * @see elm_list_selected_item_get()
16737 * @see elm_list_multi_select_set()
16741 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16744 * Get whether the @p item is selected or not.
16746 * @param item The list item.
16747 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16748 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16750 * @see elm_list_selected_item_set() for details.
16751 * @see elm_list_item_selected_get()
16755 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16758 * Set or unset item as a separator.
16760 * @param it The list item.
16761 * @param setting @c EINA_TRUE to set item @p it as separator or
16762 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16764 * Items aren't set as separator by default.
16766 * If set as separator it will display separator theme, so won't display
16769 * @see elm_list_item_separator_get()
16773 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16776 * Get a value whether item is a separator or not.
16778 * @see elm_list_item_separator_set() for details.
16780 * @param it The list item.
16781 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16782 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16786 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16789 * Show @p item in the list view.
16791 * @param item The list item to be shown.
16793 * It won't animate list until item is visible. If such behavior is wanted,
16794 * use elm_list_bring_in() intead.
16798 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16801 * Bring in the given item to list view.
16803 * @param item The item.
16805 * This causes list to jump to the given item @p item and show it
16806 * (by scrolling), if it is not fully visible.
16808 * This may use animation to do so and take a period of time.
16810 * If animation isn't wanted, elm_list_item_show() can be used.
16814 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16817 * Delete them item from the list.
16819 * @param item The item of list to be deleted.
16821 * If deleting all list items is required, elm_list_clear()
16822 * should be used instead of getting items list and deleting each one.
16824 * @see elm_list_clear()
16825 * @see elm_list_item_append()
16826 * @see elm_list_item_del_cb_set()
16830 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16833 * Set the function called when a list item is freed.
16835 * @param item The item to set the callback on
16836 * @param func The function called
16838 * If there is a @p func, then it will be called prior item's memory release.
16839 * That will be called with the following arguments:
16841 * @li item's Evas object;
16844 * This way, a data associated to a list item could be properly freed.
16848 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16851 * Get the data associated to the item.
16853 * @param item The list item
16854 * @return The data associated to @p item
16856 * The return value is a pointer to data associated to @p item when it was
16857 * created, with function elm_list_item_append() or similar. If no data
16858 * was passed as argument, it will return @c NULL.
16860 * @see elm_list_item_append()
16864 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16867 * Get the left side icon associated to the item.
16869 * @param item The list item
16870 * @return The left side icon associated to @p item
16872 * The return value is a pointer to the icon associated to @p item when
16874 * created, with function elm_list_item_append() or similar, or later
16875 * with function elm_list_item_icon_set(). If no icon
16876 * was passed as argument, it will return @c NULL.
16878 * @see elm_list_item_append()
16879 * @see elm_list_item_icon_set()
16883 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16886 * Set the left side icon associated to the item.
16888 * @param item The list item
16889 * @param icon The left side icon object to associate with @p item
16891 * The icon object to use at left side of the item. An
16892 * icon can be any Evas object, but usually it is an icon created
16893 * with elm_icon_add().
16895 * Once the icon object is set, a previously set one will be deleted.
16896 * @warning Setting the same icon for two items will cause the icon to
16897 * dissapear from the first item.
16899 * If an icon was passed as argument on item creation, with function
16900 * elm_list_item_append() or similar, it will be already
16901 * associated to the item.
16903 * @see elm_list_item_append()
16904 * @see elm_list_item_icon_get()
16908 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16911 * Get the right side icon associated to the item.
16913 * @param item The list item
16914 * @return The right side icon associated to @p item
16916 * The return value is a pointer to the icon associated to @p item when
16918 * created, with function elm_list_item_append() or similar, or later
16919 * with function elm_list_item_icon_set(). If no icon
16920 * was passed as argument, it will return @c NULL.
16922 * @see elm_list_item_append()
16923 * @see elm_list_item_icon_set()
16927 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16930 * Set the right side icon associated to the item.
16932 * @param item The list item
16933 * @param end The right side icon object to associate with @p item
16935 * The icon object to use at right side of the item. An
16936 * icon can be any Evas object, but usually it is an icon created
16937 * with elm_icon_add().
16939 * Once the icon object is set, a previously set one will be deleted.
16940 * @warning Setting the same icon for two items will cause the icon to
16941 * dissapear from the first item.
16943 * If an icon was passed as argument on item creation, with function
16944 * elm_list_item_append() or similar, it will be already
16945 * associated to the item.
16947 * @see elm_list_item_append()
16948 * @see elm_list_item_end_get()
16952 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
16953 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16956 * Gets the base object of the item.
16958 * @param item The list item
16959 * @return The base object associated with @p item
16961 * Base object is the @c Evas_Object that represents that item.
16965 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16968 * Get the label of item.
16970 * @param item The item of list.
16971 * @return The label of item.
16973 * The return value is a pointer to the label associated to @p item when
16974 * it was created, with function elm_list_item_append(), or later
16975 * with function elm_list_item_label_set. If no label
16976 * was passed as argument, it will return @c NULL.
16978 * @see elm_list_item_label_set() for more details.
16979 * @see elm_list_item_append()
16983 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16986 * Set the label of item.
16988 * @param item The item of list.
16989 * @param text The label of item.
16991 * The label to be displayed by the item.
16992 * Label will be placed between left and right side icons (if set).
16994 * If a label was passed as argument on item creation, with function
16995 * elm_list_item_append() or similar, it will be already
16996 * displayed by the item.
16998 * @see elm_list_item_label_get()
16999 * @see elm_list_item_append()
17003 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17007 * Get the item before @p it in list.
17009 * @param it The list item.
17010 * @return The item before @p it, or @c NULL if none or on failure.
17012 * @note If it is the first item, @c NULL will be returned.
17014 * @see elm_list_item_append()
17015 * @see elm_list_items_get()
17019 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17022 * Get the item after @p it in list.
17024 * @param it The list item.
17025 * @return The item after @p it, or @c NULL if none or on failure.
17027 * @note If it is the last item, @c NULL will be returned.
17029 * @see elm_list_item_append()
17030 * @see elm_list_items_get()
17034 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17037 * Sets the disabled/enabled state of a list item.
17039 * @param it The item.
17040 * @param disabled The disabled state.
17042 * A disabled item cannot be selected or unselected. It will also
17043 * change its appearance (generally greyed out). This sets the
17044 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
17049 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17052 * Get a value whether list item is disabled or not.
17054 * @param it The item.
17055 * @return The disabled state.
17057 * @see elm_list_item_disabled_set() for more details.
17061 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17064 * Set the text to be shown in a given list item's tooltips.
17066 * @param item Target item.
17067 * @param text The text to set in the content.
17069 * Setup the text as tooltip to object. The item can have only one tooltip,
17070 * so any previous tooltip data - set with this function or
17071 * elm_list_item_tooltip_content_cb_set() - is removed.
17073 * @see elm_object_tooltip_text_set() for more details.
17077 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17081 * @brief Disable size restrictions on an object's tooltip
17082 * @param item The tooltip's anchor object
17083 * @param disable If EINA_TRUE, size restrictions are disabled
17084 * @return EINA_FALSE on failure, EINA_TRUE on success
17086 * This function allows a tooltip to expand beyond its parant window's canvas.
17087 * It will instead be limited only by the size of the display.
17089 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17091 * @brief Retrieve size restriction state of an object's tooltip
17092 * @param obj The tooltip's anchor object
17093 * @return If EINA_TRUE, size restrictions are disabled
17095 * This function returns whether a tooltip is allowed to expand beyond
17096 * its parant window's canvas.
17097 * It will instead be limited only by the size of the display.
17099 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17102 * Set the content to be shown in the tooltip item.
17104 * Setup the tooltip to item. The item can have only one tooltip,
17105 * so any previous tooltip data is removed. @p func(with @p data) will
17106 * be called every time that need show the tooltip and it should
17107 * return a valid Evas_Object. This object is then managed fully by
17108 * tooltip system and is deleted when the tooltip is gone.
17110 * @param item the list item being attached a tooltip.
17111 * @param func the function used to create the tooltip contents.
17112 * @param data what to provide to @a func as callback data/context.
17113 * @param del_cb called when data is not needed anymore, either when
17114 * another callback replaces @a func, the tooltip is unset with
17115 * elm_list_item_tooltip_unset() or the owner @a item
17116 * dies. This callback receives as the first parameter the
17117 * given @a data, and @c event_info is the item.
17119 * @see elm_object_tooltip_content_cb_set() for more details.
17123 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);
17126 * Unset tooltip from item.
17128 * @param item list item to remove previously set tooltip.
17130 * Remove tooltip from item. The callback provided as del_cb to
17131 * elm_list_item_tooltip_content_cb_set() will be called to notify
17132 * it is not used anymore.
17134 * @see elm_object_tooltip_unset() for more details.
17135 * @see elm_list_item_tooltip_content_cb_set()
17139 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17142 * Sets a different style for this item tooltip.
17144 * @note before you set a style you should define a tooltip with
17145 * elm_list_item_tooltip_content_cb_set() or
17146 * elm_list_item_tooltip_text_set()
17148 * @param item list item with tooltip already set.
17149 * @param style the theme style to use (default, transparent, ...)
17151 * @see elm_object_tooltip_style_set() for more details.
17155 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17158 * Get the style for this item tooltip.
17160 * @param item list item with tooltip already set.
17161 * @return style the theme style in use, defaults to "default". If the
17162 * object does not have a tooltip set, then NULL is returned.
17164 * @see elm_object_tooltip_style_get() for more details.
17165 * @see elm_list_item_tooltip_style_set()
17169 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17172 * Set the type of mouse pointer/cursor decoration to be shown,
17173 * when the mouse pointer is over the given list widget item
17175 * @param item list item to customize cursor on
17176 * @param cursor the cursor type's name
17178 * This function works analogously as elm_object_cursor_set(), but
17179 * here the cursor's changing area is restricted to the item's
17180 * area, and not the whole widget's. Note that that item cursors
17181 * have precedence over widget cursors, so that a mouse over an
17182 * item with custom cursor set will always show @b that cursor.
17184 * If this function is called twice for an object, a previously set
17185 * cursor will be unset on the second call.
17187 * @see elm_object_cursor_set()
17188 * @see elm_list_item_cursor_get()
17189 * @see elm_list_item_cursor_unset()
17193 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17196 * Get the type of mouse pointer/cursor decoration set to be shown,
17197 * when the mouse pointer is over the given list widget item
17199 * @param item list item with custom cursor set
17200 * @return the cursor type's name or @c NULL, if no custom cursors
17201 * were set to @p item (and on errors)
17203 * @see elm_object_cursor_get()
17204 * @see elm_list_item_cursor_set()
17205 * @see elm_list_item_cursor_unset()
17209 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17212 * Unset any custom mouse pointer/cursor decoration set to be
17213 * shown, when the mouse pointer is over the given list widget
17214 * item, thus making it show the @b default cursor again.
17216 * @param item a list item
17218 * Use this call to undo any custom settings on this item's cursor
17219 * decoration, bringing it back to defaults (no custom style set).
17221 * @see elm_object_cursor_unset()
17222 * @see elm_list_item_cursor_set()
17226 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17229 * Set a different @b style for a given custom cursor set for a
17232 * @param item list item with custom cursor set
17233 * @param style the <b>theme style</b> to use (e.g. @c "default",
17234 * @c "transparent", etc)
17236 * This function only makes sense when one is using custom mouse
17237 * cursor decorations <b>defined in a theme file</b>, which can have,
17238 * given a cursor name/type, <b>alternate styles</b> on it. It
17239 * works analogously as elm_object_cursor_style_set(), but here
17240 * applyed only to list item objects.
17242 * @warning Before you set a cursor style you should have definen a
17243 * custom cursor previously on the item, with
17244 * elm_list_item_cursor_set()
17246 * @see elm_list_item_cursor_engine_only_set()
17247 * @see elm_list_item_cursor_style_get()
17251 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17254 * Get the current @b style set for a given list item's custom
17257 * @param item list item with custom cursor set.
17258 * @return style the cursor style in use. If the object does not
17259 * have a cursor set, then @c NULL is returned.
17261 * @see elm_list_item_cursor_style_set() for more details
17265 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17268 * Set if the (custom)cursor for a given list item should be
17269 * searched in its theme, also, or should only rely on the
17270 * rendering engine.
17272 * @param item item with custom (custom) cursor already set on
17273 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17274 * only on those provided by the rendering engine, @c EINA_FALSE to
17275 * have them searched on the widget's theme, as well.
17277 * @note This call is of use only if you've set a custom cursor
17278 * for list items, with elm_list_item_cursor_set().
17280 * @note By default, cursors will only be looked for between those
17281 * provided by the rendering engine.
17285 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17288 * Get if the (custom) cursor for a given list item is being
17289 * searched in its theme, also, or is only relying on the rendering
17292 * @param item a list item
17293 * @return @c EINA_TRUE, if cursors are being looked for only on
17294 * those provided by the rendering engine, @c EINA_FALSE if they
17295 * are being searched on the widget's theme, as well.
17297 * @see elm_list_item_cursor_engine_only_set(), for more details
17301 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17308 * @defgroup Slider Slider
17309 * @ingroup Elementary
17311 * @image html img/widget/slider/preview-00.png
17312 * @image latex img/widget/slider/preview-00.eps width=\textwidth
17314 * The slider adds a dragable āsliderā widget for selecting the value of
17315 * something within a range.
17317 * A slider can be horizontal or vertical. It can contain an Icon and has a
17318 * primary label as well as a units label (that is formatted with floating
17319 * point values and thus accepts a printf-style format string, like
17320 * ā%1.2f unitsā. There is also an indicator string that may be somewhere
17321 * else (like on the slider itself) that also accepts a format string like
17322 * units. Label, Icon Unit and Indicator strings/objects are optional.
17324 * A slider may be inverted which means values invert, with high vales being
17325 * on the left or top and low values on the right or bottom (as opposed to
17326 * normally being low on the left or top and high on the bottom and right).
17328 * The slider should have its minimum and maximum values set by the
17329 * application with elm_slider_min_max_set() and value should also be set by
17330 * the application before use with elm_slider_value_set(). The span of the
17331 * slider is its length (horizontally or vertically). This will be scaled by
17332 * the object or applications scaling factor. At any point code can query the
17333 * slider for its value with elm_slider_value_get().
17335 * Smart callbacks one can listen to:
17336 * - "changed" - Whenever the slider value is changed by the user.
17337 * - "slider,drag,start" - dragging the slider indicator around has started.
17338 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17339 * - "delay,changed" - A short time after the value is changed by the user.
17340 * This will be called only when the user stops dragging for
17341 * a very short period or when they release their
17342 * finger/mouse, so it avoids possibly expensive reactions to
17343 * the value change.
17345 * Available styles for it:
17348 * Default contents parts of the slider widget that you can use for are:
17349 * @li "elm.swallow.icon" - A icon of the slider
17350 * @li "elm.swallow.end" - A end part content of the slider
17352 * Here is an example on its usage:
17353 * @li @ref slider_example
17356 #define ELM_SLIDER_CONTENT_ICON "elm.swallow.icon"
17357 #define ELM_SLIDER_CONTENT_END "elm.swallow.end"
17360 * @addtogroup Slider
17365 * Add a new slider widget to the given parent Elementary
17366 * (container) object.
17368 * @param parent The parent object.
17369 * @return a new slider widget handle or @c NULL, on errors.
17371 * This function inserts a new slider widget on the canvas.
17375 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17378 * Set the label of a given slider widget
17380 * @param obj The progress bar object
17381 * @param label The text label string, in UTF-8
17384 * @deprecated use elm_object_text_set() instead.
17386 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17389 * Get the label of a given slider widget
17391 * @param obj The progressbar object
17392 * @return The text label string, in UTF-8
17395 * @deprecated use elm_object_text_get() instead.
17397 EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17400 * Set the icon object of the slider object.
17402 * @param obj The slider object.
17403 * @param icon The icon object.
17405 * On horizontal mode, icon is placed at left, and on vertical mode,
17408 * @note Once the icon object is set, a previously set one will be deleted.
17409 * If you want to keep that old content object, use the
17410 * elm_slider_icon_unset() function.
17412 * @warning If the object being set does not have minimum size hints set,
17413 * it won't get properly displayed.
17416 * @deprecated use elm_object_content_set() instead.
17418 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17421 * Unset an icon set on a given slider widget.
17423 * @param obj The slider object.
17424 * @return The icon object that was being used, if any was set, or
17425 * @c NULL, otherwise (and on errors).
17427 * On horizontal mode, icon is placed at left, and on vertical mode,
17430 * This call will unparent and return the icon object which was set
17431 * for this widget, previously, on success.
17433 * @see elm_slider_icon_set() for more details
17434 * @see elm_slider_icon_get()
17435 * @deprecated use elm_object_content_unset() instead.
17439 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17442 * Retrieve the icon object set for a given slider widget.
17444 * @param obj The slider object.
17445 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17446 * otherwise (and on errors).
17448 * On horizontal mode, icon is placed at left, and on vertical mode,
17451 * @see elm_slider_icon_set() for more details
17452 * @see elm_slider_icon_unset()
17456 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17459 * Set the end object of the slider object.
17461 * @param obj The slider object.
17462 * @param end The end object.
17464 * On horizontal mode, end is placed at left, and on vertical mode,
17465 * placed at bottom.
17467 * @note Once the icon object is set, a previously set one will be deleted.
17468 * If you want to keep that old content object, use the
17469 * elm_slider_end_unset() function.
17471 * @warning If the object being set does not have minimum size hints set,
17472 * it won't get properly displayed.
17476 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17479 * Unset an end object set on a given slider widget.
17481 * @param obj The slider object.
17482 * @return The end object that was being used, if any was set, or
17483 * @c NULL, otherwise (and on errors).
17485 * On horizontal mode, end is placed at left, and on vertical mode,
17486 * placed at bottom.
17488 * This call will unparent and return the icon object which was set
17489 * for this widget, previously, on success.
17491 * @see elm_slider_end_set() for more details.
17492 * @see elm_slider_end_get()
17496 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17499 * Retrieve the end object set for a given slider widget.
17501 * @param obj The slider object.
17502 * @return The end object's handle, if @p obj had one set, or @c NULL,
17503 * otherwise (and on errors).
17505 * On horizontal mode, icon is placed at right, and on vertical mode,
17506 * placed at bottom.
17508 * @see elm_slider_end_set() for more details.
17509 * @see elm_slider_end_unset()
17513 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17516 * Set the (exact) length of the bar region of a given slider widget.
17518 * @param obj The slider object.
17519 * @param size The length of the slider's bar region.
17521 * This sets the minimum width (when in horizontal mode) or height
17522 * (when in vertical mode) of the actual bar area of the slider
17523 * @p obj. This in turn affects the object's minimum size. Use
17524 * this when you're not setting other size hints expanding on the
17525 * given direction (like weight and alignment hints) and you would
17526 * like it to have a specific size.
17528 * @note Icon, end, label, indicator and unit text around @p obj
17529 * will require their
17530 * own space, which will make @p obj to require more the @p size,
17533 * @see elm_slider_span_size_get()
17537 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17540 * Get the length set for the bar region of a given slider widget
17542 * @param obj The slider object.
17543 * @return The length of the slider's bar region.
17545 * If that size was not set previously, with
17546 * elm_slider_span_size_set(), this call will return @c 0.
17550 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17553 * Set the format string for the unit label.
17555 * @param obj The slider object.
17556 * @param format The format string for the unit display.
17558 * Unit label is displayed all the time, if set, after slider's bar.
17559 * In horizontal mode, at right and in vertical mode, at bottom.
17561 * If @c NULL, unit label won't be visible. If not it sets the format
17562 * string for the label text. To the label text is provided a floating point
17563 * value, so the label text can display up to 1 floating point value.
17564 * Note that this is optional.
17566 * Use a format string such as "%1.2f meters" for example, and it will
17567 * display values like: "3.14 meters" for a value equal to 3.14159.
17569 * Default is unit label disabled.
17571 * @see elm_slider_indicator_format_get()
17575 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17578 * Get the unit label format of the slider.
17580 * @param obj The slider object.
17581 * @return The unit label format string in UTF-8.
17583 * Unit label is displayed all the time, if set, after slider's bar.
17584 * In horizontal mode, at right and in vertical mode, at bottom.
17586 * @see elm_slider_unit_format_set() for more
17587 * information on how this works.
17591 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17594 * Set the format string for the indicator label.
17596 * @param obj The slider object.
17597 * @param indicator The format string for the indicator display.
17599 * The slider may display its value somewhere else then unit label,
17600 * for example, above the slider knob that is dragged around. This function
17601 * sets the format string used for this.
17603 * If @c NULL, indicator label won't be visible. If not it sets the format
17604 * string for the label text. To the label text is provided a floating point
17605 * value, so the label text can display up to 1 floating point value.
17606 * Note that this is optional.
17608 * Use a format string such as "%1.2f meters" for example, and it will
17609 * display values like: "3.14 meters" for a value equal to 3.14159.
17611 * Default is indicator label disabled.
17613 * @see elm_slider_indicator_format_get()
17617 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17620 * Get the indicator label format of the slider.
17622 * @param obj The slider object.
17623 * @return The indicator label format string in UTF-8.
17625 * The slider may display its value somewhere else then unit label,
17626 * for example, above the slider knob that is dragged around. This function
17627 * gets the format string used for this.
17629 * @see elm_slider_indicator_format_set() for more
17630 * information on how this works.
17634 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17637 * Set the format function pointer for the indicator label
17639 * @param obj The slider object.
17640 * @param func The indicator format function.
17641 * @param free_func The freeing function for the format string.
17643 * Set the callback function to format the indicator string.
17645 * @see elm_slider_indicator_format_set() for more info on how this works.
17649 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);
17652 * Set the format function pointer for the units label
17654 * @param obj The slider object.
17655 * @param func The units format function.
17656 * @param free_func The freeing function for the format string.
17658 * Set the callback function to format the indicator string.
17660 * @see elm_slider_units_format_set() for more info on how this works.
17664 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);
17667 * Set the orientation of a given slider widget.
17669 * @param obj The slider object.
17670 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17671 * @b horizontal, @c EINA_FALSE to make it @b vertical.
17673 * Use this function to change how your slider is to be
17674 * disposed: vertically or horizontally.
17676 * By default it's displayed horizontally.
17678 * @see elm_slider_horizontal_get()
17682 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17685 * Retrieve the orientation of a given slider widget
17687 * @param obj The slider object.
17688 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17689 * @c EINA_FALSE if it's @b vertical (and on errors).
17691 * @see elm_slider_horizontal_set() for more details.
17695 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17698 * Set the minimum and maximum values for the slider.
17700 * @param obj The slider object.
17701 * @param min The minimum value.
17702 * @param max The maximum value.
17704 * Define the allowed range of values to be selected by the user.
17706 * If actual value is less than @p min, it will be updated to @p min. If it
17707 * is bigger then @p max, will be updated to @p max. Actual value can be
17708 * get with elm_slider_value_get().
17710 * By default, min is equal to 0.0, and max is equal to 1.0.
17712 * @warning Maximum must be greater than minimum, otherwise behavior
17715 * @see elm_slider_min_max_get()
17719 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17722 * Get the minimum and maximum values of the slider.
17724 * @param obj The slider object.
17725 * @param min Pointer where to store the minimum value.
17726 * @param max Pointer where to store the maximum value.
17728 * @note If only one value is needed, the other pointer can be passed
17731 * @see elm_slider_min_max_set() for details.
17735 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17738 * Set the value the slider displays.
17740 * @param obj The slider object.
17741 * @param val The value to be displayed.
17743 * Value will be presented on the unit label following format specified with
17744 * elm_slider_unit_format_set() and on indicator with
17745 * elm_slider_indicator_format_set().
17747 * @warning The value must to be between min and max values. This values
17748 * are set by elm_slider_min_max_set().
17750 * @see elm_slider_value_get()
17751 * @see elm_slider_unit_format_set()
17752 * @see elm_slider_indicator_format_set()
17753 * @see elm_slider_min_max_set()
17757 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17760 * Get the value displayed by the spinner.
17762 * @param obj The spinner object.
17763 * @return The value displayed.
17765 * @see elm_spinner_value_set() for details.
17769 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17772 * Invert a given slider widget's displaying values order
17774 * @param obj The slider object.
17775 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17776 * @c EINA_FALSE to bring it back to default, non-inverted values.
17778 * A slider may be @b inverted, in which state it gets its
17779 * values inverted, with high vales being on the left or top and
17780 * low values on the right or bottom, as opposed to normally have
17781 * the low values on the former and high values on the latter,
17782 * respectively, for horizontal and vertical modes.
17784 * @see elm_slider_inverted_get()
17788 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17791 * Get whether a given slider widget's displaying values are
17794 * @param obj The slider object.
17795 * @return @c EINA_TRUE, if @p obj has inverted values,
17796 * @c EINA_FALSE otherwise (and on errors).
17798 * @see elm_slider_inverted_set() for more details.
17802 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17805 * Set whether to enlarge slider indicator (augmented knob) or not.
17807 * @param obj The slider object.
17808 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17809 * let the knob always at default size.
17811 * By default, indicator will be bigger while dragged by the user.
17813 * @warning It won't display values set with
17814 * elm_slider_indicator_format_set() if you disable indicator.
17818 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17821 * Get whether a given slider widget's enlarging indicator or not.
17823 * @param obj The slider object.
17824 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17825 * @c EINA_FALSE otherwise (and on errors).
17827 * @see elm_slider_indicator_show_set() for details.
17831 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17838 * @addtogroup Actionslider Actionslider
17840 * @image html img/widget/actionslider/preview-00.png
17841 * @image latex img/widget/actionslider/preview-00.eps
17843 * An actionslider is a switcher for 2 or 3 labels with customizable magnet
17844 * properties. The user drags and releases the indicator, to choose a label.
17846 * Labels occupy the following positions.
17851 * Positions can be enabled or disabled.
17853 * Magnets can be set on the above positions.
17855 * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
17857 * @note By default all positions are set as enabled.
17859 * Signals that you can add callbacks for are:
17861 * "selected" - when user selects an enabled position (the label is passed
17864 * "pos_changed" - when the indicator reaches any of the positions("left",
17865 * "right" or "center").
17867 * See an example of actionslider usage @ref actionslider_example_page "here"
17871 typedef enum _Elm_Actionslider_Indicator_Pos
17873 ELM_ACTIONSLIDER_INDICATOR_NONE,
17874 ELM_ACTIONSLIDER_INDICATOR_LEFT,
17875 ELM_ACTIONSLIDER_INDICATOR_RIGHT,
17876 ELM_ACTIONSLIDER_INDICATOR_CENTER
17877 } Elm_Actionslider_Indicator_Pos;
17879 typedef enum _Elm_Actionslider_Magnet_Pos
17881 ELM_ACTIONSLIDER_MAGNET_NONE = 0,
17882 ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
17883 ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
17884 ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
17885 ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
17886 ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
17887 } Elm_Actionslider_Magnet_Pos;
17889 typedef enum _Elm_Actionslider_Label_Pos
17891 ELM_ACTIONSLIDER_LABEL_LEFT,
17892 ELM_ACTIONSLIDER_LABEL_RIGHT,
17893 ELM_ACTIONSLIDER_LABEL_CENTER,
17894 ELM_ACTIONSLIDER_LABEL_BUTTON
17895 } Elm_Actionslider_Label_Pos;
17897 /* smart callbacks called:
17898 * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
17902 * Add a new actionslider to the parent.
17904 * @param parent The parent object
17905 * @return The new actionslider object or NULL if it cannot be created
17907 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17910 * Set actionslider label.
17912 * @param[in] obj The actionslider object
17913 * @param[in] pos The position of the label.
17914 * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
17915 * @param label The label which is going to be set.
17917 EAPI void elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
17919 * Get actionslider labels.
17921 * @param obj The actionslider object
17922 * @param left_label A char** to place the left_label of @p obj into.
17923 * @param center_label A char** to place the center_label of @p obj into.
17924 * @param right_label A char** to place the right_label of @p obj into.
17926 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);
17928 * Get actionslider selected label.
17930 * @param obj The actionslider object
17931 * @return The selected label
17933 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17935 * Set actionslider indicator position.
17937 * @param obj The actionslider object.
17938 * @param pos The position of the indicator.
17940 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
17942 * Get actionslider indicator position.
17944 * @param obj The actionslider object.
17945 * @return The position of the indicator.
17947 EAPI Elm_Actionslider_Indicator_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17949 * Set actionslider magnet position. To make multiple positions magnets @c or
17950 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
17952 * @param obj The actionslider object.
17953 * @param pos Bit mask indicating the magnet positions.
17955 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
17957 * Get actionslider magnet position.
17959 * @param obj The actionslider object.
17960 * @return The positions with magnet property.
17962 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17964 * Set actionslider enabled position. To set multiple positions as enabled @c or
17965 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
17967 * @note All the positions are enabled by default.
17969 * @param obj The actionslider object.
17970 * @param pos Bit mask indicating the enabled positions.
17972 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
17974 * Get actionslider enabled position.
17976 * @param obj The actionslider object.
17977 * @return The enabled positions.
17979 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17981 * Set the label used on the indicator.
17983 * @param obj The actionslider object
17984 * @param label The label to be set on the indicator.
17985 * @deprecated use elm_object_text_set() instead.
17987 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17989 * Get the label used on the indicator object.
17991 * @param obj The actionslider object
17992 * @return The indicator label
17993 * @deprecated use elm_object_text_get() instead.
17995 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
17998 * Hold actionslider object movement.
18000 * @param[in] obj The actionslider object
18001 * @param[in] flag Actionslider hold/release
18002 * (EINA_TURE = hold/EIN_FALSE = release)
18004 * @ingroup Actionslider
18006 EAPI void elm_actionslider_hold(Evas_Object *obj, Eina_Bool flag) EINA_ARG_NONNULL(1);
18014 * @defgroup Genlist Genlist
18016 * @image html img/widget/genlist/preview-00.png
18017 * @image latex img/widget/genlist/preview-00.eps
18018 * @image html img/genlist.png
18019 * @image latex img/genlist.eps
18021 * This widget aims to have more expansive list than the simple list in
18022 * Elementary that could have more flexible items and allow many more entries
18023 * while still being fast and low on memory usage. At the same time it was
18024 * also made to be able to do tree structures. But the price to pay is more
18025 * complexity when it comes to usage. If all you want is a simple list with
18026 * icons and a single label, use the normal @ref List object.
18028 * Genlist has a fairly large API, mostly because it's relatively complex,
18029 * trying to be both expansive, powerful and efficient. First we will begin
18030 * an overview on the theory behind genlist.
18032 * @section Genlist_Item_Class Genlist item classes - creating items
18034 * In order to have the ability to add and delete items on the fly, genlist
18035 * implements a class (callback) system where the application provides a
18036 * structure with information about that type of item (genlist may contain
18037 * multiple different items with different classes, states and styles).
18038 * Genlist will call the functions in this struct (methods) when an item is
18039 * "realized" (i.e., created dynamically, while the user is scrolling the
18040 * grid). All objects will simply be deleted when no longer needed with
18041 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
18042 * following members:
18043 * - @c item_style - This is a constant string and simply defines the name
18044 * of the item style. It @b must be specified and the default should be @c
18047 * - @c func - A struct with pointers to functions that will be called when
18048 * an item is going to be actually created. All of them receive a @c data
18049 * parameter that will point to the same data passed to
18050 * elm_genlist_item_append() and related item creation functions, and a @c
18051 * obj parameter that points to the genlist object itself.
18053 * The function pointers inside @c func are @c label_get, @c icon_get, @c
18054 * state_get and @c del. The 3 first functions also receive a @c part
18055 * parameter described below. A brief description of these functions follows:
18057 * - @c label_get - The @c part parameter is the name string of one of the
18058 * existing text parts in the Edje group implementing the item's theme.
18059 * This function @b must return a strdup'()ed string, as the caller will
18060 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
18061 * - @c content_get - The @c part parameter is the name string of one of the
18062 * existing (content) swallow parts in the Edje group implementing the item's
18063 * theme. It must return @c NULL, when no content is desired, or a valid
18064 * object handle, otherwise. The object will be deleted by the genlist on
18065 * its deletion or when the item is "unrealized". See
18066 * #Elm_Genlist_Item_Icon_Get_Cb.
18067 * - @c func.state_get - The @c part parameter is the name string of one of
18068 * the state parts in the Edje group implementing the item's theme. Return
18069 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
18070 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
18071 * and @c "elm" as "emission" and "source" arguments, respectively, when
18072 * the state is true (the default is false), where @c XXX is the name of
18073 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
18074 * - @c func.del - This is intended for use when genlist items are deleted,
18075 * so any data attached to the item (e.g. its data parameter on creation)
18076 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
18078 * available item styles:
18080 * - default_style - The text part is a textblock
18082 * @image html img/widget/genlist/preview-04.png
18083 * @image latex img/widget/genlist/preview-04.eps
18087 * @image html img/widget/genlist/preview-01.png
18088 * @image latex img/widget/genlist/preview-01.eps
18090 * - icon_top_text_bottom
18092 * @image html img/widget/genlist/preview-02.png
18093 * @image latex img/widget/genlist/preview-02.eps
18097 * @image html img/widget/genlist/preview-03.png
18098 * @image latex img/widget/genlist/preview-03.eps
18100 * @section Genlist_Items Structure of items
18102 * An item in a genlist can have 0 or more text labels (they can be regular
18103 * text or textblock Evas objects - that's up to the style to determine), 0
18104 * or more contents (which are simply objects swallowed into the genlist item's
18105 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18106 * behavior left to the user to define. The Edje part names for each of
18107 * these properties will be looked up, in the theme file for the genlist,
18108 * under the Edje (string) data items named @c "labels", @c "contents" and @c
18109 * "states", respectively. For each of those properties, if more than one
18110 * part is provided, they must have names listed separated by spaces in the
18111 * data fields. For the default genlist item theme, we have @b one label
18112 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18113 * "elm.swallow.end") and @b no state parts.
18115 * A genlist item may be at one of several styles. Elementary provides one
18116 * by default - "default", but this can be extended by system or application
18117 * custom themes/overlays/extensions (see @ref Theme "themes" for more
18120 * @section Genlist_Manipulation Editing and Navigating
18122 * Items can be added by several calls. All of them return a @ref
18123 * Elm_Genlist_Item handle that is an internal member inside the genlist.
18124 * They all take a data parameter that is meant to be used for a handle to
18125 * the applications internal data (eg the struct with the original item
18126 * data). The parent parameter is the parent genlist item this belongs to if
18127 * it is a tree or an indexed group, and NULL if there is no parent. The
18128 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18129 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18130 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18131 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
18132 * is set then this item is group index item that is displayed at the top
18133 * until the next group comes. The func parameter is a convenience callback
18134 * that is called when the item is selected and the data parameter will be
18135 * the func_data parameter, obj be the genlist object and event_info will be
18136 * the genlist item.
18138 * elm_genlist_item_append() adds an item to the end of the list, or if
18139 * there is a parent, to the end of all the child items of the parent.
18140 * elm_genlist_item_prepend() is the same but adds to the beginning of
18141 * the list or children list. elm_genlist_item_insert_before() inserts at
18142 * item before another item and elm_genlist_item_insert_after() inserts after
18143 * the indicated item.
18145 * The application can clear the list with elm_genlist_clear() which deletes
18146 * all the items in the list and elm_genlist_item_del() will delete a specific
18147 * item. elm_genlist_item_subitems_clear() will clear all items that are
18148 * children of the indicated parent item.
18150 * To help inspect list items you can jump to the item at the top of the list
18151 * with elm_genlist_first_item_get() which will return the item pointer, and
18152 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18153 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18154 * and previous items respectively relative to the indicated item. Using
18155 * these calls you can walk the entire item list/tree. Note that as a tree
18156 * the items are flattened in the list, so elm_genlist_item_parent_get() will
18157 * let you know which item is the parent (and thus know how to skip them if
18160 * @section Genlist_Muti_Selection Multi-selection
18162 * If the application wants multiple items to be able to be selected,
18163 * elm_genlist_multi_select_set() can enable this. If the list is
18164 * single-selection only (the default), then elm_genlist_selected_item_get()
18165 * will return the selected item, if any, or NULL I none is selected. If the
18166 * list is multi-select then elm_genlist_selected_items_get() will return a
18167 * list (that is only valid as long as no items are modified (added, deleted,
18168 * selected or unselected)).
18170 * @section Genlist_Usage_Hints Usage hints
18172 * There are also convenience functions. elm_genlist_item_genlist_get() will
18173 * return the genlist object the item belongs to. elm_genlist_item_show()
18174 * will make the scroller scroll to show that specific item so its visible.
18175 * elm_genlist_item_data_get() returns the data pointer set by the item
18176 * creation functions.
18178 * If an item changes (state of boolean changes, label or contents change),
18179 * then use elm_genlist_item_update() to have genlist update the item with
18180 * the new state. Genlist will re-realize the item thus call the functions
18181 * in the _Elm_Genlist_Item_Class for that item.
18183 * To programmatically (un)select an item use elm_genlist_item_selected_set().
18184 * To get its selected state use elm_genlist_item_selected_get(). Similarly
18185 * to expand/contract an item and get its expanded state, use
18186 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18187 * again to make an item disabled (unable to be selected and appear
18188 * differently) use elm_genlist_item_disabled_set() to set this and
18189 * elm_genlist_item_disabled_get() to get the disabled state.
18191 * In general to indicate how the genlist should expand items horizontally to
18192 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18193 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18194 * mode means that if items are too wide to fit, the scroller will scroll
18195 * horizontally. Otherwise items are expanded to fill the width of the
18196 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18197 * to the viewport width and limited to that size. This can be combined with
18198 * a different style that uses edjes' ellipsis feature (cutting text off like
18201 * Items will only call their selection func and callback when first becoming
18202 * selected. Any further clicks will do nothing, unless you enable always
18203 * select with elm_genlist_always_select_mode_set(). This means even if
18204 * selected, every click will make the selected callbacks be called.
18205 * elm_genlist_no_select_mode_set() will turn off the ability to select
18206 * items entirely and they will neither appear selected nor call selected
18207 * callback functions.
18209 * Remember that you can create new styles and add your own theme augmentation
18210 * per application with elm_theme_extension_add(). If you absolutely must
18211 * have a specific style that overrides any theme the user or system sets up
18212 * you can use elm_theme_overlay_add() to add such a file.
18214 * @section Genlist_Implementation Implementation
18216 * Evas tracks every object you create. Every time it processes an event
18217 * (mouse move, down, up etc.) it needs to walk through objects and find out
18218 * what event that affects. Even worse every time it renders display updates,
18219 * in order to just calculate what to re-draw, it needs to walk through many
18220 * many many objects. Thus, the more objects you keep active, the more
18221 * overhead Evas has in just doing its work. It is advisable to keep your
18222 * active objects to the minimum working set you need. Also remember that
18223 * object creation and deletion carries an overhead, so there is a
18224 * middle-ground, which is not easily determined. But don't keep massive lists
18225 * of objects you can't see or use. Genlist does this with list objects. It
18226 * creates and destroys them dynamically as you scroll around. It groups them
18227 * into blocks so it can determine the visibility etc. of a whole block at
18228 * once as opposed to having to walk the whole list. This 2-level list allows
18229 * for very large numbers of items to be in the list (tests have used up to
18230 * 2,000,000 items). Also genlist employs a queue for adding items. As items
18231 * may be different sizes, every item added needs to be calculated as to its
18232 * size and thus this presents a lot of overhead on populating the list, this
18233 * genlist employs a queue. Any item added is queued and spooled off over
18234 * time, actually appearing some time later, so if your list has many members
18235 * you may find it takes a while for them to all appear, with your process
18236 * consuming a lot of CPU while it is busy spooling.
18238 * Genlist also implements a tree structure, but it does so with callbacks to
18239 * the application, with the application filling in tree structures when
18240 * requested (allowing for efficient building of a very deep tree that could
18241 * even be used for file-management). See the above smart signal callbacks for
18244 * @section Genlist_Smart_Events Genlist smart events
18246 * Signals that you can add callbacks for are:
18247 * - @c "activated" - The user has double-clicked or pressed
18248 * (enter|return|spacebar) on an item. The @c event_info parameter is the
18249 * item that was activated.
18250 * - @c "clicked,double" - The user has double-clicked an item. The @c
18251 * event_info parameter is the item that was double-clicked.
18252 * - @c "selected" - This is called when a user has made an item selected.
18253 * The event_info parameter is the genlist item that was selected.
18254 * - @c "unselected" - This is called when a user has made an item
18255 * unselected. The event_info parameter is the genlist item that was
18257 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18258 * called and the item is now meant to be expanded. The event_info
18259 * parameter is the genlist item that was indicated to expand. It is the
18260 * job of this callback to then fill in the child items.
18261 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18262 * called and the item is now meant to be contracted. The event_info
18263 * parameter is the genlist item that was indicated to contract. It is the
18264 * job of this callback to then delete the child items.
18265 * - @c "expand,request" - This is called when a user has indicated they want
18266 * to expand a tree branch item. The callback should decide if the item can
18267 * expand (has any children) and then call elm_genlist_item_expanded_set()
18268 * appropriately to set the state. The event_info parameter is the genlist
18269 * item that was indicated to expand.
18270 * - @c "contract,request" - This is called when a user has indicated they
18271 * want to contract a tree branch item. The callback should decide if the
18272 * item can contract (has any children) and then call
18273 * elm_genlist_item_expanded_set() appropriately to set the state. The
18274 * event_info parameter is the genlist item that was indicated to contract.
18275 * - @c "realized" - This is called when the item in the list is created as a
18276 * real evas object. event_info parameter is the genlist item that was
18277 * created. The object may be deleted at any time, so it is up to the
18278 * caller to not use the object pointer from elm_genlist_item_object_get()
18279 * in a way where it may point to freed objects.
18280 * - @c "unrealized" - This is called just before an item is unrealized.
18281 * After this call content objects provided will be deleted and the item
18282 * object itself delete or be put into a floating cache.
18283 * - @c "drag,start,up" - This is called when the item in the list has been
18284 * dragged (not scrolled) up.
18285 * - @c "drag,start,down" - This is called when the item in the list has been
18286 * dragged (not scrolled) down.
18287 * - @c "drag,start,left" - This is called when the item in the list has been
18288 * dragged (not scrolled) left.
18289 * - @c "drag,start,right" - This is called when the item in the list has
18290 * been dragged (not scrolled) right.
18291 * - @c "drag,stop" - This is called when the item in the list has stopped
18293 * - @c "drag" - This is called when the item in the list is being dragged.
18294 * - @c "longpressed" - This is called when the item is pressed for a certain
18295 * amount of time. By default it's 1 second.
18296 * - @c "scroll,anim,start" - This is called when scrolling animation has
18298 * - @c "scroll,anim,stop" - This is called when scrolling animation has
18300 * - @c "scroll,drag,start" - This is called when dragging the content has
18302 * - @c "scroll,drag,stop" - This is called when dragging the content has
18304 * - @c "edge,top" - This is called when the genlist is scrolled until
18306 * - @c "edge,bottom" - This is called when the genlist is scrolled
18307 * until the bottom edge.
18308 * - @c "edge,left" - This is called when the genlist is scrolled
18309 * until the left edge.
18310 * - @c "edge,right" - This is called when the genlist is scrolled
18311 * until the right edge.
18312 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18314 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18316 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18318 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18320 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18321 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
18322 * multi-touch pinched in.
18323 * - @c "swipe" - This is called when the genlist is swiped.
18324 * - @c "moved" - This is called when a genlist item is moved.
18325 * - @c "language,changed" - This is called when the program's language is
18328 * @section Genlist_Examples Examples
18330 * Here is a list of examples that use the genlist, trying to show some of
18331 * its capabilities:
18332 * - @ref genlist_example_01
18333 * - @ref genlist_example_02
18334 * - @ref genlist_example_03
18335 * - @ref genlist_example_04
18336 * - @ref genlist_example_05
18340 * @addtogroup Genlist
18345 * @enum _Elm_Genlist_Item_Flags
18346 * @typedef Elm_Genlist_Item_Flags
18348 * Defines if the item is of any special type (has subitems or it's the
18349 * index of a group), or is just a simple item.
18353 typedef enum _Elm_Genlist_Item_Flags
18355 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18356 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18357 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18358 } Elm_Genlist_Item_Flags;
18359 typedef enum _Elm_Genlist_Item_Field_Flags
18361 ELM_GENLIST_ITEM_FIELD_ALL = 0,
18362 ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
18363 ELM_GENLIST_ITEM_FIELD_ICON = (1 << 1),
18364 ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
18365 } Elm_Genlist_Item_Field_Flags;
18366 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
18367 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18368 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
18369 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
18370 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
18371 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
18372 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj);
18373 typedef void (*GenlistItemMovedFunc) ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
18376 * @struct _Elm_Genlist_Item_Class
18378 * Genlist item class definition structs.
18380 * This struct contains the style and fetching functions that will define the
18381 * contents of each item.
18383 * @see @ref Genlist_Item_Class
18385 struct _Elm_Genlist_Item_Class
18387 const char *item_style;
18389 GenlistItemLabelGetFunc label_get;
18390 GenlistItemIconGetFunc icon_get;
18391 GenlistItemStateGetFunc state_get;
18392 GenlistItemDelFunc del;
18393 GenlistItemMovedFunc moved;
18395 const char *edit_item_style;
18396 const char *mode_item_style;
18398 #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18400 * Add a new genlist widget to the given parent Elementary
18401 * (container) object
18403 * @param parent The parent object
18404 * @return a new genlist widget handle or @c NULL, on errors
18406 * This function inserts a new genlist widget on the canvas.
18408 * @see elm_genlist_item_append()
18409 * @see elm_genlist_item_del()
18410 * @see elm_genlist_clear()
18414 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18416 * Remove all items from a given genlist widget.
18418 * @param obj The genlist object
18420 * This removes (and deletes) all items in @p obj, leaving it empty.
18422 * @see elm_genlist_item_del(), to remove just one item.
18426 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18428 * Enable or disable multi-selection in the genlist
18430 * @param obj The genlist object
18431 * @param multi Multi-select enable/disable. Default is disabled.
18433 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18434 * the list. This allows more than 1 item to be selected. To retrieve the list
18435 * of selected items, use elm_genlist_selected_items_get().
18437 * @see elm_genlist_selected_items_get()
18438 * @see elm_genlist_multi_select_get()
18442 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18444 * Gets if multi-selection in genlist is enabled or disabled.
18446 * @param obj The genlist object
18447 * @return Multi-select enabled/disabled
18448 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18450 * @see elm_genlist_multi_select_set()
18454 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18456 * This sets the horizontal stretching mode.
18458 * @param obj The genlist object
18459 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18461 * This sets the mode used for sizing items horizontally. Valid modes
18462 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18463 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18464 * the scroller will scroll horizontally. Otherwise items are expanded
18465 * to fill the width of the viewport of the scroller. If it is
18466 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18467 * limited to that size.
18469 * @see elm_genlist_horizontal_get()
18473 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18475 * Gets the horizontal stretching mode.
18477 * @param obj The genlist object
18478 * @return The mode to use
18479 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18481 * @see elm_genlist_horizontal_set()
18485 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18487 * Set the always select mode.
18489 * @param obj The genlist object
18490 * @param always_select The always select mode (@c EINA_TRUE = on, @c
18491 * EINA_FALSE = off). Default is @c EINA_FALSE.
18493 * Items will only call their selection func and callback when first
18494 * becoming selected. Any further clicks will do nothing, unless you
18495 * enable always select with elm_genlist_always_select_mode_set().
18496 * This means that, even if selected, every click will make the selected
18497 * callbacks be called.
18499 * @see elm_genlist_always_select_mode_get()
18503 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18505 * Get the always select mode.
18507 * @param obj The genlist object
18508 * @return The always select mode
18509 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18511 * @see elm_genlist_always_select_mode_set()
18515 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18517 * Enable/disable the no select mode.
18519 * @param obj The genlist object
18520 * @param no_select The no select mode
18521 * (EINA_TRUE = on, EINA_FALSE = off)
18523 * This will turn off the ability to select items entirely and they
18524 * will neither appear selected nor call selected callback functions.
18526 * @see elm_genlist_no_select_mode_get()
18530 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18532 * Gets whether the no select mode is enabled.
18534 * @param obj The genlist object
18535 * @return The no select mode
18536 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18538 * @see elm_genlist_no_select_mode_set()
18542 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18544 * Enable/disable compress mode.
18546 * @param obj The genlist object
18547 * @param compress The compress mode
18548 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18550 * This will enable the compress mode where items are "compressed"
18551 * horizontally to fit the genlist scrollable viewport width. This is
18552 * special for genlist. Do not rely on
18553 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18554 * work as genlist needs to handle it specially.
18556 * @see elm_genlist_compress_mode_get()
18560 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18562 * Get whether the compress mode is enabled.
18564 * @param obj The genlist object
18565 * @return The compress mode
18566 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18568 * @see elm_genlist_compress_mode_set()
18572 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18574 * Enable/disable height-for-width mode.
18576 * @param obj The genlist object
18577 * @param setting The height-for-width mode (@c EINA_TRUE = on,
18578 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18580 * With height-for-width mode the item width will be fixed (restricted
18581 * to a minimum of) to the list width when calculating its size in
18582 * order to allow the height to be calculated based on it. This allows,
18583 * for instance, text block to wrap lines if the Edje part is
18584 * configured with "text.min: 0 1".
18586 * @note This mode will make list resize slower as it will have to
18587 * recalculate every item height again whenever the list width
18590 * @note When height-for-width mode is enabled, it also enables
18591 * compress mode (see elm_genlist_compress_mode_set()) and
18592 * disables homogeneous (see elm_genlist_homogeneous_set()).
18596 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18598 * Get whether the height-for-width mode is enabled.
18600 * @param obj The genlist object
18601 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18606 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18608 * Enable/disable horizontal and vertical bouncing effect.
18610 * @param obj The genlist object
18611 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18612 * EINA_FALSE = off). Default is @c EINA_FALSE.
18613 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18614 * EINA_FALSE = off). Default is @c EINA_TRUE.
18616 * This will enable or disable the scroller bouncing effect for the
18617 * genlist. See elm_scroller_bounce_set() for details.
18619 * @see elm_scroller_bounce_set()
18620 * @see elm_genlist_bounce_get()
18624 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18626 * Get whether the horizontal and vertical bouncing effect is enabled.
18628 * @param obj The genlist object
18629 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18631 * @param v_bounce Pointer to a bool to receive if the bounce vertically
18634 * @see elm_genlist_bounce_set()
18638 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18640 * Enable/disable homogenous mode.
18642 * @param obj The genlist object
18643 * @param homogeneous Assume the items within the genlist are of the
18644 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18647 * This will enable the homogeneous mode where items are of the same
18648 * height and width so that genlist may do the lazy-loading at its
18649 * maximum (which increases the performance for scrolling the list). This
18650 * implies 'compressed' mode.
18652 * @see elm_genlist_compress_mode_set()
18653 * @see elm_genlist_homogeneous_get()
18657 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18659 * Get whether the homogenous mode is enabled.
18661 * @param obj The genlist object
18662 * @return Assume the items within the genlist are of the same height
18663 * and width (EINA_TRUE = on, EINA_FALSE = off)
18665 * @see elm_genlist_homogeneous_set()
18669 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18671 * Set the maximum number of items within an item block
18673 * @param obj The genlist object
18674 * @param n Maximum number of items within an item block. Default is 32.
18676 * This will configure the block count to tune to the target with
18677 * particular performance matrix.
18679 * A block of objects will be used to reduce the number of operations due to
18680 * many objects in the screen. It can determine the visibility, or if the
18681 * object has changed, it theme needs to be updated, etc. doing this kind of
18682 * calculation to the entire block, instead of per object.
18684 * The default value for the block count is enough for most lists, so unless
18685 * you know you will have a lot of objects visible in the screen at the same
18686 * time, don't try to change this.
18688 * @see elm_genlist_block_count_get()
18689 * @see @ref Genlist_Implementation
18693 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18695 * Get the maximum number of items within an item block
18697 * @param obj The genlist object
18698 * @return Maximum number of items within an item block
18700 * @see elm_genlist_block_count_set()
18704 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18706 * Set the timeout in seconds for the longpress event.
18708 * @param obj The genlist object
18709 * @param timeout timeout in seconds. Default is 1.
18711 * This option will change how long it takes to send an event "longpressed"
18712 * after the mouse down signal is sent to the list. If this event occurs, no
18713 * "clicked" event will be sent.
18715 * @see elm_genlist_longpress_timeout_set()
18719 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18721 * Get the timeout in seconds for the longpress event.
18723 * @param obj The genlist object
18724 * @return timeout in seconds
18726 * @see elm_genlist_longpress_timeout_get()
18730 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18732 * Append a new item in a given genlist widget.
18734 * @param obj The genlist object
18735 * @param itc The item class for the item
18736 * @param data The item data
18737 * @param parent The parent item, or NULL if none
18738 * @param flags Item flags
18739 * @param func Convenience function called when the item is selected
18740 * @param func_data Data passed to @p func above.
18741 * @return A handle to the item added or @c NULL if not possible
18743 * This adds the given item to the end of the list or the end of
18744 * the children list if the @p parent is given.
18746 * @see elm_genlist_item_prepend()
18747 * @see elm_genlist_item_insert_before()
18748 * @see elm_genlist_item_insert_after()
18749 * @see elm_genlist_item_del()
18753 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);
18755 * Prepend a new item in a given genlist widget.
18757 * @param obj The genlist object
18758 * @param itc The item class for the item
18759 * @param data The item data
18760 * @param parent The parent item, or NULL if none
18761 * @param flags Item flags
18762 * @param func Convenience function called when the item is selected
18763 * @param func_data Data passed to @p func above.
18764 * @return A handle to the item added or NULL if not possible
18766 * This adds an item to the beginning of the list or beginning of the
18767 * children of the parent if given.
18769 * @see elm_genlist_item_append()
18770 * @see elm_genlist_item_insert_before()
18771 * @see elm_genlist_item_insert_after()
18772 * @see elm_genlist_item_del()
18776 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);
18778 * Insert an item before another in a genlist widget
18780 * @param obj The genlist object
18781 * @param itc The item class for the item
18782 * @param data The item data
18783 * @param before The item to place this new one before.
18784 * @param flags Item flags
18785 * @param func Convenience function called when the item is selected
18786 * @param func_data Data passed to @p func above.
18787 * @return A handle to the item added or @c NULL if not possible
18789 * This inserts an item before another in the list. It will be in the
18790 * same tree level or group as the item it is inserted before.
18792 * @see elm_genlist_item_append()
18793 * @see elm_genlist_item_prepend()
18794 * @see elm_genlist_item_insert_after()
18795 * @see elm_genlist_item_del()
18799 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);
18801 * Insert an item after another in a genlist widget
18803 * @param obj The genlist object
18804 * @param itc The item class for the item
18805 * @param data The item data
18806 * @param after The item to place this new one after.
18807 * @param flags Item flags
18808 * @param func Convenience function called when the item is selected
18809 * @param func_data Data passed to @p func above.
18810 * @return A handle to the item added or @c NULL if not possible
18812 * This inserts an item after another in the list. It will be in the
18813 * same tree level or group as the item it is inserted after.
18815 * @see elm_genlist_item_append()
18816 * @see elm_genlist_item_prepend()
18817 * @see elm_genlist_item_insert_before()
18818 * @see elm_genlist_item_del()
18822 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);
18824 * Insert a new item into the sorted genlist object
18826 * @param obj The genlist object
18827 * @param itc The item class for the item
18828 * @param data The item data
18829 * @param parent The parent item, or NULL if none
18830 * @param flags Item flags
18831 * @param comp The function called for the sort
18832 * @param func Convenience function called when item selected
18833 * @param func_data Data passed to @p func above.
18834 * @return A handle to the item added or NULL if not possible
18838 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);
18839 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);
18840 /* operations to retrieve existing items */
18842 * Get the selectd item in the genlist.
18844 * @param obj The genlist object
18845 * @return The selected item, or NULL if none is selected.
18847 * This gets the selected item in the list (if multi-selection is enabled, only
18848 * the item that was first selected in the list is returned - which is not very
18849 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18852 * If no item is selected, NULL is returned.
18854 * @see elm_genlist_selected_items_get()
18858 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18860 * Get a list of selected items in the genlist.
18862 * @param obj The genlist object
18863 * @return The list of selected items, or NULL if none are selected.
18865 * It returns a list of the selected items. This list pointer is only valid so
18866 * long as the selection doesn't change (no items are selected or unselected, or
18867 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18868 * pointers. The order of the items in this list is the order which they were
18869 * selected, i.e. the first item in this list is the first item that was
18870 * selected, and so on.
18872 * @note If not in multi-select mode, consider using function
18873 * elm_genlist_selected_item_get() instead.
18875 * @see elm_genlist_multi_select_set()
18876 * @see elm_genlist_selected_item_get()
18880 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18882 * Get the mode item style of items in the genlist
18883 * @param obj The genlist object
18884 * @return The mode item style string, or NULL if none is specified
18886 * This is a constant string and simply defines the name of the
18887 * style that will be used for mode animations. It can be
18888 * @c NULL if you don't plan to use Genlist mode. See
18889 * elm_genlist_item_mode_set() for more info.
18893 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18895 * Set the mode item style of items in the genlist
18896 * @param obj The genlist object
18897 * @param style The mode item style string, or NULL if none is desired
18899 * This is a constant string and simply defines the name of the
18900 * style that will be used for mode animations. It can be
18901 * @c NULL if you don't plan to use Genlist mode. See
18902 * elm_genlist_item_mode_set() for more info.
18906 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
18908 * Get a list of realized items in genlist
18910 * @param obj The genlist object
18911 * @return The list of realized items, nor NULL if none are realized.
18913 * This returns a list of the realized items in the genlist. The list
18914 * contains Elm_Genlist_Item pointers. The list must be freed by the
18915 * caller when done with eina_list_free(). The item pointers in the
18916 * list are only valid so long as those items are not deleted or the
18917 * genlist is not deleted.
18919 * @see elm_genlist_realized_items_update()
18923 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18925 * Get the item that is at the x, y canvas coords.
18927 * @param obj The gelinst object.
18928 * @param x The input x coordinate
18929 * @param y The input y coordinate
18930 * @param posret The position relative to the item returned here
18931 * @return The item at the coordinates or NULL if none
18933 * This returns the item at the given coordinates (which are canvas
18934 * relative, not object-relative). If an item is at that coordinate,
18935 * that item handle is returned, and if @p posret is not NULL, the
18936 * integer pointed to is set to a value of -1, 0 or 1, depending if
18937 * the coordinate is on the upper portion of that item (-1), on the
18938 * middle section (0) or on the lower part (1). If NULL is returned as
18939 * an item (no item found there), then posret may indicate -1 or 1
18940 * based if the coordinate is above or below all items respectively in
18945 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);
18947 * Get the first item in the genlist
18949 * This returns the first item in the list.
18951 * @param obj The genlist object
18952 * @return The first item, or NULL if none
18956 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18958 * Get the last item in the genlist
18960 * This returns the last item in the list.
18962 * @return The last item, or NULL if none
18966 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18968 * Set the scrollbar policy
18970 * @param obj The genlist object
18971 * @param policy_h Horizontal scrollbar policy.
18972 * @param policy_v Vertical scrollbar policy.
18974 * This sets the scrollbar visibility policy for the given genlist
18975 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
18976 * made visible if it is needed, and otherwise kept hidden.
18977 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
18978 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
18979 * respectively for the horizontal and vertical scrollbars. Default is
18980 * #ELM_SMART_SCROLLER_POLICY_AUTO
18982 * @see elm_genlist_scroller_policy_get()
18986 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
18988 * Get the scrollbar policy
18990 * @param obj The genlist object
18991 * @param policy_h Pointer to store the horizontal scrollbar policy.
18992 * @param policy_v Pointer to store the vertical scrollbar policy.
18994 * @see elm_genlist_scroller_policy_set()
18998 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);
19000 * Get the @b next item in a genlist widget's internal list of items,
19001 * given a handle to one of those items.
19003 * @param item The genlist item to fetch next from
19004 * @return The item after @p item, or @c NULL if there's none (and
19007 * This returns the item placed after the @p item, on the container
19010 * @see elm_genlist_item_prev_get()
19014 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19016 * Get the @b previous item in a genlist widget's internal list of items,
19017 * given a handle to one of those items.
19019 * @param item The genlist item to fetch previous from
19020 * @return The item before @p item, or @c NULL if there's none (and
19023 * This returns the item placed before the @p item, on the container
19026 * @see elm_genlist_item_next_get()
19030 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19032 * Get the genlist object's handle which contains a given genlist
19035 * @param item The item to fetch the container from
19036 * @return The genlist (parent) object
19038 * This returns the genlist object itself that an item belongs to.
19042 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19044 * Get the parent item of the given item
19046 * @param it The item
19047 * @return The parent of the item or @c NULL if it has no parent.
19049 * This returns the item that was specified as parent of the item @p it on
19050 * elm_genlist_item_append() and insertion related functions.
19054 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19056 * Remove all sub-items (children) of the given item
19058 * @param it The item
19060 * This removes all items that are children (and their descendants) of the
19061 * given item @p it.
19063 * @see elm_genlist_clear()
19064 * @see elm_genlist_item_del()
19068 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19070 * Set whether a given genlist item is selected or not
19072 * @param it The item
19073 * @param selected Use @c EINA_TRUE, to make it selected, @c
19074 * EINA_FALSE to make it unselected
19076 * This sets the selected state of an item. If multi selection is
19077 * not enabled on the containing genlist and @p selected is @c
19078 * EINA_TRUE, any other previously selected items will get
19079 * unselected in favor of this new one.
19081 * @see elm_genlist_item_selected_get()
19085 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
19087 * Get whether a given genlist item is selected or not
19089 * @param it The item
19090 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
19092 * @see elm_genlist_item_selected_set() for more details
19096 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19098 * Sets the expanded state of an item.
19100 * @param it The item
19101 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
19103 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19106 * The theme will respond to this change visually, and a signal "expanded" or
19107 * "contracted" will be sent from the genlist with a pointer to the item that
19108 * has been expanded/contracted.
19110 * Calling this function won't show or hide any child of this item (if it is
19111 * a parent). You must manually delete and create them on the callbacks fo
19112 * the "expanded" or "contracted" signals.
19114 * @see elm_genlist_item_expanded_get()
19118 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19120 * Get the expanded state of an item
19122 * @param it The item
19123 * @return The expanded state
19125 * This gets the expanded state of an item.
19127 * @see elm_genlist_item_expanded_set()
19131 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19133 * Get the depth of expanded item
19135 * @param it The genlist item object
19136 * @return The depth of expanded item
19140 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19142 * Set whether a given genlist item is disabled or not.
19144 * @param it The item
19145 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19146 * to enable it back.
19148 * A disabled item cannot be selected or unselected. It will also
19149 * change its appearance, to signal the user it's disabled.
19151 * @see elm_genlist_item_disabled_get()
19155 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19157 * Get whether a given genlist item is disabled or not.
19159 * @param it The item
19160 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19163 * @see elm_genlist_item_disabled_set() for more details
19167 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19169 * Sets the display only state of an item.
19171 * @param it The item
19172 * @param display_only @c EINA_TRUE if the item is display only, @c
19173 * EINA_FALSE otherwise.
19175 * A display only item cannot be selected or unselected. It is for
19176 * display only and not selecting or otherwise clicking, dragging
19177 * etc. by the user, thus finger size rules will not be applied to
19180 * It's good to set group index items to display only state.
19182 * @see elm_genlist_item_display_only_get()
19186 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19188 * Get the display only state of an item
19190 * @param it The item
19191 * @return @c EINA_TRUE if the item is display only, @c
19192 * EINA_FALSE otherwise.
19194 * @see elm_genlist_item_display_only_set()
19198 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19200 * Show the portion of a genlist's internal list containing a given
19201 * item, immediately.
19203 * @param it The item to display
19205 * This causes genlist to jump to the given item @p it and show it (by
19206 * immediately scrolling to that position), if it is not fully visible.
19208 * @see elm_genlist_item_bring_in()
19209 * @see elm_genlist_item_top_show()
19210 * @see elm_genlist_item_middle_show()
19214 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19216 * Animatedly bring in, to the visible are of a genlist, a given
19219 * @param it The item to display
19221 * This causes genlist to jump to the given item @p it and show it (by
19222 * animatedly scrolling), if it is not fully visible. This may use animation
19223 * to do so and take a period of time
19225 * @see elm_genlist_item_show()
19226 * @see elm_genlist_item_top_bring_in()
19227 * @see elm_genlist_item_middle_bring_in()
19231 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19233 * Show the portion of a genlist's internal list containing a given
19234 * item, immediately.
19236 * @param it The item to display
19238 * This causes genlist to jump to the given item @p it and show it (by
19239 * immediately scrolling to that position), if it is not fully visible.
19241 * The item will be positioned at the top of the genlist viewport.
19243 * @see elm_genlist_item_show()
19244 * @see elm_genlist_item_top_bring_in()
19248 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19250 * Animatedly bring in, to the visible are of a genlist, a given
19253 * @param it The item
19255 * This causes genlist to jump to the given item @p it and show it (by
19256 * animatedly scrolling), if it is not fully visible. This may use animation
19257 * to do so and take a period of time
19259 * The item will be positioned at the top of the genlist viewport.
19261 * @see elm_genlist_item_bring_in()
19262 * @see elm_genlist_item_top_show()
19266 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19268 * Show the portion of a genlist's internal list containing a given
19269 * item, immediately.
19271 * @param it The item to display
19273 * This causes genlist to jump to the given item @p it and show it (by
19274 * immediately scrolling to that position), if it is not fully visible.
19276 * The item will be positioned at the middle of the genlist viewport.
19278 * @see elm_genlist_item_show()
19279 * @see elm_genlist_item_middle_bring_in()
19283 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19285 * Animatedly bring in, to the visible are of a genlist, a given
19288 * @param it The item
19290 * This causes genlist to jump to the given item @p it and show it (by
19291 * animatedly scrolling), if it is not fully visible. This may use animation
19292 * to do so and take a period of time
19294 * The item will be positioned at the middle of the genlist viewport.
19296 * @see elm_genlist_item_bring_in()
19297 * @see elm_genlist_item_middle_show()
19301 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19303 * Remove a genlist item from the its parent, deleting it.
19305 * @param item The item to be removed.
19306 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19308 * @see elm_genlist_clear(), to remove all items in a genlist at
19313 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19315 * Return the data associated to a given genlist item
19317 * @param item The genlist item.
19318 * @return the data associated to this item.
19320 * This returns the @c data value passed on the
19321 * elm_genlist_item_append() and related item addition calls.
19323 * @see elm_genlist_item_append()
19324 * @see elm_genlist_item_data_set()
19328 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19330 * Set the data associated to a given genlist item
19332 * @param item The genlist item
19333 * @param data The new data pointer to set on it
19335 * This @b overrides the @c data value passed on the
19336 * elm_genlist_item_append() and related item addition calls. This
19337 * function @b won't call elm_genlist_item_update() automatically,
19338 * so you'd issue it afterwards if you want to hove the item
19339 * updated to reflect the that new data.
19341 * @see elm_genlist_item_data_get()
19345 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19347 * Tells genlist to "orphan" icons fetchs by the item class
19349 * @param it The item
19351 * This instructs genlist to release references to icons in the item,
19352 * meaning that they will no longer be managed by genlist and are
19353 * floating "orphans" that can be re-used elsewhere if the user wants
19358 EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19359 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19361 * Get the real Evas object created to implement the view of a
19362 * given genlist item
19364 * @param item The genlist item.
19365 * @return the Evas object implementing this item's view.
19367 * This returns the actual Evas object used to implement the
19368 * specified genlist item's view. This may be @c NULL, as it may
19369 * not have been created or may have been deleted, at any time, by
19370 * the genlist. <b>Do not modify this object</b> (move, resize,
19371 * show, hide, etc.), as the genlist is controlling it. This
19372 * function is for querying, emitting custom signals or hooking
19373 * lower level callbacks for events on that object. Do not delete
19374 * this object under any circumstances.
19376 * @see elm_genlist_item_data_get()
19380 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19382 * Update the contents of an item
19384 * @param it The item
19386 * This updates an item by calling all the item class functions again
19387 * to get the icons, labels and states. Use this when the original
19388 * item data has changed and the changes are desired to be reflected.
19390 * Use elm_genlist_realized_items_update() to update all already realized
19393 * @see elm_genlist_realized_items_update()
19397 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19398 EAPI void elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
19400 * Update the item class of an item
19402 * @param it The item
19403 * @param itc The item class for the item
19405 * This sets another class fo the item, changing the way that it is
19406 * displayed. After changing the item class, elm_genlist_item_update() is
19407 * called on the item @p it.
19411 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19412 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19414 * Set the text to be shown in a given genlist item's tooltips.
19416 * @param item The genlist item
19417 * @param text The text to set in the content
19419 * This call will setup the text to be used as tooltip to that item
19420 * (analogous to elm_object_tooltip_text_set(), but being item
19421 * tooltips with higher precedence than object tooltips). It can
19422 * have only one tooltip at a time, so any previous tooltip data
19423 * will get removed.
19425 * In order to set an icon or something else as a tooltip, look at
19426 * elm_genlist_item_tooltip_content_cb_set().
19430 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19432 * Set the content to be shown in a given genlist item's tooltips
19434 * @param item The genlist item.
19435 * @param func The function returning the tooltip contents.
19436 * @param data What to provide to @a func as callback data/context.
19437 * @param del_cb Called when data is not needed anymore, either when
19438 * another callback replaces @p func, the tooltip is unset with
19439 * elm_genlist_item_tooltip_unset() or the owner @p item
19440 * dies. This callback receives as its first parameter the
19441 * given @p data, being @c event_info the item handle.
19443 * This call will setup the tooltip's contents to @p item
19444 * (analogous to elm_object_tooltip_content_cb_set(), but being
19445 * item tooltips with higher precedence than object tooltips). It
19446 * can have only one tooltip at a time, so any previous tooltip
19447 * content will get removed. @p func (with @p data) will be called
19448 * every time Elementary needs to show the tooltip and it should
19449 * return a valid Evas object, which will be fully managed by the
19450 * tooltip system, getting deleted when the tooltip is gone.
19452 * In order to set just a text as a tooltip, look at
19453 * elm_genlist_item_tooltip_text_set().
19457 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);
19459 * Unset a tooltip from a given genlist item
19461 * @param item genlist item to remove a previously set tooltip from.
19463 * This call removes any tooltip set on @p item. The callback
19464 * provided as @c del_cb to
19465 * elm_genlist_item_tooltip_content_cb_set() will be called to
19466 * notify it is not used anymore (and have resources cleaned, if
19469 * @see elm_genlist_item_tooltip_content_cb_set()
19473 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19475 * Set a different @b style for a given genlist item's tooltip.
19477 * @param item genlist item with tooltip set
19478 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19479 * "default", @c "transparent", etc)
19481 * Tooltips can have <b>alternate styles</b> to be displayed on,
19482 * which are defined by the theme set on Elementary. This function
19483 * works analogously as elm_object_tooltip_style_set(), but here
19484 * applied only to genlist item objects. The default style for
19485 * tooltips is @c "default".
19487 * @note before you set a style you should define a tooltip with
19488 * elm_genlist_item_tooltip_content_cb_set() or
19489 * elm_genlist_item_tooltip_text_set()
19491 * @see elm_genlist_item_tooltip_style_get()
19495 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19497 * Get the style set a given genlist item's tooltip.
19499 * @param item genlist item with tooltip already set on.
19500 * @return style the theme style in use, which defaults to
19501 * "default". If the object does not have a tooltip set,
19502 * then @c NULL is returned.
19504 * @see elm_genlist_item_tooltip_style_set() for more details
19508 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19510 * Set the type of mouse pointer/cursor decoration to be shown,
19511 * when the mouse pointer is over the given genlist widget item
19513 * @param item genlist item to customize cursor on
19514 * @param cursor the cursor type's name
19516 * This function works analogously as elm_object_cursor_set(), but
19517 * here the cursor's changing area is restricted to the item's
19518 * area, and not the whole widget's. Note that that item cursors
19519 * have precedence over widget cursors, so that a mouse over @p
19520 * item will always show cursor @p type.
19522 * If this function is called twice for an object, a previously set
19523 * cursor will be unset on the second call.
19525 * @see elm_object_cursor_set()
19526 * @see elm_genlist_item_cursor_get()
19527 * @see elm_genlist_item_cursor_unset()
19531 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19533 * Get the type of mouse pointer/cursor decoration set to be shown,
19534 * when the mouse pointer is over the given genlist widget item
19536 * @param item genlist item with custom cursor set
19537 * @return the cursor type's name or @c NULL, if no custom cursors
19538 * were set to @p item (and on errors)
19540 * @see elm_object_cursor_get()
19541 * @see elm_genlist_item_cursor_set() for more details
19542 * @see elm_genlist_item_cursor_unset()
19546 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19548 * Unset any custom mouse pointer/cursor decoration set to be
19549 * shown, when the mouse pointer is over the given genlist widget
19550 * item, thus making it show the @b default cursor again.
19552 * @param item a genlist item
19554 * Use this call to undo any custom settings on this item's cursor
19555 * decoration, bringing it back to defaults (no custom style set).
19557 * @see elm_object_cursor_unset()
19558 * @see elm_genlist_item_cursor_set() for more details
19562 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19564 * Set a different @b style for a given custom cursor set for a
19567 * @param item genlist item with custom cursor set
19568 * @param style the <b>theme style</b> to use (e.g. @c "default",
19569 * @c "transparent", etc)
19571 * This function only makes sense when one is using custom mouse
19572 * cursor decorations <b>defined in a theme file</b> , which can
19573 * have, given a cursor name/type, <b>alternate styles</b> on
19574 * it. It works analogously as elm_object_cursor_style_set(), but
19575 * here applied only to genlist item objects.
19577 * @warning Before you set a cursor style you should have defined a
19578 * custom cursor previously on the item, with
19579 * elm_genlist_item_cursor_set()
19581 * @see elm_genlist_item_cursor_engine_only_set()
19582 * @see elm_genlist_item_cursor_style_get()
19586 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19588 * Get the current @b style set for a given genlist item's custom
19591 * @param item genlist item with custom cursor set.
19592 * @return style the cursor style in use. If the object does not
19593 * have a cursor set, then @c NULL is returned.
19595 * @see elm_genlist_item_cursor_style_set() for more details
19599 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19601 * Set if the (custom) cursor for a given genlist item should be
19602 * searched in its theme, also, or should only rely on the
19603 * rendering engine.
19605 * @param item item with custom (custom) cursor already set on
19606 * @param engine_only Use @c EINA_TRUE to have cursors looked for
19607 * only on those provided by the rendering engine, @c EINA_FALSE to
19608 * have them searched on the widget's theme, as well.
19610 * @note This call is of use only if you've set a custom cursor
19611 * for genlist items, with elm_genlist_item_cursor_set().
19613 * @note By default, cursors will only be looked for between those
19614 * provided by the rendering engine.
19618 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19620 * Get if the (custom) cursor for a given genlist item is being
19621 * searched in its theme, also, or is only relying on the rendering
19624 * @param item a genlist item
19625 * @return @c EINA_TRUE, if cursors are being looked for only on
19626 * those provided by the rendering engine, @c EINA_FALSE if they
19627 * are being searched on the widget's theme, as well.
19629 * @see elm_genlist_item_cursor_engine_only_set(), for more details
19633 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19635 * Update the contents of all realized items.
19637 * @param obj The genlist object.
19639 * This updates all realized items by calling all the item class functions again
19640 * to get the icons, labels and states. Use this when the original
19641 * item data has changed and the changes are desired to be reflected.
19643 * To update just one item, use elm_genlist_item_update().
19645 * @see elm_genlist_realized_items_get()
19646 * @see elm_genlist_item_update()
19650 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19652 * Activate a genlist mode on an item
19654 * @param item The genlist item
19655 * @param mode Mode name
19656 * @param mode_set Boolean to define set or unset mode.
19658 * A genlist mode is a different way of selecting an item. Once a mode is
19659 * activated on an item, any other selected item is immediately unselected.
19660 * This feature provides an easy way of implementing a new kind of animation
19661 * for selecting an item, without having to entirely rewrite the item style
19662 * theme. However, the elm_genlist_selected_* API can't be used to get what
19663 * item is activate for a mode.
19665 * The current item style will still be used, but applying a genlist mode to
19666 * an item will select it using a different kind of animation.
19668 * The current active item for a mode can be found by
19669 * elm_genlist_mode_item_get().
19671 * The characteristics of genlist mode are:
19672 * - Only one mode can be active at any time, and for only one item.
19673 * - Genlist handles deactivating other items when one item is activated.
19674 * - A mode is defined in the genlist theme (edc), and more modes can easily
19676 * - A mode style and the genlist item style are different things. They
19677 * can be combined to provide a default style to the item, with some kind
19678 * of animation for that item when the mode is activated.
19680 * When a mode is activated on an item, a new view for that item is created.
19681 * The theme of this mode defines the animation that will be used to transit
19682 * the item from the old view to the new view. This second (new) view will be
19683 * active for that item while the mode is active on the item, and will be
19684 * destroyed after the mode is totally deactivated from that item.
19686 * @see elm_genlist_mode_get()
19687 * @see elm_genlist_mode_item_get()
19691 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19693 * Get the last (or current) genlist mode used.
19695 * @param obj The genlist object
19697 * This function just returns the name of the last used genlist mode. It will
19698 * be the current mode if it's still active.
19700 * @see elm_genlist_item_mode_set()
19701 * @see elm_genlist_mode_item_get()
19705 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19707 * Get active genlist mode item
19709 * @param obj The genlist object
19710 * @return The active item for that current mode. Or @c NULL if no item is
19711 * activated with any mode.
19713 * This function returns the item that was activated with a mode, by the
19714 * function elm_genlist_item_mode_set().
19716 * @see elm_genlist_item_mode_set()
19717 * @see elm_genlist_mode_get()
19721 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19726 * @param obj The genlist object
19727 * @param reorder_mode The reorder mode
19728 * (EINA_TRUE = on, EINA_FALSE = off)
19732 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19735 * Get the reorder mode
19737 * @param obj The genlist object
19738 * @return The reorder mode
19739 * (EINA_TRUE = on, EINA_FALSE = off)
19743 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19745 EAPI void elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
19746 EAPI Eina_Bool elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19747 EAPI void elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
19748 EAPI Eina_Bool elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19749 EAPI void elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
19750 EAPI void elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
19751 EAPI void elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19752 EAPI void elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19753 EAPI void elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19754 EAPI Eina_Bool elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19761 * @defgroup Check Check
19763 * @image html img/widget/check/preview-00.png
19764 * @image latex img/widget/check/preview-00.eps
19765 * @image html img/widget/check/preview-01.png
19766 * @image latex img/widget/check/preview-01.eps
19767 * @image html img/widget/check/preview-02.png
19768 * @image latex img/widget/check/preview-02.eps
19770 * @brief The check widget allows for toggling a value between true and
19773 * Check objects are a lot like radio objects in layout and functionality
19774 * except they do not work as a group, but independently and only toggle the
19775 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19776 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19777 * returns the current state. For convenience, like the radio objects, you
19778 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19779 * for it to modify.
19781 * Signals that you can add callbacks for are:
19782 * "changed" - This is called whenever the user changes the state of one of
19783 * the check object(event_info is NULL).
19785 * Default contents parts of the check widget that you can use for are:
19786 * @li "elm.swallow.content" - A icon of the check
19788 * Default text parts of the check widget that you can use for are:
19789 * @li "elm.text" - Label of the check
19791 * @ref tutorial_check should give you a firm grasp of how to use this widget
19796 * @brief Add a new Check object
19798 * @param parent The parent object
19799 * @return The new object or NULL if it cannot be created
19801 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19803 * @brief Set the text label of the check object
19805 * @param obj The check object
19806 * @param label The text label string in UTF-8
19808 * @deprecated use elm_object_text_set() instead.
19810 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19812 * @brief Get the text label of the check object
19814 * @param obj The check object
19815 * @return The text label string in UTF-8
19817 * @deprecated use elm_object_text_get() instead.
19819 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19821 * @brief Set the icon object of the check object
19823 * @param obj The check object
19824 * @param icon The icon object
19826 * Once the icon object is set, a previously set one will be deleted.
19827 * If you want to keep that old content object, use the
19828 * elm_object_content_unset() function.
19830 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19832 * @brief Get the icon object of the check object
19834 * @param obj The check object
19835 * @return The icon object
19837 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19839 * @brief Unset the icon used for the check object
19841 * @param obj The check object
19842 * @return The icon object that was being used
19844 * Unparent and return the icon object which was set for this widget.
19846 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19848 * @brief Set the on/off state of the check object
19850 * @param obj The check object
19851 * @param state The state to use (1 == on, 0 == off)
19853 * This sets the state of the check. If set
19854 * with elm_check_state_pointer_set() the state of that variable is also
19855 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19857 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19859 * @brief Get the state of the check object
19861 * @param obj The check object
19862 * @return The boolean state
19864 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19866 * @brief Set a convenience pointer to a boolean to change
19868 * @param obj The check object
19869 * @param statep Pointer to the boolean to modify
19871 * This sets a pointer to a boolean, that, in addition to the check objects
19872 * state will also be modified directly. To stop setting the object pointed
19873 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19874 * then when this is called, the check objects state will also be modified to
19875 * reflect the value of the boolean @p statep points to, just like calling
19876 * elm_check_state_set().
19878 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19884 * @defgroup Radio Radio
19886 * @image html img/widget/radio/preview-00.png
19887 * @image latex img/widget/radio/preview-00.eps
19889 * @brief Radio is a widget that allows for 1 or more options to be displayed
19890 * and have the user choose only 1 of them.
19892 * A radio object contains an indicator, an optional Label and an optional
19893 * icon object. While it's possible to have a group of only one radio they,
19894 * are normally used in groups of 2 or more. To add a radio to a group use
19895 * elm_radio_group_add(). The radio object(s) will select from one of a set
19896 * of integer values, so any value they are configuring needs to be mapped to
19897 * a set of integers. To configure what value that radio object represents,
19898 * use elm_radio_state_value_set() to set the integer it represents. To set
19899 * the value the whole group(which one is currently selected) is to indicate
19900 * use elm_radio_value_set() on any group member, and to get the groups value
19901 * use elm_radio_value_get(). For convenience the radio objects are also able
19902 * to directly set an integer(int) to the value that is selected. To specify
19903 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
19904 * The radio objects will modify this directly. That implies the pointer must
19905 * point to valid memory for as long as the radio objects exist.
19907 * Signals that you can add callbacks for are:
19908 * @li changed - This is called whenever the user changes the state of one of
19909 * the radio objects within the group of radio objects that work together.
19911 * Default contents parts of the radio widget that you can use for are:
19912 * @li "elm.swallow.content" - A icon of the radio
19914 * @ref tutorial_radio show most of this API in action.
19918 * @brief Add a new radio to the parent
19920 * @param parent The parent object
19921 * @return The new object or NULL if it cannot be created
19923 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19925 * @brief Set the text label of the radio object
19927 * @param obj The radio object
19928 * @param label The text label string in UTF-8
19930 * @deprecated use elm_object_text_set() instead.
19932 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19934 * @brief Get the text label of the radio object
19936 * @param obj The radio object
19937 * @return The text label string in UTF-8
19939 * @deprecated use elm_object_text_set() instead.
19941 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19943 * @brief Set the icon object of the radio object
19945 * @param obj The radio object
19946 * @param icon The icon object
19948 * Once the icon object is set, a previously set one will be deleted. If you
19949 * want to keep that old content object, use the elm_radio_icon_unset()
19952 * @deprecated use elm_object_content_set() instead.
19954 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19956 * @brief Get the icon object of the radio object
19958 * @param obj The radio object
19959 * @return The icon object
19961 * @see elm_radio_icon_set()
19963 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19965 * @brief Unset the icon used for the radio object
19967 * @param obj The radio object
19968 * @return The icon object that was being used
19970 * Unparent and return the icon object which was set for this widget.
19972 * @see elm_radio_icon_set()
19973 * @deprecated use elm_object_content_unset() instead.
19975 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19977 * @brief Add this radio to a group of other radio objects
19979 * @param obj The radio object
19980 * @param group Any object whose group the @p obj is to join.
19982 * Radio objects work in groups. Each member should have a different integer
19983 * value assigned. In order to have them work as a group, they need to know
19984 * about each other. This adds the given radio object to the group of which
19985 * the group object indicated is a member.
19987 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
19989 * @brief Set the integer value that this radio object represents
19991 * @param obj The radio object
19992 * @param value The value to use if this radio object is selected
19994 * This sets the value of the radio.
19996 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19998 * @brief Get the integer value that this radio object represents
20000 * @param obj The radio object
20001 * @return The value used if this radio object is selected
20003 * This gets the value of the radio.
20005 * @see elm_radio_value_set()
20007 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20009 * @brief Set the value of the radio.
20011 * @param obj The radio object
20012 * @param value The value to use for the group
20014 * This sets the value of the radio group and will also set the value if
20015 * pointed to, to the value supplied, but will not call any callbacks.
20017 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20019 * @brief Get the state of the radio object
20021 * @param obj The radio object
20022 * @return The integer state
20024 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20026 * @brief Set a convenience pointer to a integer to change
20028 * @param obj The radio object
20029 * @param valuep Pointer to the integer to modify
20031 * This sets a pointer to a integer, that, in addition to the radio objects
20032 * state will also be modified directly. To stop setting the object pointed
20033 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
20034 * when this is called, the radio objects state will also be modified to
20035 * reflect the value of the integer valuep points to, just like calling
20036 * elm_radio_value_set().
20038 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
20044 * @defgroup Pager Pager
20046 * @image html img/widget/pager/preview-00.png
20047 * @image latex img/widget/pager/preview-00.eps
20049 * @brief Widget that allows flipping between 1 or more āpagesā of objects.
20051 * The flipping between āpagesā of objects is animated. All content in pager
20052 * is kept in a stack, the last content to be added will be on the top of the
20053 * stack(be visible).
20055 * Objects can be pushed or popped from the stack or deleted as normal.
20056 * Pushes and pops will animate (and a pop will delete the object once the
20057 * animation is finished). Any object already in the pager can be promoted to
20058 * the top(from its current stacking position) through the use of
20059 * elm_pager_content_promote(). Objects are pushed to the top with
20060 * elm_pager_content_push() and when the top item is no longer wanted, simply
20061 * pop it with elm_pager_content_pop() and it will also be deleted. If an
20062 * object is no longer needed and is not the top item, just delete it as
20063 * normal. You can query which objects are the top and bottom with
20064 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20066 * Signals that you can add callbacks for are:
20067 * "hide,finished" - when the previous page is hided
20069 * This widget has the following styles available:
20072 * @li fade_translucide
20073 * @li fade_invisible
20074 * @note This styles affect only the flipping animations, the appearance when
20075 * not animating is unaffected by styles.
20077 * @ref tutorial_pager gives a good overview of the usage of the API.
20081 * Add a new pager to the parent
20083 * @param parent The parent object
20084 * @return The new object or NULL if it cannot be created
20088 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20090 * @brief Push an object to the top of the pager stack (and show it).
20092 * @param obj The pager object
20093 * @param content The object to push
20095 * The object pushed becomes a child of the pager, it will be controlled and
20096 * deleted when the pager is deleted.
20098 * @note If the content is already in the stack use
20099 * elm_pager_content_promote().
20100 * @warning Using this function on @p content already in the stack results in
20101 * undefined behavior.
20103 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20105 * @brief Pop the object that is on top of the stack
20107 * @param obj The pager object
20109 * This pops the object that is on the top(visible) of the pager, makes it
20110 * disappear, then deletes the object. The object that was underneath it on
20111 * the stack will become visible.
20113 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20115 * @brief Moves an object already in the pager stack to the top of the stack.
20117 * @param obj The pager object
20118 * @param content The object to promote
20120 * This will take the @p content and move it to the top of the stack as
20121 * if it had been pushed there.
20123 * @note If the content isn't already in the stack use
20124 * elm_pager_content_push().
20125 * @warning Using this function on @p content not already in the stack
20126 * results in undefined behavior.
20128 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20130 * @brief Return the object at the bottom of the pager stack
20132 * @param obj The pager object
20133 * @return The bottom object or NULL if none
20135 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20137 * @brief Return the object at the top of the pager stack
20139 * @param obj The pager object
20140 * @return The top object or NULL if none
20142 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20144 EAPI void elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
20145 EINA_DEPRECATED EAPI void elm_pager_animation_disabled_set(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
20152 * @defgroup Slideshow Slideshow
20154 * @image html img/widget/slideshow/preview-00.png
20155 * @image latex img/widget/slideshow/preview-00.eps
20157 * This widget, as the name indicates, is a pre-made image
20158 * slideshow panel, with API functions acting on (child) image
20159 * items presentation. Between those actions, are:
20160 * - advance to next/previous image
20161 * - select the style of image transition animation
20162 * - set the exhibition time for each image
20163 * - start/stop the slideshow
20165 * The transition animations are defined in the widget's theme,
20166 * consequently new animations can be added without having to
20167 * update the widget's code.
20169 * @section Slideshow_Items Slideshow items
20171 * For slideshow items, just like for @ref Genlist "genlist" ones,
20172 * the user defines a @b classes, specifying functions that will be
20173 * called on the item's creation and deletion times.
20175 * The #Elm_Slideshow_Item_Class structure contains the following
20178 * - @c func.get - When an item is displayed, this function is
20179 * called, and it's where one should create the item object, de
20180 * facto. For example, the object can be a pure Evas image object
20181 * or an Elementary @ref Photocam "photocam" widget. See
20182 * #SlideshowItemGetFunc.
20183 * - @c func.del - When an item is no more displayed, this function
20184 * is called, where the user must delete any data associated to
20185 * the item. See #SlideshowItemDelFunc.
20187 * @section Slideshow_Caching Slideshow caching
20189 * The slideshow provides facilities to have items adjacent to the
20190 * one being displayed <b>already "realized"</b> (i.e. loaded) for
20191 * you, so that the system does not have to decode image data
20192 * anymore at the time it has to actually switch images on its
20193 * viewport. The user is able to set the numbers of items to be
20194 * cached @b before and @b after the current item, in the widget's
20197 * Smart events one can add callbacks for are:
20199 * - @c "changed" - when the slideshow switches its view to a new
20202 * List of examples for the slideshow widget:
20203 * @li @ref slideshow_example
20207 * @addtogroup Slideshow
20211 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20212 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20213 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
20214 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20215 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20218 * @struct _Elm_Slideshow_Item_Class
20220 * Slideshow item class definition. See @ref Slideshow_Items for
20223 struct _Elm_Slideshow_Item_Class
20225 struct _Elm_Slideshow_Item_Class_Func
20227 SlideshowItemGetFunc get;
20228 SlideshowItemDelFunc del;
20230 }; /**< #Elm_Slideshow_Item_Class member definitions */
20233 * Add a new slideshow widget to the given parent Elementary
20234 * (container) object
20236 * @param parent The parent object
20237 * @return A new slideshow widget handle or @c NULL, on errors
20239 * This function inserts a new slideshow widget on the canvas.
20241 * @ingroup Slideshow
20243 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20246 * Add (append) a new item in a given slideshow widget.
20248 * @param obj The slideshow object
20249 * @param itc The item class for the item
20250 * @param data The item's data
20251 * @return A handle to the item added or @c NULL, on errors
20253 * Add a new item to @p obj's internal list of items, appending it.
20254 * The item's class must contain the function really fetching the
20255 * image object to show for this item, which could be an Evas image
20256 * object or an Elementary photo, for example. The @p data
20257 * parameter is going to be passed to both class functions of the
20260 * @see #Elm_Slideshow_Item_Class
20261 * @see elm_slideshow_item_sorted_insert()
20263 * @ingroup Slideshow
20265 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20268 * Insert a new item into the given slideshow widget, using the @p func
20269 * function to sort items (by item handles).
20271 * @param obj The slideshow object
20272 * @param itc The item class for the item
20273 * @param data The item's data
20274 * @param func The comparing function to be used to sort slideshow
20275 * items <b>by #Elm_Slideshow_Item item handles</b>
20276 * @return Returns The slideshow item handle, on success, or
20277 * @c NULL, on errors
20279 * Add a new item to @p obj's internal list of items, in a position
20280 * determined by the @p func comparing function. The item's class
20281 * must contain the function really fetching the image object to
20282 * show for this item, which could be an Evas image object or an
20283 * Elementary photo, for example. The @p data parameter is going to
20284 * be passed to both class functions of the item.
20286 * @see #Elm_Slideshow_Item_Class
20287 * @see elm_slideshow_item_add()
20289 * @ingroup Slideshow
20291 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);
20294 * Display a given slideshow widget's item, programmatically.
20296 * @param obj The slideshow object
20297 * @param item The item to display on @p obj's viewport
20299 * The change between the current item and @p item will use the
20300 * transition @p obj is set to use (@see
20301 * elm_slideshow_transition_set()).
20303 * @ingroup Slideshow
20305 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20308 * Slide to the @b next item, in a given slideshow widget
20310 * @param obj The slideshow object
20312 * The sliding animation @p obj is set to use will be the
20313 * transition effect used, after this call is issued.
20315 * @note If the end of the slideshow's internal list of items is
20316 * reached, it'll wrap around to the list's beginning, again.
20318 * @ingroup Slideshow
20320 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20323 * Slide to the @b previous item, in a given slideshow widget
20325 * @param obj The slideshow object
20327 * The sliding animation @p obj is set to use will be the
20328 * transition effect used, after this call is issued.
20330 * @note If the beginning of the slideshow's internal list of items
20331 * is reached, it'll wrap around to the list's end, again.
20333 * @ingroup Slideshow
20335 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20338 * Returns the list of sliding transition/effect names available, for a
20339 * given slideshow widget.
20341 * @param obj The slideshow object
20342 * @return The list of transitions (list of @b stringshared strings
20345 * The transitions, which come from @p obj's theme, must be an EDC
20346 * data item named @c "transitions" on the theme file, with (prefix)
20347 * names of EDC programs actually implementing them.
20349 * The available transitions for slideshows on the default theme are:
20350 * - @c "fade" - the current item fades out, while the new one
20351 * fades in to the slideshow's viewport.
20352 * - @c "black_fade" - the current item fades to black, and just
20353 * then, the new item will fade in.
20354 * - @c "horizontal" - the current item slides horizontally, until
20355 * it gets out of the slideshow's viewport, while the new item
20356 * comes from the left to take its place.
20357 * - @c "vertical" - the current item slides vertically, until it
20358 * gets out of the slideshow's viewport, while the new item comes
20359 * from the bottom to take its place.
20360 * - @c "square" - the new item starts to appear from the middle of
20361 * the current one, but with a tiny size, growing until its
20362 * target (full) size and covering the old one.
20364 * @warning The stringshared strings get no new references
20365 * exclusive to the user grabbing the list, here, so if you'd like
20366 * to use them out of this call's context, you'd better @c
20367 * eina_stringshare_ref() them.
20369 * @see elm_slideshow_transition_set()
20371 * @ingroup Slideshow
20373 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20376 * Set the current slide transition/effect in use for a given
20379 * @param obj The slideshow object
20380 * @param transition The new transition's name string
20382 * If @p transition is implemented in @p obj's theme (i.e., is
20383 * contained in the list returned by
20384 * elm_slideshow_transitions_get()), this new sliding effect will
20385 * be used on the widget.
20387 * @see elm_slideshow_transitions_get() for more details
20389 * @ingroup Slideshow
20391 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20394 * Get the current slide transition/effect in use for a given
20397 * @param obj The slideshow object
20398 * @return The current transition's name
20400 * @see elm_slideshow_transition_set() for more details
20402 * @ingroup Slideshow
20404 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20407 * Set the interval between each image transition on a given
20408 * slideshow widget, <b>and start the slideshow, itself</b>
20410 * @param obj The slideshow object
20411 * @param timeout The new displaying timeout for images
20413 * After this call, the slideshow widget will start cycling its
20414 * view, sequentially and automatically, with the images of the
20415 * items it has. The time between each new image displayed is going
20416 * to be @p timeout, in @b seconds. If a different timeout was set
20417 * previously and an slideshow was in progress, it will continue
20418 * with the new time between transitions, after this call.
20420 * @note A value less than or equal to 0 on @p timeout will disable
20421 * the widget's internal timer, thus halting any slideshow which
20422 * could be happening on @p obj.
20424 * @see elm_slideshow_timeout_get()
20426 * @ingroup Slideshow
20428 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20431 * Get the interval set for image transitions on a given slideshow
20434 * @param obj The slideshow object
20435 * @return Returns the timeout set on it
20437 * @see elm_slideshow_timeout_set() for more details
20439 * @ingroup Slideshow
20441 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20444 * Set if, after a slideshow is started, for a given slideshow
20445 * widget, its items should be displayed cyclically or not.
20447 * @param obj The slideshow object
20448 * @param loop Use @c EINA_TRUE to make it cycle through items or
20449 * @c EINA_FALSE for it to stop at the end of @p obj's internal
20452 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20453 * ignore what is set by this functions, i.e., they'll @b always
20454 * cycle through items. This affects only the "automatic"
20455 * slideshow, as set by elm_slideshow_timeout_set().
20457 * @see elm_slideshow_loop_get()
20459 * @ingroup Slideshow
20461 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20464 * Get if, after a slideshow is started, for a given slideshow
20465 * widget, its items are to be displayed cyclically or not.
20467 * @param obj The slideshow object
20468 * @return @c EINA_TRUE, if the items in @p obj will be cycled
20469 * through or @c EINA_FALSE, otherwise
20471 * @see elm_slideshow_loop_set() for more details
20473 * @ingroup Slideshow
20475 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20478 * Remove all items from a given slideshow widget
20480 * @param obj The slideshow object
20482 * This removes (and deletes) all items in @p obj, leaving it
20485 * @see elm_slideshow_item_del(), to remove just one item.
20487 * @ingroup Slideshow
20489 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20492 * Get the internal list of items in a given slideshow widget.
20494 * @param obj The slideshow object
20495 * @return The list of items (#Elm_Slideshow_Item as data) or
20496 * @c NULL on errors.
20498 * This list is @b not to be modified in any way and must not be
20499 * freed. Use the list members with functions like
20500 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20502 * @warning This list is only valid until @p obj object's internal
20503 * items list is changed. It should be fetched again with another
20504 * call to this function when changes happen.
20506 * @ingroup Slideshow
20508 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20511 * Delete a given item from a slideshow widget.
20513 * @param item The slideshow item
20515 * @ingroup Slideshow
20517 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20520 * Return the data associated with a given slideshow item
20522 * @param item The slideshow item
20523 * @return Returns the data associated to this item
20525 * @ingroup Slideshow
20527 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20530 * Returns the currently displayed item, in a given slideshow widget
20532 * @param obj The slideshow object
20533 * @return A handle to the item being displayed in @p obj or
20534 * @c NULL, if none is (and on errors)
20536 * @ingroup Slideshow
20538 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20541 * Get the real Evas object created to implement the view of a
20542 * given slideshow item
20544 * @param item The slideshow item.
20545 * @return the Evas object implementing this item's view.
20547 * This returns the actual Evas object used to implement the
20548 * specified slideshow item's view. This may be @c NULL, as it may
20549 * not have been created or may have been deleted, at any time, by
20550 * the slideshow. <b>Do not modify this object</b> (move, resize,
20551 * show, hide, etc.), as the slideshow is controlling it. This
20552 * function is for querying, emitting custom signals or hooking
20553 * lower level callbacks for events on that object. Do not delete
20554 * this object under any circumstances.
20556 * @see elm_slideshow_item_data_get()
20558 * @ingroup Slideshow
20560 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20563 * Get the the item, in a given slideshow widget, placed at
20564 * position @p nth, in its internal items list
20566 * @param obj The slideshow object
20567 * @param nth The number of the item to grab a handle to (0 being
20569 * @return The item stored in @p obj at position @p nth or @c NULL,
20570 * if there's no item with that index (and on errors)
20572 * @ingroup Slideshow
20574 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20577 * Set the current slide layout in use for a given slideshow widget
20579 * @param obj The slideshow object
20580 * @param layout The new layout's name string
20582 * If @p layout is implemented in @p obj's theme (i.e., is contained
20583 * in the list returned by elm_slideshow_layouts_get()), this new
20584 * images layout will be used on the widget.
20586 * @see elm_slideshow_layouts_get() for more details
20588 * @ingroup Slideshow
20590 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20593 * Get the current slide layout in use for a given slideshow widget
20595 * @param obj The slideshow object
20596 * @return The current layout's name
20598 * @see elm_slideshow_layout_set() for more details
20600 * @ingroup Slideshow
20602 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20605 * Returns the list of @b layout names available, for a given
20606 * slideshow widget.
20608 * @param obj The slideshow object
20609 * @return The list of layouts (list of @b stringshared strings
20612 * Slideshow layouts will change how the widget is to dispose each
20613 * image item in its viewport, with regard to cropping, scaling,
20616 * The layouts, which come from @p obj's theme, must be an EDC
20617 * data item name @c "layouts" on the theme file, with (prefix)
20618 * names of EDC programs actually implementing them.
20620 * The available layouts for slideshows on the default theme are:
20621 * - @c "fullscreen" - item images with original aspect, scaled to
20622 * touch top and down slideshow borders or, if the image's heigh
20623 * is not enough, left and right slideshow borders.
20624 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20625 * one, but always leaving 10% of the slideshow's dimensions of
20626 * distance between the item image's borders and the slideshow
20627 * borders, for each axis.
20629 * @warning The stringshared strings get no new references
20630 * exclusive to the user grabbing the list, here, so if you'd like
20631 * to use them out of this call's context, you'd better @c
20632 * eina_stringshare_ref() them.
20634 * @see elm_slideshow_layout_set()
20636 * @ingroup Slideshow
20638 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20641 * Set the number of items to cache, on a given slideshow widget,
20642 * <b>before the current item</b>
20644 * @param obj The slideshow object
20645 * @param count Number of items to cache before the current one
20647 * The default value for this property is @c 2. See
20648 * @ref Slideshow_Caching "slideshow caching" for more details.
20650 * @see elm_slideshow_cache_before_get()
20652 * @ingroup Slideshow
20654 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20657 * Retrieve the number of items to cache, on a given slideshow widget,
20658 * <b>before the current item</b>
20660 * @param obj The slideshow object
20661 * @return The number of items set to be cached before the current one
20663 * @see elm_slideshow_cache_before_set() for more details
20665 * @ingroup Slideshow
20667 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20670 * Set the number of items to cache, on a given slideshow widget,
20671 * <b>after the current item</b>
20673 * @param obj The slideshow object
20674 * @param count Number of items to cache after the current one
20676 * The default value for this property is @c 2. See
20677 * @ref Slideshow_Caching "slideshow caching" for more details.
20679 * @see elm_slideshow_cache_after_get()
20681 * @ingroup Slideshow
20683 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20686 * Retrieve the number of items to cache, on a given slideshow widget,
20687 * <b>after the current item</b>
20689 * @param obj The slideshow object
20690 * @return The number of items set to be cached after the current one
20692 * @see elm_slideshow_cache_after_set() for more details
20694 * @ingroup Slideshow
20696 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20699 * Get the number of items stored in a given slideshow widget
20701 * @param obj The slideshow object
20702 * @return The number of items on @p obj, at the moment of this call
20704 * @ingroup Slideshow
20706 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20713 * @defgroup Fileselector File Selector
20715 * @image html img/widget/fileselector/preview-00.png
20716 * @image latex img/widget/fileselector/preview-00.eps
20718 * A file selector is a widget that allows a user to navigate
20719 * through a file system, reporting file selections back via its
20722 * It contains shortcut buttons for home directory (@c ~) and to
20723 * jump one directory upwards (..), as well as cancel/ok buttons to
20724 * confirm/cancel a given selection. After either one of those two
20725 * former actions, the file selector will issue its @c "done" smart
20728 * There's a text entry on it, too, showing the name of the current
20729 * selection. There's the possibility of making it editable, so it
20730 * is useful on file saving dialogs on applications, where one
20731 * gives a file name to save contents to, in a given directory in
20732 * the system. This custom file name will be reported on the @c
20733 * "done" smart callback (explained in sequence).
20735 * Finally, it has a view to display file system items into in two
20740 * If Elementary is built with support of the Ethumb thumbnailing
20741 * library, the second form of view will display preview thumbnails
20742 * of files which it supports.
20744 * Smart callbacks one can register to:
20746 * - @c "selected" - the user has clicked on a file (when not in
20747 * folders-only mode) or directory (when in folders-only mode)
20748 * - @c "directory,open" - the list has been populated with new
20749 * content (@c event_info is a pointer to the directory's
20750 * path, a @b stringshared string)
20751 * - @c "done" - the user has clicked on the "ok" or "cancel"
20752 * buttons (@c event_info is a pointer to the selection's
20753 * path, a @b stringshared string)
20755 * Here is an example on its usage:
20756 * @li @ref fileselector_example
20760 * @addtogroup Fileselector
20765 * Defines how a file selector widget is to layout its contents
20766 * (file system entries).
20768 typedef enum _Elm_Fileselector_Mode
20770 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20771 ELM_FILESELECTOR_GRID, /**< layout as a grid */
20772 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20773 } Elm_Fileselector_Mode;
20776 * Add a new file selector widget to the given parent Elementary
20777 * (container) object
20779 * @param parent The parent object
20780 * @return a new file selector widget handle or @c NULL, on errors
20782 * This function inserts a new file selector widget on the canvas.
20784 * @ingroup Fileselector
20786 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20789 * Enable/disable the file name entry box where the user can type
20790 * in a name for a file, in a given file selector widget
20792 * @param obj The file selector object
20793 * @param is_save @c EINA_TRUE to make the file selector a "saving
20794 * dialog", @c EINA_FALSE otherwise
20796 * Having the entry editable is useful on file saving dialogs on
20797 * applications, where one gives a file name to save contents to,
20798 * in a given directory in the system. This custom file name will
20799 * be reported on the @c "done" smart callback.
20801 * @see elm_fileselector_is_save_get()
20803 * @ingroup Fileselector
20805 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20808 * Get whether the given file selector is in "saving dialog" mode
20810 * @param obj The file selector object
20811 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20812 * mode, @c EINA_FALSE otherwise (and on errors)
20814 * @see elm_fileselector_is_save_set() for more details
20816 * @ingroup Fileselector
20818 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20821 * Enable/disable folder-only view for a given file selector widget
20823 * @param obj The file selector object
20824 * @param only @c EINA_TRUE to make @p obj only display
20825 * directories, @c EINA_FALSE to make files to be displayed in it
20828 * If enabled, the widget's view will only display folder items,
20831 * @see elm_fileselector_folder_only_get()
20833 * @ingroup Fileselector
20835 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20838 * Get whether folder-only view is set for a given file selector
20841 * @param obj The file selector object
20842 * @return only @c EINA_TRUE if @p obj is only displaying
20843 * directories, @c EINA_FALSE if files are being displayed in it
20844 * too (and on errors)
20846 * @see elm_fileselector_folder_only_get()
20848 * @ingroup Fileselector
20850 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20853 * Enable/disable the "ok" and "cancel" buttons on a given file
20856 * @param obj The file selector object
20857 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
20859 * @note A file selector without those buttons will never emit the
20860 * @c "done" smart event, and is only usable if one is just hooking
20861 * to the other two events.
20863 * @see elm_fileselector_buttons_ok_cancel_get()
20865 * @ingroup Fileselector
20867 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
20870 * Get whether the "ok" and "cancel" buttons on a given file
20871 * selector widget are being shown.
20873 * @param obj The file selector object
20874 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
20875 * otherwise (and on errors)
20877 * @see elm_fileselector_buttons_ok_cancel_set() for more details
20879 * @ingroup Fileselector
20881 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20884 * Enable/disable a tree view in the given file selector widget,
20885 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
20887 * @param obj The file selector object
20888 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
20891 * In a tree view, arrows are created on the sides of directories,
20892 * allowing them to expand in place.
20894 * @note If it's in other mode, the changes made by this function
20895 * will only be visible when one switches back to "list" mode.
20897 * @see elm_fileselector_expandable_get()
20899 * @ingroup Fileselector
20901 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
20904 * Get whether tree view is enabled for the given file selector
20907 * @param obj The file selector object
20908 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
20909 * otherwise (and or errors)
20911 * @see elm_fileselector_expandable_set() for more details
20913 * @ingroup Fileselector
20915 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20918 * Set, programmatically, the @b directory that a given file
20919 * selector widget will display contents from
20921 * @param obj The file selector object
20922 * @param path The path to display in @p obj
20924 * This will change the @b directory that @p obj is displaying. It
20925 * will also clear the text entry area on the @p obj object, which
20926 * displays select files' names.
20928 * @see elm_fileselector_path_get()
20930 * @ingroup Fileselector
20932 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20935 * Get the parent directory's path that a given file selector
20936 * widget is displaying
20938 * @param obj The file selector object
20939 * @return The (full) path of the directory the file selector is
20940 * displaying, a @b stringshared string
20942 * @see elm_fileselector_path_set()
20944 * @ingroup Fileselector
20946 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20949 * Set, programmatically, the currently selected file/directory in
20950 * the given file selector widget
20952 * @param obj The file selector object
20953 * @param path The (full) path to a file or directory
20954 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
20955 * latter case occurs if the directory or file pointed to do not
20958 * @see elm_fileselector_selected_get()
20960 * @ingroup Fileselector
20962 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20965 * Get the currently selected item's (full) path, in the given file
20968 * @param obj The file selector object
20969 * @return The absolute path of the selected item, a @b
20970 * stringshared string
20972 * @note Custom editions on @p obj object's text entry, if made,
20973 * will appear on the return string of this function, naturally.
20975 * @see elm_fileselector_selected_set() for more details
20977 * @ingroup Fileselector
20979 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20982 * Set the mode in which a given file selector widget will display
20983 * (layout) file system entries in its view
20985 * @param obj The file selector object
20986 * @param mode The mode of the fileselector, being it one of
20987 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
20988 * first one, naturally, will display the files in a list. The
20989 * latter will make the widget to display its entries in a grid
20992 * @note By using elm_fileselector_expandable_set(), the user may
20993 * trigger a tree view for that list.
20995 * @note If Elementary is built with support of the Ethumb
20996 * thumbnailing library, the second form of view will display
20997 * preview thumbnails of files which it supports. You must have
20998 * elm_need_ethumb() called in your Elementary for thumbnailing to
21001 * @see elm_fileselector_expandable_set().
21002 * @see elm_fileselector_mode_get().
21004 * @ingroup Fileselector
21006 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
21009 * Get the mode in which a given file selector widget is displaying
21010 * (layouting) file system entries in its view
21012 * @param obj The fileselector object
21013 * @return The mode in which the fileselector is at
21015 * @see elm_fileselector_mode_set() for more details
21017 * @ingroup Fileselector
21019 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21026 * @defgroup Progressbar Progress bar
21028 * The progress bar is a widget for visually representing the
21029 * progress status of a given job/task.
21031 * A progress bar may be horizontal or vertical. It may display an
21032 * icon besides it, as well as primary and @b units labels. The
21033 * former is meant to label the widget as a whole, while the
21034 * latter, which is formatted with floating point values (and thus
21035 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
21036 * units"</c>), is meant to label the widget's <b>progress
21037 * value</b>. Label, icon and unit strings/objects are @b optional
21038 * for progress bars.
21040 * A progress bar may be @b inverted, in which state it gets its
21041 * values inverted, with high values being on the left or top and
21042 * low values on the right or bottom, as opposed to normally have
21043 * the low values on the former and high values on the latter,
21044 * respectively, for horizontal and vertical modes.
21046 * The @b span of the progress, as set by
21047 * elm_progressbar_span_size_set(), is its length (horizontally or
21048 * vertically), unless one puts size hints on the widget to expand
21049 * on desired directions, by any container. That length will be
21050 * scaled by the object or applications scaling factor. At any
21051 * point code can query the progress bar for its value with
21052 * elm_progressbar_value_get().
21054 * Available widget styles for progress bars:
21056 * - @c "wheel" (simple style, no text, no progression, only
21057 * "pulse" effect is available)
21059 * Default contents parts of the progressbar widget that you can use for are:
21060 * @li "elm.swallow.content" - A icon of the progressbar
21062 * Here is an example on its usage:
21063 * @li @ref progressbar_example
21067 * Add a new progress bar widget to the given parent Elementary
21068 * (container) object
21070 * @param parent The parent object
21071 * @return a new progress bar widget handle or @c NULL, on errors
21073 * This function inserts a new progress bar widget on the canvas.
21075 * @ingroup Progressbar
21077 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21080 * Set whether a given progress bar widget is at "pulsing mode" or
21083 * @param obj The progress bar object
21084 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21085 * @c EINA_FALSE to put it back to its default one
21087 * By default, progress bars will display values from the low to
21088 * high value boundaries. There are, though, contexts in which the
21089 * state of progression of a given task is @b unknown. For those,
21090 * one can set a progress bar widget to a "pulsing state", to give
21091 * the user an idea that some computation is being held, but
21092 * without exact progress values. In the default theme it will
21093 * animate its bar with the contents filling in constantly and back
21094 * to non-filled, in a loop. To start and stop this pulsing
21095 * animation, one has to explicitly call elm_progressbar_pulse().
21097 * @see elm_progressbar_pulse_get()
21098 * @see elm_progressbar_pulse()
21100 * @ingroup Progressbar
21102 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21105 * Get whether a given progress bar widget is at "pulsing mode" or
21108 * @param obj The progress bar object
21109 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21110 * if it's in the default one (and on errors)
21112 * @ingroup Progressbar
21114 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21117 * Start/stop a given progress bar "pulsing" animation, if its
21120 * @param obj The progress bar object
21121 * @param state @c EINA_TRUE, to @b start the pulsing animation,
21122 * @c EINA_FALSE to @b stop it
21124 * @note This call won't do anything if @p obj is not under "pulsing mode".
21126 * @see elm_progressbar_pulse_set() for more details.
21128 * @ingroup Progressbar
21130 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21133 * Set the progress value (in percentage) on a given progress bar
21136 * @param obj The progress bar object
21137 * @param val The progress value (@b must be between @c 0.0 and @c
21140 * Use this call to set progress bar levels.
21142 * @note If you passes a value out of the specified range for @p
21143 * val, it will be interpreted as the @b closest of the @b boundary
21144 * values in the range.
21146 * @ingroup Progressbar
21148 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21151 * Get the progress value (in percentage) on a given progress bar
21154 * @param obj The progress bar object
21155 * @return The value of the progressbar
21157 * @see elm_progressbar_value_set() for more details
21159 * @ingroup Progressbar
21161 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21164 * Set the label of a given progress bar widget
21166 * @param obj The progress bar object
21167 * @param label The text label string, in UTF-8
21169 * @ingroup Progressbar
21170 * @deprecated use elm_object_text_set() instead.
21172 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21175 * Get the label of a given progress bar widget
21177 * @param obj The progressbar object
21178 * @return The text label string, in UTF-8
21180 * @ingroup Progressbar
21181 * @deprecated use elm_object_text_set() instead.
21183 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21186 * Set the icon object of a given progress bar widget
21188 * @param obj The progress bar object
21189 * @param icon The icon object
21191 * Use this call to decorate @p obj with an icon next to it.
21193 * @note Once the icon object is set, a previously set one will be
21194 * deleted. If you want to keep that old content object, use the
21195 * elm_progressbar_icon_unset() function.
21197 * @see elm_progressbar_icon_get()
21198 * @deprecated use elm_object_content_set() instead.
21200 * @ingroup Progressbar
21202 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21205 * Retrieve the icon object set for a given progress bar widget
21207 * @param obj The progress bar object
21208 * @return The icon object's handle, if @p obj had one set, or @c NULL,
21209 * otherwise (and on errors)
21211 * @see elm_progressbar_icon_set() for more details
21212 * @deprecated use elm_object_content_set() instead.
21214 * @ingroup Progressbar
21216 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21219 * Unset an icon set on a given progress bar widget
21221 * @param obj The progress bar object
21222 * @return The icon object that was being used, if any was set, or
21223 * @c NULL, otherwise (and on errors)
21225 * This call will unparent and return the icon object which was set
21226 * for this widget, previously, on success.
21228 * @see elm_progressbar_icon_set() for more details
21229 * @deprecated use elm_object_content_unset() instead.
21231 * @ingroup Progressbar
21233 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21236 * Set the (exact) length of the bar region of a given progress bar
21239 * @param obj The progress bar object
21240 * @param size The length of the progress bar's bar region
21242 * This sets the minimum width (when in horizontal mode) or height
21243 * (when in vertical mode) of the actual bar area of the progress
21244 * bar @p obj. This in turn affects the object's minimum size. Use
21245 * this when you're not setting other size hints expanding on the
21246 * given direction (like weight and alignment hints) and you would
21247 * like it to have a specific size.
21249 * @note Icon, label and unit text around @p obj will require their
21250 * own space, which will make @p obj to require more the @p size,
21253 * @see elm_progressbar_span_size_get()
21255 * @ingroup Progressbar
21257 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21260 * Get the length set for the bar region of a given progress bar
21263 * @param obj The progress bar object
21264 * @return The length of the progress bar's bar region
21266 * If that size was not set previously, with
21267 * elm_progressbar_span_size_set(), this call will return @c 0.
21269 * @ingroup Progressbar
21271 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21274 * Set the format string for a given progress bar widget's units
21277 * @param obj The progress bar object
21278 * @param format The format string for @p obj's units label
21280 * If @c NULL is passed on @p format, it will make @p obj's units
21281 * area to be hidden completely. If not, it'll set the <b>format
21282 * string</b> for the units label's @b text. The units label is
21283 * provided a floating point value, so the units text is up display
21284 * at most one floating point falue. Note that the units label is
21285 * optional. Use a format string such as "%1.2f meters" for
21288 * @note The default format string for a progress bar is an integer
21289 * percentage, as in @c "%.0f %%".
21291 * @see elm_progressbar_unit_format_get()
21293 * @ingroup Progressbar
21295 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21298 * Retrieve the format string set for a given progress bar widget's
21301 * @param obj The progress bar object
21302 * @return The format set string for @p obj's units label or
21303 * @c NULL, if none was set (and on errors)
21305 * @see elm_progressbar_unit_format_set() for more details
21307 * @ingroup Progressbar
21309 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21312 * Set the orientation of a given progress bar widget
21314 * @param obj The progress bar object
21315 * @param horizontal Use @c EINA_TRUE to make @p obj to be
21316 * @b horizontal, @c EINA_FALSE to make it @b vertical
21318 * Use this function to change how your progress bar is to be
21319 * disposed: vertically or horizontally.
21321 * @see elm_progressbar_horizontal_get()
21323 * @ingroup Progressbar
21325 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21328 * Retrieve the orientation of a given progress bar widget
21330 * @param obj The progress bar object
21331 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21332 * @c EINA_FALSE if it's @b vertical (and on errors)
21334 * @see elm_progressbar_horizontal_set() for more details
21336 * @ingroup Progressbar
21338 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21341 * Invert a given progress bar widget's displaying values order
21343 * @param obj The progress bar object
21344 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21345 * @c EINA_FALSE to bring it back to default, non-inverted values.
21347 * A progress bar may be @b inverted, in which state it gets its
21348 * values inverted, with high values being on the left or top and
21349 * low values on the right or bottom, as opposed to normally have
21350 * the low values on the former and high values on the latter,
21351 * respectively, for horizontal and vertical modes.
21353 * @see elm_progressbar_inverted_get()
21355 * @ingroup Progressbar
21357 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21360 * Get whether a given progress bar widget's displaying values are
21363 * @param obj The progress bar object
21364 * @return @c EINA_TRUE, if @p obj has inverted values,
21365 * @c EINA_FALSE otherwise (and on errors)
21367 * @see elm_progressbar_inverted_set() for more details
21369 * @ingroup Progressbar
21371 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21374 * @defgroup Separator Separator
21376 * @brief Separator is a very thin object used to separate other objects.
21378 * A separator can be vertical or horizontal.
21380 * @ref tutorial_separator is a good example of how to use a separator.
21384 * @brief Add a separator object to @p parent
21386 * @param parent The parent object
21388 * @return The separator object, or NULL upon failure
21390 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21392 * @brief Set the horizontal mode of a separator object
21394 * @param obj The separator object
21395 * @param horizontal If true, the separator is horizontal
21397 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21399 * @brief Get the horizontal mode of a separator object
21401 * @param obj The separator object
21402 * @return If true, the separator is horizontal
21404 * @see elm_separator_horizontal_set()
21406 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21412 * @defgroup Spinner Spinner
21413 * @ingroup Elementary
21415 * @image html img/widget/spinner/preview-00.png
21416 * @image latex img/widget/spinner/preview-00.eps
21418 * A spinner is a widget which allows the user to increase or decrease
21419 * numeric values using arrow buttons, or edit values directly, clicking
21420 * over it and typing the new value.
21422 * By default the spinner will not wrap and has a label
21423 * of "%.0f" (just showing the integer value of the double).
21425 * A spinner has a label that is formatted with floating
21426 * point values and thus accepts a printf-style format string, like
21427 * ā%1.2f unitsā.
21429 * It also allows specific values to be replaced by pre-defined labels.
21431 * Smart callbacks one can register to:
21433 * - "changed" - Whenever the spinner value is changed.
21434 * - "delay,changed" - A short time after the value is changed by the user.
21435 * This will be called only when the user stops dragging for a very short
21436 * period or when they release their finger/mouse, so it avoids possibly
21437 * expensive reactions to the value change.
21439 * Available styles for it:
21441 * - @c "vertical": up/down buttons at the right side and text left aligned.
21443 * Here is an example on its usage:
21444 * @ref spinner_example
21448 * @addtogroup Spinner
21453 * Add a new spinner widget to the given parent Elementary
21454 * (container) object.
21456 * @param parent The parent object.
21457 * @return a new spinner widget handle or @c NULL, on errors.
21459 * This function inserts a new spinner widget on the canvas.
21464 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21467 * Set the format string of the displayed label.
21469 * @param obj The spinner object.
21470 * @param fmt The format string for the label display.
21472 * If @c NULL, this sets the format to "%.0f". If not it sets the format
21473 * string for the label text. The label text is provided a floating point
21474 * value, so the label text can display up to 1 floating point value.
21475 * Note that this is optional.
21477 * Use a format string such as "%1.2f meters" for example, and it will
21478 * display values like: "3.14 meters" for a value equal to 3.14159.
21480 * Default is "%0.f".
21482 * @see elm_spinner_label_format_get()
21486 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21489 * Get the label format of the spinner.
21491 * @param obj The spinner object.
21492 * @return The text label format string in UTF-8.
21494 * @see elm_spinner_label_format_set() for details.
21498 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21501 * Set the minimum and maximum values for the spinner.
21503 * @param obj The spinner object.
21504 * @param min The minimum value.
21505 * @param max The maximum value.
21507 * Define the allowed range of values to be selected by the user.
21509 * If actual value is less than @p min, it will be updated to @p min. If it
21510 * is bigger then @p max, will be updated to @p max. Actual value can be
21511 * get with elm_spinner_value_get().
21513 * By default, min is equal to 0, and max is equal to 100.
21515 * @warning Maximum must be greater than minimum.
21517 * @see elm_spinner_min_max_get()
21521 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21524 * Get the minimum and maximum values of the spinner.
21526 * @param obj The spinner object.
21527 * @param min Pointer where to store the minimum value.
21528 * @param max Pointer where to store the maximum value.
21530 * @note If only one value is needed, the other pointer can be passed
21533 * @see elm_spinner_min_max_set() for details.
21537 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21540 * Set the step used to increment or decrement the spinner value.
21542 * @param obj The spinner object.
21543 * @param step The step value.
21545 * This value will be incremented or decremented to the displayed value.
21546 * It will be incremented while the user keep right or top arrow pressed,
21547 * and will be decremented while the user keep left or bottom arrow pressed.
21549 * The interval to increment / decrement can be set with
21550 * elm_spinner_interval_set().
21552 * By default step value is equal to 1.
21554 * @see elm_spinner_step_get()
21558 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21561 * Get the step used to increment or decrement the spinner value.
21563 * @param obj The spinner object.
21564 * @return The step value.
21566 * @see elm_spinner_step_get() for more details.
21570 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21573 * Set the value the spinner displays.
21575 * @param obj The spinner object.
21576 * @param val The value to be displayed.
21578 * Value will be presented on the label following format specified with
21579 * elm_spinner_format_set().
21581 * @warning The value must to be between min and max values. This values
21582 * are set by elm_spinner_min_max_set().
21584 * @see elm_spinner_value_get().
21585 * @see elm_spinner_format_set().
21586 * @see elm_spinner_min_max_set().
21590 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21593 * Get the value displayed by the spinner.
21595 * @param obj The spinner object.
21596 * @return The value displayed.
21598 * @see elm_spinner_value_set() for details.
21602 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21605 * Set whether the spinner should wrap when it reaches its
21606 * minimum or maximum value.
21608 * @param obj The spinner object.
21609 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21612 * Disabled by default. If disabled, when the user tries to increment the
21614 * but displayed value plus step value is bigger than maximum value,
21616 * won't allow it. The same happens when the user tries to decrement it,
21617 * but the value less step is less than minimum value.
21619 * When wrap is enabled, in such situations it will allow these changes,
21620 * but will get the value that would be less than minimum and subtracts
21621 * from maximum. Or add the value that would be more than maximum to
21625 * @li min value = 10
21626 * @li max value = 50
21627 * @li step value = 20
21628 * @li displayed value = 20
21630 * When the user decrement value (using left or bottom arrow), it will
21631 * displays @c 40, because max - (min - (displayed - step)) is
21632 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21634 * @see elm_spinner_wrap_get().
21638 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21641 * Get whether the spinner should wrap when it reaches its
21642 * minimum or maximum value.
21644 * @param obj The spinner object
21645 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21646 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21648 * @see elm_spinner_wrap_set() for details.
21652 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21655 * Set whether the spinner can be directly edited by the user or not.
21657 * @param obj The spinner object.
21658 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21659 * don't allow users to edit it directly.
21661 * Spinner objects can have edition @b disabled, in which state they will
21662 * be changed only by arrows.
21663 * Useful for contexts
21664 * where you don't want your users to interact with it writting the value.
21666 * when using special values, the user can see real value instead
21667 * of special label on edition.
21669 * It's enabled by default.
21671 * @see elm_spinner_editable_get()
21675 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21678 * Get whether the spinner can be directly edited by the user or not.
21680 * @param obj The spinner object.
21681 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21682 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21684 * @see elm_spinner_editable_set() for details.
21688 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21691 * Set a special string to display in the place of the numerical value.
21693 * @param obj The spinner object.
21694 * @param value The value to be replaced.
21695 * @param label The label to be used.
21697 * It's useful for cases when a user should select an item that is
21698 * better indicated by a label than a value. For example, weekdays or months.
21702 * sp = elm_spinner_add(win);
21703 * elm_spinner_min_max_set(sp, 1, 3);
21704 * elm_spinner_special_value_add(sp, 1, "January");
21705 * elm_spinner_special_value_add(sp, 2, "February");
21706 * elm_spinner_special_value_add(sp, 3, "March");
21707 * evas_object_show(sp);
21712 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21715 * Set the interval on time updates for an user mouse button hold
21716 * on spinner widgets' arrows.
21718 * @param obj The spinner object.
21719 * @param interval The (first) interval value in seconds.
21721 * This interval value is @b decreased while the user holds the
21722 * mouse pointer either incrementing or decrementing spinner's value.
21724 * This helps the user to get to a given value distant from the
21725 * current one easier/faster, as it will start to change quicker and
21726 * quicker on mouse button holds.
21728 * The calculation for the next change interval value, starting from
21729 * the one set with this call, is the previous interval divided by
21730 * @c 1.05, so it decreases a little bit.
21732 * The default starting interval value for automatic changes is
21735 * @see elm_spinner_interval_get()
21739 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21742 * Get the interval on time updates for an user mouse button hold
21743 * on spinner widgets' arrows.
21745 * @param obj The spinner object.
21746 * @return The (first) interval value, in seconds, set on it.
21748 * @see elm_spinner_interval_set() for more details.
21752 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21759 * @defgroup Index Index
21761 * @image html img/widget/index/preview-00.png
21762 * @image latex img/widget/index/preview-00.eps
21764 * An index widget gives you an index for fast access to whichever
21765 * group of other UI items one might have. It's a list of text
21766 * items (usually letters, for alphabetically ordered access).
21768 * Index widgets are by default hidden and just appear when the
21769 * user clicks over it's reserved area in the canvas. In its
21770 * default theme, it's an area one @ref Fingers "finger" wide on
21771 * the right side of the index widget's container.
21773 * When items on the index are selected, smart callbacks get
21774 * called, so that its user can make other container objects to
21775 * show a given area or child object depending on the index item
21776 * selected. You'd probably be using an index together with @ref
21777 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21780 * Smart events one can add callbacks for are:
21781 * - @c "changed" - When the selected index item changes. @c
21782 * event_info is the selected item's data pointer.
21783 * - @c "delay,changed" - When the selected index item changes, but
21784 * after a small idling period. @c event_info is the selected
21785 * item's data pointer.
21786 * - @c "selected" - When the user releases a mouse button and
21787 * selects an item. @c event_info is the selected item's data
21789 * - @c "level,up" - when the user moves a finger from the first
21790 * level to the second level
21791 * - @c "level,down" - when the user moves a finger from the second
21792 * level to the first level
21794 * The @c "delay,changed" event is so that it'll wait a small time
21795 * before actually reporting those events and, moreover, just the
21796 * last event happening on those time frames will actually be
21799 * Here are some examples on its usage:
21800 * @li @ref index_example_01
21801 * @li @ref index_example_02
21805 * @addtogroup Index
21809 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21812 * Add a new index widget to the given parent Elementary
21813 * (container) object
21815 * @param parent The parent object
21816 * @return a new index widget handle or @c NULL, on errors
21818 * This function inserts a new index widget on the canvas.
21822 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21825 * Set whether a given index widget is or not visible,
21828 * @param obj The index object
21829 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21831 * Not to be confused with visible as in @c evas_object_show() --
21832 * visible with regard to the widget's auto hiding feature.
21834 * @see elm_index_active_get()
21838 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21841 * Get whether a given index widget is currently visible or not.
21843 * @param obj The index object
21844 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21846 * @see elm_index_active_set() for more details
21850 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21853 * Set the items level for a given index widget.
21855 * @param obj The index object.
21856 * @param level @c 0 or @c 1, the currently implemented levels.
21858 * @see elm_index_item_level_get()
21862 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21865 * Get the items level set for a given index widget.
21867 * @param obj The index object.
21868 * @return @c 0 or @c 1, which are the levels @p obj might be at.
21870 * @see elm_index_item_level_set() for more information
21874 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21877 * Returns the last selected item's data, for a given index widget.
21879 * @param obj The index object.
21880 * @return The item @b data associated to the last selected item on
21881 * @p obj (or @c NULL, on errors).
21883 * @warning The returned value is @b not an #Elm_Index_Item item
21884 * handle, but the data associated to it (see the @c item parameter
21885 * in elm_index_item_append(), as an example).
21889 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21892 * Append a new item on a given index widget.
21894 * @param obj The index object.
21895 * @param letter Letter under which the item should be indexed
21896 * @param item The item data to set for the index's item
21898 * Despite the most common usage of the @p letter argument is for
21899 * single char strings, one could use arbitrary strings as index
21902 * @c item will be the pointer returned back on @c "changed", @c
21903 * "delay,changed" and @c "selected" smart events.
21907 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21910 * Prepend a new item on a given index widget.
21912 * @param obj The index object.
21913 * @param letter Letter under which the item should be indexed
21914 * @param item The item data to set for the index's item
21916 * Despite the most common usage of the @p letter argument is for
21917 * single char strings, one could use arbitrary strings as index
21920 * @c item will be the pointer returned back on @c "changed", @c
21921 * "delay,changed" and @c "selected" smart events.
21925 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21928 * Append a new item, on a given index widget, <b>after the item
21929 * having @p relative as data</b>.
21931 * @param obj The index object.
21932 * @param letter Letter under which the item should be indexed
21933 * @param item The item data to set for the index's item
21934 * @param relative The item data of the index item to be the
21935 * predecessor of this new one
21937 * Despite the most common usage of the @p letter argument is for
21938 * single char strings, one could use arbitrary strings as index
21941 * @c item will be the pointer returned back on @c "changed", @c
21942 * "delay,changed" and @c "selected" smart events.
21944 * @note If @p relative is @c NULL or if it's not found to be data
21945 * set on any previous item on @p obj, this function will behave as
21946 * elm_index_item_append().
21950 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21953 * Prepend a new item, on a given index widget, <b>after the item
21954 * having @p relative as data</b>.
21956 * @param obj The index object.
21957 * @param letter Letter under which the item should be indexed
21958 * @param item The item data to set for the index's item
21959 * @param relative The item data of the index item to be the
21960 * successor of this new one
21962 * Despite the most common usage of the @p letter argument is for
21963 * single char strings, one could use arbitrary strings as index
21966 * @c item will be the pointer returned back on @c "changed", @c
21967 * "delay,changed" and @c "selected" smart events.
21969 * @note If @p relative is @c NULL or if it's not found to be data
21970 * set on any previous item on @p obj, this function will behave as
21971 * elm_index_item_prepend().
21975 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21978 * Insert a new item into the given index widget, using @p cmp_func
21979 * function to sort items (by item handles).
21981 * @param obj The index object.
21982 * @param letter Letter under which the item should be indexed
21983 * @param item The item data to set for the index's item
21984 * @param cmp_func The comparing function to be used to sort index
21985 * items <b>by #Elm_Index_Item item handles</b>
21986 * @param cmp_data_func A @b fallback function to be called for the
21987 * sorting of index items <b>by item data</b>). It will be used
21988 * when @p cmp_func returns @c 0 (equality), which means an index
21989 * item with provided item data already exists. To decide which
21990 * data item should be pointed to by the index item in question, @p
21991 * cmp_data_func will be used. If @p cmp_data_func returns a
21992 * non-negative value, the previous index item data will be
21993 * replaced by the given @p item pointer. If the previous data need
21994 * to be freed, it should be done by the @p cmp_data_func function,
21995 * because all references to it will be lost. If this function is
21996 * not provided (@c NULL is given), index items will be @b
21997 * duplicated, if @p cmp_func returns @c 0.
21999 * Despite the most common usage of the @p letter argument is for
22000 * single char strings, one could use arbitrary strings as index
22003 * @c item will be the pointer returned back on @c "changed", @c
22004 * "delay,changed" and @c "selected" smart events.
22008 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);
22011 * Remove an item from a given index widget, <b>to be referenced by
22012 * it's data value</b>.
22014 * @param obj The index object
22015 * @param item The item's data pointer for the item to be removed
22018 * If a deletion callback is set, via elm_index_item_del_cb_set(),
22019 * that callback function will be called by this one.
22021 * @warning The item to be removed from @p obj will be found via
22022 * its item data pointer, and not by an #Elm_Index_Item handle.
22026 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22029 * Find a given index widget's item, <b>using item data</b>.
22031 * @param obj The index object
22032 * @param item The item data pointed to by the desired index item
22033 * @return The index item handle, if found, or @c NULL otherwise
22037 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22040 * Removes @b all items from a given index widget.
22042 * @param obj The index object.
22044 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
22045 * that callback function will be called for each item in @p obj.
22049 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22052 * Go to a given items level on a index widget
22054 * @param obj The index object
22055 * @param level The index level (one of @c 0 or @c 1)
22059 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22062 * Return the data associated with a given index widget item
22064 * @param it The index widget item handle
22065 * @return The data associated with @p it
22067 * @see elm_index_item_data_set()
22071 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22074 * Set the data associated with a given index widget item
22076 * @param it The index widget item handle
22077 * @param data The new data pointer to set to @p it
22079 * This sets new item data on @p it.
22081 * @warning The old data pointer won't be touched by this function, so
22082 * the user had better to free that old data himself/herself.
22086 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22089 * Set the function to be called when a given index widget item is freed.
22091 * @param it The item to set the callback on
22092 * @param func The function to call on the item's deletion
22094 * When called, @p func will have both @c data and @c event_info
22095 * arguments with the @p it item's data value and, naturally, the
22096 * @c obj argument with a handle to the parent index widget.
22100 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22103 * Get the letter (string) set on a given index widget item.
22105 * @param it The index item handle
22106 * @return The letter string set on @p it
22110 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22114 EAPI void elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
22121 * @defgroup Photocam Photocam
22123 * @image html img/widget/photocam/preview-00.png
22124 * @image latex img/widget/photocam/preview-00.eps
22126 * This is a widget specifically for displaying high-resolution digital
22127 * camera photos giving speedy feedback (fast load), low memory footprint
22128 * and zooming and panning as well as fitting logic. It is entirely focused
22129 * on jpeg images, and takes advantage of properties of the jpeg format (via
22130 * evas loader features in the jpeg loader).
22132 * Signals that you can add callbacks for are:
22133 * @li "clicked" - This is called when a user has clicked the photo without
22135 * @li "press" - This is called when a user has pressed down on the photo.
22136 * @li "longpressed" - This is called when a user has pressed down on the
22137 * photo for a long time without dragging around.
22138 * @li "clicked,double" - This is called when a user has double-clicked the
22140 * @li "load" - Photo load begins.
22141 * @li "loaded" - This is called when the image file load is complete for the
22142 * first view (low resolution blurry version).
22143 * @li "load,detail" - Photo detailed data load begins.
22144 * @li "loaded,detail" - This is called when the image file load is complete
22145 * for the detailed image data (full resolution needed).
22146 * @li "zoom,start" - Zoom animation started.
22147 * @li "zoom,stop" - Zoom animation stopped.
22148 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22149 * @li "scroll" - the content has been scrolled (moved)
22150 * @li "scroll,anim,start" - scrolling animation has started
22151 * @li "scroll,anim,stop" - scrolling animation has stopped
22152 * @li "scroll,drag,start" - dragging the contents around has started
22153 * @li "scroll,drag,stop" - dragging the contents around has stopped
22155 * @ref tutorial_photocam shows the API in action.
22159 * @brief Types of zoom available.
22161 typedef enum _Elm_Photocam_Zoom_Mode
22163 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
22164 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22165 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22166 ELM_PHOTOCAM_ZOOM_MODE_LAST
22167 } Elm_Photocam_Zoom_Mode;
22169 * @brief Add a new Photocam object
22171 * @param parent The parent object
22172 * @return The new object or NULL if it cannot be created
22174 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22176 * @brief Set the photo file to be shown
22178 * @param obj The photocam object
22179 * @param file The photo file
22180 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22182 * This sets (and shows) the specified file (with a relative or absolute
22183 * path) and will return a load error (same error that
22184 * evas_object_image_load_error_get() will return). The image will change and
22185 * adjust its size at this point and begin a background load process for this
22186 * photo that at some time in the future will be displayed at the full
22189 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22191 * @brief Returns the path of the current image file
22193 * @param obj The photocam object
22194 * @return Returns the path
22196 * @see elm_photocam_file_set()
22198 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22200 * @brief Set the zoom level of the photo
22202 * @param obj The photocam object
22203 * @param zoom The zoom level to set
22205 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22206 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22207 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22208 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22211 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22213 * @brief Get the zoom level of the photo
22215 * @param obj The photocam object
22216 * @return The current zoom level
22218 * This returns the current zoom level of the photocam object. Note that if
22219 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22220 * (which is the default), the zoom level may be changed at any time by the
22221 * photocam object itself to account for photo size and photocam viewpoer
22224 * @see elm_photocam_zoom_set()
22225 * @see elm_photocam_zoom_mode_set()
22227 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22229 * @brief Set the zoom mode
22231 * @param obj The photocam object
22232 * @param mode The desired mode
22234 * This sets the zoom mode to manual or one of several automatic levels.
22235 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22236 * elm_photocam_zoom_set() and will stay at that level until changed by code
22237 * or until zoom mode is changed. This is the default mode. The Automatic
22238 * modes will allow the photocam object to automatically adjust zoom mode
22239 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22240 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22241 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22242 * pixels within the frame are left unfilled.
22244 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22246 * @brief Get the zoom mode
22248 * @param obj The photocam object
22249 * @return The current zoom mode
22251 * This gets the current zoom mode of the photocam object.
22253 * @see elm_photocam_zoom_mode_set()
22255 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22257 * @brief Get the current image pixel width and height
22259 * @param obj The photocam object
22260 * @param w A pointer to the width return
22261 * @param h A pointer to the height return
22263 * This gets the current photo pixel width and height (for the original).
22264 * The size will be returned in the integers @p w and @p h that are pointed
22267 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22269 * @brief Get the area of the image that is currently shown
22272 * @param x A pointer to the X-coordinate of region
22273 * @param y A pointer to the Y-coordinate of region
22274 * @param w A pointer to the width
22275 * @param h A pointer to the height
22277 * @see elm_photocam_image_region_show()
22278 * @see elm_photocam_image_region_bring_in()
22280 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22282 * @brief Set the viewed portion of the image
22284 * @param obj The photocam object
22285 * @param x X-coordinate of region in image original pixels
22286 * @param y Y-coordinate of region in image original pixels
22287 * @param w Width of region in image original pixels
22288 * @param h Height of region in image original pixels
22290 * This shows the region of the image without using animation.
22292 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22294 * @brief Bring in the viewed portion of the image
22296 * @param obj The photocam object
22297 * @param x X-coordinate of region in image original pixels
22298 * @param y Y-coordinate of region in image original pixels
22299 * @param w Width of region in image original pixels
22300 * @param h Height of region in image original pixels
22302 * This shows the region of the image using animation.
22304 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22306 * @brief Set the paused state for photocam
22308 * @param obj The photocam object
22309 * @param paused The pause state to set
22311 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22312 * photocam. The default is off. This will stop zooming using animation on
22313 * zoom levels changes and change instantly. This will stop any existing
22314 * animations that are running.
22316 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22318 * @brief Get the paused state for photocam
22320 * @param obj The photocam object
22321 * @return The current paused state
22323 * This gets the current paused state for the photocam object.
22325 * @see elm_photocam_paused_set()
22327 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22329 * @brief Get the internal low-res image used for photocam
22331 * @param obj The photocam object
22332 * @return The internal image object handle, or NULL if none exists
22334 * This gets the internal image object inside photocam. Do not modify it. It
22335 * is for inspection only, and hooking callbacks to. Nothing else. It may be
22336 * deleted at any time as well.
22338 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22340 * @brief Set the photocam scrolling bouncing.
22342 * @param obj The photocam object
22343 * @param h_bounce bouncing for horizontal
22344 * @param v_bounce bouncing for vertical
22346 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22348 * @brief Get the photocam scrolling bouncing.
22350 * @param obj The photocam object
22351 * @param h_bounce bouncing for horizontal
22352 * @param v_bounce bouncing for vertical
22354 * @see elm_photocam_bounce_set()
22356 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22362 * @defgroup Map Map
22363 * @ingroup Elementary
22365 * @image html img/widget/map/preview-00.png
22366 * @image latex img/widget/map/preview-00.eps
22368 * This is a widget specifically for displaying a map. It uses basically
22369 * OpenStreetMap provider http://www.openstreetmap.org/,
22370 * but custom providers can be added.
22372 * It supports some basic but yet nice features:
22373 * @li zoom and scroll
22374 * @li markers with content to be displayed when user clicks over it
22375 * @li group of markers
22378 * Smart callbacks one can listen to:
22380 * - "clicked" - This is called when a user has clicked the map without
22382 * - "press" - This is called when a user has pressed down on the map.
22383 * - "longpressed" - This is called when a user has pressed down on the map
22384 * for a long time without dragging around.
22385 * - "clicked,double" - This is called when a user has double-clicked
22387 * - "load,detail" - Map detailed data load begins.
22388 * - "loaded,detail" - This is called when all currently visible parts of
22389 * the map are loaded.
22390 * - "zoom,start" - Zoom animation started.
22391 * - "zoom,stop" - Zoom animation stopped.
22392 * - "zoom,change" - Zoom changed when using an auto zoom mode.
22393 * - "scroll" - the content has been scrolled (moved).
22394 * - "scroll,anim,start" - scrolling animation has started.
22395 * - "scroll,anim,stop" - scrolling animation has stopped.
22396 * - "scroll,drag,start" - dragging the contents around has started.
22397 * - "scroll,drag,stop" - dragging the contents around has stopped.
22398 * - "downloaded" - This is called when all currently required map images
22400 * - "route,load" - This is called when route request begins.
22401 * - "route,loaded" - This is called when route request ends.
22402 * - "name,load" - This is called when name request begins.
22403 * - "name,loaded- This is called when name request ends.
22405 * Available style for map widget:
22408 * Available style for markers:
22413 * Available style for marker bubble:
22416 * List of examples:
22417 * @li @ref map_example_01
22418 * @li @ref map_example_02
22419 * @li @ref map_example_03
22428 * @enum _Elm_Map_Zoom_Mode
22429 * @typedef Elm_Map_Zoom_Mode
22431 * Set map's zoom behavior. It can be set to manual or automatic.
22433 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22435 * Values <b> don't </b> work as bitmask, only one can be choosen.
22437 * @note Valid sizes are 2^zoom, consequently the map may be smaller
22438 * than the scroller view.
22440 * @see elm_map_zoom_mode_set()
22441 * @see elm_map_zoom_mode_get()
22445 typedef enum _Elm_Map_Zoom_Mode
22447 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22448 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22449 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22450 ELM_MAP_ZOOM_MODE_LAST
22451 } Elm_Map_Zoom_Mode;
22454 * @enum _Elm_Map_Route_Sources
22455 * @typedef Elm_Map_Route_Sources
22457 * Set route service to be used. By default used source is
22458 * #ELM_MAP_ROUTE_SOURCE_YOURS.
22460 * @see elm_map_route_source_set()
22461 * @see elm_map_route_source_get()
22465 typedef enum _Elm_Map_Route_Sources
22467 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22468 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. */
22469 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22470 ELM_MAP_ROUTE_SOURCE_LAST
22471 } Elm_Map_Route_Sources;
22473 typedef enum _Elm_Map_Name_Sources
22475 ELM_MAP_NAME_SOURCE_NOMINATIM,
22476 ELM_MAP_NAME_SOURCE_LAST
22477 } Elm_Map_Name_Sources;
22480 * @enum _Elm_Map_Route_Type
22481 * @typedef Elm_Map_Route_Type
22483 * Set type of transport used on route.
22485 * @see elm_map_route_add()
22489 typedef enum _Elm_Map_Route_Type
22491 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22492 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22493 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22494 ELM_MAP_ROUTE_TYPE_LAST
22495 } Elm_Map_Route_Type;
22498 * @enum _Elm_Map_Route_Method
22499 * @typedef Elm_Map_Route_Method
22501 * Set the routing method, what should be priorized, time or distance.
22503 * @see elm_map_route_add()
22507 typedef enum _Elm_Map_Route_Method
22509 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22510 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22511 ELM_MAP_ROUTE_METHOD_LAST
22512 } Elm_Map_Route_Method;
22514 typedef enum _Elm_Map_Name_Method
22516 ELM_MAP_NAME_METHOD_SEARCH,
22517 ELM_MAP_NAME_METHOD_REVERSE,
22518 ELM_MAP_NAME_METHOD_LAST
22519 } Elm_Map_Name_Method;
22521 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(). */
22522 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(). */
22523 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(). */
22524 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(). */
22525 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
22526 typedef struct _Elm_Map_Track Elm_Map_Track;
22528 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. */
22529 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22530 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22531 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22533 typedef char *(*ElmMapModuleSourceFunc) (void);
22534 typedef int (*ElmMapModuleZoomMinFunc) (void);
22535 typedef int (*ElmMapModuleZoomMaxFunc) (void);
22536 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22537 typedef int (*ElmMapModuleRouteSourceFunc) (void);
22538 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22539 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22540 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22541 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22544 * Add a new map widget to the given parent Elementary (container) object.
22546 * @param parent The parent object.
22547 * @return a new map widget handle or @c NULL, on errors.
22549 * This function inserts a new map widget on the canvas.
22553 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22556 * Set the zoom level of the map.
22558 * @param obj The map object.
22559 * @param zoom The zoom level to set.
22561 * This sets the zoom level.
22563 * It will respect limits defined by elm_map_source_zoom_min_set() and
22564 * elm_map_source_zoom_max_set().
22566 * By default these values are 0 (world map) and 18 (maximum zoom).
22568 * This function should be used when zoom mode is set to
22569 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22570 * with elm_map_zoom_mode_set().
22572 * @see elm_map_zoom_mode_set().
22573 * @see elm_map_zoom_get().
22577 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22580 * Get the zoom level of the map.
22582 * @param obj The map object.
22583 * @return The current zoom level.
22585 * This returns the current zoom level of the map object.
22587 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22588 * (which is the default), the zoom level may be changed at any time by the
22589 * map object itself to account for map size and map viewport size.
22591 * @see elm_map_zoom_set() for details.
22595 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22598 * Set the zoom mode used by the map object.
22600 * @param obj The map object.
22601 * @param mode The zoom mode of the map, being it one of
22602 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22603 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22605 * This sets the zoom mode to manual or one of the automatic levels.
22606 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22607 * elm_map_zoom_set() and will stay at that level until changed by code
22608 * or until zoom mode is changed. This is the default mode.
22610 * The Automatic modes will allow the map object to automatically
22611 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22612 * adjust zoom so the map fits inside the scroll frame with no pixels
22613 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22614 * ensure no pixels within the frame are left unfilled. Do not forget that
22615 * the valid sizes are 2^zoom, consequently the map may be smaller than
22616 * the scroller view.
22618 * @see elm_map_zoom_set()
22622 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22625 * Get the zoom mode used by the map object.
22627 * @param obj The map object.
22628 * @return The zoom mode of the map, being it one of
22629 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22630 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22632 * This function returns the current zoom mode used by the map object.
22634 * @see elm_map_zoom_mode_set() for more details.
22638 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22641 * Get the current coordinates of the map.
22643 * @param obj The map object.
22644 * @param lon Pointer where to store longitude.
22645 * @param lat Pointer where to store latitude.
22647 * This gets the current center coordinates of the map object. It can be
22648 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22650 * @see elm_map_geo_region_bring_in()
22651 * @see elm_map_geo_region_show()
22655 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22658 * Animatedly bring in given coordinates to the center of the map.
22660 * @param obj The map object.
22661 * @param lon Longitude to center at.
22662 * @param lat Latitude to center at.
22664 * This causes map to jump to the given @p lat and @p lon coordinates
22665 * and show it (by scrolling) in the center of the viewport, if it is not
22666 * already centered. This will use animation to do so and take a period
22667 * of time to complete.
22669 * @see elm_map_geo_region_show() for a function to avoid animation.
22670 * @see elm_map_geo_region_get()
22674 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22677 * Show the given coordinates at the center of the map, @b immediately.
22679 * @param obj The map object.
22680 * @param lon Longitude to center at.
22681 * @param lat Latitude to center at.
22683 * This causes map to @b redraw its viewport's contents to the
22684 * region contining the given @p lat and @p lon, that will be moved to the
22685 * center of the map.
22687 * @see elm_map_geo_region_bring_in() for a function to move with animation.
22688 * @see elm_map_geo_region_get()
22692 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22695 * Pause or unpause the map.
22697 * @param obj The map object.
22698 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22701 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22704 * The default is off.
22706 * This will stop zooming using animation, changing zoom levels will
22707 * change instantly. This will stop any existing animations that are running.
22709 * @see elm_map_paused_get()
22713 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22716 * Get a value whether map is paused or not.
22718 * @param obj The map object.
22719 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22720 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22722 * This gets the current paused state for the map object.
22724 * @see elm_map_paused_set() for details.
22728 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22731 * Set to show markers during zoom level changes or not.
22733 * @param obj The map object.
22734 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22737 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22740 * The default is off.
22742 * This will stop zooming using animation, changing zoom levels will
22743 * change instantly. This will stop any existing animations that are running.
22745 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22748 * The default is off.
22750 * Enabling it will force the map to stop displaying the markers during
22751 * zoom level changes. Set to on if you have a large number of markers.
22753 * @see elm_map_paused_markers_get()
22757 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22760 * Get a value whether markers will be displayed on zoom level changes or not
22762 * @param obj The map object.
22763 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22764 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22766 * This gets the current markers paused state for the map object.
22768 * @see elm_map_paused_markers_set() for details.
22772 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22775 * Get the information of downloading status.
22777 * @param obj The map object.
22778 * @param try_num Pointer where to store number of tiles being downloaded.
22779 * @param finish_num Pointer where to store number of tiles successfully
22782 * This gets the current downloading status for the map object, the number
22783 * of tiles being downloaded and the number of tiles already downloaded.
22787 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22790 * Convert a pixel coordinate (x,y) into a geographic coordinate
22791 * (longitude, latitude).
22793 * @param obj The map object.
22794 * @param x the coordinate.
22795 * @param y the coordinate.
22796 * @param size the size in pixels of the map.
22797 * The map is a square and generally his size is : pow(2.0, zoom)*256.
22798 * @param lon Pointer where to store the longitude that correspond to x.
22799 * @param lat Pointer where to store the latitude that correspond to y.
22801 * @note Origin pixel point is the top left corner of the viewport.
22802 * Map zoom and size are taken on account.
22804 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22808 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);
22811 * Convert a geographic coordinate (longitude, latitude) into a pixel
22812 * coordinate (x, y).
22814 * @param obj The map object.
22815 * @param lon the longitude.
22816 * @param lat the latitude.
22817 * @param size the size in pixels of the map. The map is a square
22818 * and generally his size is : pow(2.0, zoom)*256.
22819 * @param x Pointer where to store the horizontal pixel coordinate that
22820 * correspond to the longitude.
22821 * @param y Pointer where to store the vertical pixel coordinate that
22822 * correspond to the latitude.
22824 * @note Origin pixel point is the top left corner of the viewport.
22825 * Map zoom and size are taken on account.
22827 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22831 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);
22834 * Convert a geographic coordinate (longitude, latitude) into a name
22837 * @param obj The map object.
22838 * @param lon the longitude.
22839 * @param lat the latitude.
22840 * @return name A #Elm_Map_Name handle for this coordinate.
22842 * To get the string for this address, elm_map_name_address_get()
22845 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
22849 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22852 * Convert a name (address) into a geographic coordinate
22853 * (longitude, latitude).
22855 * @param obj The map object.
22856 * @param name The address.
22857 * @return name A #Elm_Map_Name handle for this address.
22859 * To get the longitude and latitude, elm_map_name_region_get()
22862 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
22866 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
22869 * Convert a pixel coordinate into a rotated pixel coordinate.
22871 * @param obj The map object.
22872 * @param x horizontal coordinate of the point to rotate.
22873 * @param y vertical coordinate of the point to rotate.
22874 * @param cx rotation's center horizontal position.
22875 * @param cy rotation's center vertical position.
22876 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
22877 * @param xx Pointer where to store rotated x.
22878 * @param yy Pointer where to store rotated y.
22882 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);
22885 * Add a new marker to the map object.
22887 * @param obj The map object.
22888 * @param lon The longitude of the marker.
22889 * @param lat The latitude of the marker.
22890 * @param clas The class, to use when marker @b isn't grouped to others.
22891 * @param clas_group The class group, to use when marker is grouped to others
22892 * @param data The data passed to the callbacks.
22894 * @return The created marker or @c NULL upon failure.
22896 * A marker will be created and shown in a specific point of the map, defined
22897 * by @p lon and @p lat.
22899 * It will be displayed using style defined by @p class when this marker
22900 * is displayed alone (not grouped). A new class can be created with
22901 * elm_map_marker_class_new().
22903 * If the marker is grouped to other markers, it will be displayed with
22904 * style defined by @p class_group. Markers with the same group are grouped
22905 * if they are close. A new group class can be created with
22906 * elm_map_marker_group_class_new().
22908 * Markers created with this method can be deleted with
22909 * elm_map_marker_remove().
22911 * A marker can have associated content to be displayed by a bubble,
22912 * when a user click over it, as well as an icon. These objects will
22913 * be fetch using class' callback functions.
22915 * @see elm_map_marker_class_new()
22916 * @see elm_map_marker_group_class_new()
22917 * @see elm_map_marker_remove()
22921 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);
22924 * Set the maximum numbers of markers' content to be displayed in a group.
22926 * @param obj The map object.
22927 * @param max The maximum numbers of items displayed in a bubble.
22929 * A bubble will be displayed when the user clicks over the group,
22930 * and will place the content of markers that belong to this group
22933 * A group can have a long list of markers, consequently the creation
22934 * of the content of the bubble can be very slow.
22936 * In order to avoid this, a maximum number of items is displayed
22939 * By default this number is 30.
22941 * Marker with the same group class are grouped if they are close.
22943 * @see elm_map_marker_add()
22947 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
22950 * Remove a marker from the map.
22952 * @param marker The marker to remove.
22954 * @see elm_map_marker_add()
22958 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22961 * Get the current coordinates of the marker.
22963 * @param marker marker.
22964 * @param lat Pointer where to store the marker's latitude.
22965 * @param lon Pointer where to store the marker's longitude.
22967 * These values are set when adding markers, with function
22968 * elm_map_marker_add().
22970 * @see elm_map_marker_add()
22974 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
22977 * Animatedly bring in given marker to the center of the map.
22979 * @param marker The marker to center at.
22981 * This causes map to jump to the given @p marker's coordinates
22982 * and show it (by scrolling) in the center of the viewport, if it is not
22983 * already centered. This will use animation to do so and take a period
22984 * of time to complete.
22986 * @see elm_map_marker_show() for a function to avoid animation.
22987 * @see elm_map_marker_region_get()
22991 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22994 * Show the given marker at the center of the map, @b immediately.
22996 * @param marker The marker to center at.
22998 * This causes map to @b redraw its viewport's contents to the
22999 * region contining the given @p marker's coordinates, that will be
23000 * moved to the center of the map.
23002 * @see elm_map_marker_bring_in() for a function to move with animation.
23003 * @see elm_map_markers_list_show() if more than one marker need to be
23005 * @see elm_map_marker_region_get()
23009 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23012 * Move and zoom the map to display a list of markers.
23014 * @param markers A list of #Elm_Map_Marker handles.
23016 * The map will be centered on the center point of the markers in the list.
23017 * Then the map will be zoomed in order to fit the markers using the maximum
23018 * zoom which allows display of all the markers.
23020 * @warning All the markers should belong to the same map object.
23022 * @see elm_map_marker_show() to show a single marker.
23023 * @see elm_map_marker_bring_in()
23027 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
23030 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
23032 * @param marker The marker wich content should be returned.
23033 * @return Return the evas object if it exists, else @c NULL.
23035 * To set callback function #ElmMapMarkerGetFunc for the marker class,
23036 * elm_map_marker_class_get_cb_set() should be used.
23038 * This content is what will be inside the bubble that will be displayed
23039 * when an user clicks over the marker.
23041 * This returns the actual Evas object used to be placed inside
23042 * the bubble. This may be @c NULL, as it may
23043 * not have been created or may have been deleted, at any time, by
23044 * the map. <b>Do not modify this object</b> (move, resize,
23045 * show, hide, etc.), as the map is controlling it. This
23046 * function is for querying, emitting custom signals or hooking
23047 * lower level callbacks for events on that object. Do not delete
23048 * this object under any circumstances.
23052 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23055 * Update the marker
23057 * @param marker The marker to be updated.
23059 * If a content is set to this marker, it will call function to delete it,
23060 * #ElmMapMarkerDelFunc, and then will fetch the content again with
23061 * #ElmMapMarkerGetFunc.
23063 * These functions are set for the marker class with
23064 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23068 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23071 * Close all the bubbles opened by the user.
23073 * @param obj The map object.
23075 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23076 * when the user clicks on a marker.
23078 * This functions is set for the marker class with
23079 * elm_map_marker_class_get_cb_set().
23083 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23086 * Create a new group class.
23088 * @param obj The map object.
23089 * @return Returns the new group class.
23091 * Each marker must be associated to a group class. Markers in the same
23092 * group are grouped if they are close.
23094 * The group class defines the style of the marker when a marker is grouped
23095 * to others markers. When it is alone, another class will be used.
23097 * A group class will need to be provided when creating a marker with
23098 * elm_map_marker_add().
23100 * Some properties and functions can be set by class, as:
23101 * - style, with elm_map_group_class_style_set()
23102 * - data - to be associated to the group class. It can be set using
23103 * elm_map_group_class_data_set().
23104 * - min zoom to display markers, set with
23105 * elm_map_group_class_zoom_displayed_set().
23106 * - max zoom to group markers, set using
23107 * elm_map_group_class_zoom_grouped_set().
23108 * - visibility - set if markers will be visible or not, set with
23109 * elm_map_group_class_hide_set().
23110 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23111 * It can be set using elm_map_group_class_icon_cb_set().
23113 * @see elm_map_marker_add()
23114 * @see elm_map_group_class_style_set()
23115 * @see elm_map_group_class_data_set()
23116 * @see elm_map_group_class_zoom_displayed_set()
23117 * @see elm_map_group_class_zoom_grouped_set()
23118 * @see elm_map_group_class_hide_set()
23119 * @see elm_map_group_class_icon_cb_set()
23123 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23126 * Set the marker's style of a group class.
23128 * @param clas The group class.
23129 * @param style The style to be used by markers.
23131 * Each marker must be associated to a group class, and will use the style
23132 * defined by such class when grouped to other markers.
23134 * The following styles are provided by default theme:
23135 * @li @c radio - blue circle
23136 * @li @c radio2 - green circle
23139 * @see elm_map_group_class_new() for more details.
23140 * @see elm_map_marker_add()
23144 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23147 * Set the icon callback function of a group class.
23149 * @param clas The group class.
23150 * @param icon_get The callback function that will return the icon.
23152 * Each marker must be associated to a group class, and it can display a
23153 * custom icon. The function @p icon_get must return this icon.
23155 * @see elm_map_group_class_new() for more details.
23156 * @see elm_map_marker_add()
23160 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23163 * Set the data associated to the group class.
23165 * @param clas The group class.
23166 * @param data The new user data.
23168 * This data will be passed for callback functions, like icon get callback,
23169 * that can be set with elm_map_group_class_icon_cb_set().
23171 * If a data was previously set, the object will lose the pointer for it,
23172 * so if needs to be freed, you must do it yourself.
23174 * @see elm_map_group_class_new() for more details.
23175 * @see elm_map_group_class_icon_cb_set()
23176 * @see elm_map_marker_add()
23180 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23183 * Set the minimum zoom from where the markers are displayed.
23185 * @param clas The group class.
23186 * @param zoom The minimum zoom.
23188 * Markers only will be displayed when the map is displayed at @p zoom
23191 * @see elm_map_group_class_new() for more details.
23192 * @see elm_map_marker_add()
23196 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23199 * Set the zoom from where the markers are no more grouped.
23201 * @param clas The group class.
23202 * @param zoom The maximum zoom.
23204 * Markers only will be grouped when the map is displayed at
23205 * less than @p zoom.
23207 * @see elm_map_group_class_new() for more details.
23208 * @see elm_map_marker_add()
23212 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23215 * Set if the markers associated to the group class @clas are hidden or not.
23217 * @param clas The group class.
23218 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23221 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23226 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23229 * Create a new marker class.
23231 * @param obj The map object.
23232 * @return Returns the new group class.
23234 * Each marker must be associated to a class.
23236 * The marker class defines the style of the marker when a marker is
23237 * displayed alone, i.e., not grouped to to others markers. When grouped
23238 * it will use group class style.
23240 * A marker class will need to be provided when creating a marker with
23241 * elm_map_marker_add().
23243 * Some properties and functions can be set by class, as:
23244 * - style, with elm_map_marker_class_style_set()
23245 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23246 * It can be set using elm_map_marker_class_icon_cb_set().
23247 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23248 * Set using elm_map_marker_class_get_cb_set().
23249 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23250 * Set using elm_map_marker_class_del_cb_set().
23252 * @see elm_map_marker_add()
23253 * @see elm_map_marker_class_style_set()
23254 * @see elm_map_marker_class_icon_cb_set()
23255 * @see elm_map_marker_class_get_cb_set()
23256 * @see elm_map_marker_class_del_cb_set()
23260 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23263 * Set the marker's style of a marker class.
23265 * @param clas The marker class.
23266 * @param style The style to be used by markers.
23268 * Each marker must be associated to a marker class, and will use the style
23269 * defined by such class when alone, i.e., @b not grouped to other markers.
23271 * The following styles are provided by default theme:
23276 * @see elm_map_marker_class_new() for more details.
23277 * @see elm_map_marker_add()
23281 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23284 * Set the icon callback function of a marker class.
23286 * @param clas The marker class.
23287 * @param icon_get The callback function that will return the icon.
23289 * Each marker must be associated to a marker class, and it can display a
23290 * custom icon. The function @p icon_get must return this icon.
23292 * @see elm_map_marker_class_new() for more details.
23293 * @see elm_map_marker_add()
23297 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23300 * Set the bubble content callback function of a marker class.
23302 * @param clas The marker class.
23303 * @param get The callback function that will return the content.
23305 * Each marker must be associated to a marker class, and it can display a
23306 * a content on a bubble that opens when the user click over the marker.
23307 * The function @p get must return this content object.
23309 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23312 * @see elm_map_marker_class_new() for more details.
23313 * @see elm_map_marker_class_del_cb_set()
23314 * @see elm_map_marker_add()
23318 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23321 * Set the callback function used to delete bubble content of a marker class.
23323 * @param clas The marker class.
23324 * @param del The callback function that will delete the content.
23326 * Each marker must be associated to a marker class, and it can display a
23327 * a content on a bubble that opens when the user click over the marker.
23328 * The function to return such content can be set with
23329 * elm_map_marker_class_get_cb_set().
23331 * If this content must be freed, a callback function need to be
23332 * set for that task with this function.
23334 * If this callback is defined it will have to delete (or not) the
23335 * object inside, but if the callback is not defined the object will be
23336 * destroyed with evas_object_del().
23338 * @see elm_map_marker_class_new() for more details.
23339 * @see elm_map_marker_class_get_cb_set()
23340 * @see elm_map_marker_add()
23344 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23347 * Get the list of available sources.
23349 * @param obj The map object.
23350 * @return The source names list.
23352 * It will provide a list with all available sources, that can be set as
23353 * current source with elm_map_source_name_set(), or get with
23354 * elm_map_source_name_get().
23356 * Available sources:
23362 * @see elm_map_source_name_set() for more details.
23363 * @see elm_map_source_name_get()
23367 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23370 * Set the source of the map.
23372 * @param obj The map object.
23373 * @param source The source to be used.
23375 * Map widget retrieves images that composes the map from a web service.
23376 * This web service can be set with this method.
23378 * A different service can return a different maps with different
23379 * information and it can use different zoom values.
23381 * The @p source_name need to match one of the names provided by
23382 * elm_map_source_names_get().
23384 * The current source can be get using elm_map_source_name_get().
23386 * @see elm_map_source_names_get()
23387 * @see elm_map_source_name_get()
23392 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23395 * Get the name of currently used source.
23397 * @param obj The map object.
23398 * @return Returns the name of the source in use.
23400 * @see elm_map_source_name_set() for more details.
23404 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23407 * Set the source of the route service to be used by the map.
23409 * @param obj The map object.
23410 * @param source The route service to be used, being it one of
23411 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23412 * and #ELM_MAP_ROUTE_SOURCE_ORS.
23414 * Each one has its own algorithm, so the route retrieved may
23415 * differ depending on the source route. Now, only the default is working.
23417 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23418 * http://www.yournavigation.org/.
23420 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23421 * assumptions. Its routing core is based on Contraction Hierarchies.
23423 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23425 * @see elm_map_route_source_get().
23429 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23432 * Get the current route source.
23434 * @param obj The map object.
23435 * @return The source of the route service used by the map.
23437 * @see elm_map_route_source_set() for details.
23441 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23444 * Set the minimum zoom of the source.
23446 * @param obj The map object.
23447 * @param zoom New minimum zoom value to be used.
23449 * By default, it's 0.
23453 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23456 * Get the minimum zoom of the source.
23458 * @param obj The map object.
23459 * @return Returns the minimum zoom of the source.
23461 * @see elm_map_source_zoom_min_set() for details.
23465 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23468 * Set the maximum zoom of the source.
23470 * @param obj The map object.
23471 * @param zoom New maximum zoom value to be used.
23473 * By default, it's 18.
23477 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23480 * Get the maximum zoom of the source.
23482 * @param obj The map object.
23483 * @return Returns the maximum zoom of the source.
23485 * @see elm_map_source_zoom_min_set() for details.
23489 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23492 * Set the user agent used by the map object to access routing services.
23494 * @param obj The map object.
23495 * @param user_agent The user agent to be used by the map.
23497 * User agent is a client application implementing a network protocol used
23498 * in communications within a clientāserver distributed computing system
23500 * The @p user_agent identification string will transmitted in a header
23501 * field @c User-Agent.
23503 * @see elm_map_user_agent_get()
23507 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23510 * Get the user agent used by the map object.
23512 * @param obj The map object.
23513 * @return The user agent identification string used by the map.
23515 * @see elm_map_user_agent_set() for details.
23519 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23522 * Add a new route to the map object.
23524 * @param obj The map object.
23525 * @param type The type of transport to be considered when tracing a route.
23526 * @param method The routing method, what should be priorized.
23527 * @param flon The start longitude.
23528 * @param flat The start latitude.
23529 * @param tlon The destination longitude.
23530 * @param tlat The destination latitude.
23532 * @return The created route or @c NULL upon failure.
23534 * A route will be traced by point on coordinates (@p flat, @p flon)
23535 * to point on coordinates (@p tlat, @p tlon), using the route service
23536 * set with elm_map_route_source_set().
23538 * It will take @p type on consideration to define the route,
23539 * depending if the user will be walking or driving, the route may vary.
23540 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23541 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23543 * Another parameter is what the route should priorize, the minor distance
23544 * or the less time to be spend on the route. So @p method should be one
23545 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23547 * Routes created with this method can be deleted with
23548 * elm_map_route_remove(), colored with elm_map_route_color_set(),
23549 * and distance can be get with elm_map_route_distance_get().
23551 * @see elm_map_route_remove()
23552 * @see elm_map_route_color_set()
23553 * @see elm_map_route_distance_get()
23554 * @see elm_map_route_source_set()
23558 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);
23561 * Remove a route from the map.
23563 * @param route The route to remove.
23565 * @see elm_map_route_add()
23569 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23572 * Set the route color.
23574 * @param route The route object.
23575 * @param r Red channel value, from 0 to 255.
23576 * @param g Green channel value, from 0 to 255.
23577 * @param b Blue channel value, from 0 to 255.
23578 * @param a Alpha channel value, from 0 to 255.
23580 * It uses an additive color model, so each color channel represents
23581 * how much of each primary colors must to be used. 0 represents
23582 * ausence of this color, so if all of the three are set to 0,
23583 * the color will be black.
23585 * These component values should be integers in the range 0 to 255,
23586 * (single 8-bit byte).
23588 * This sets the color used for the route. By default, it is set to
23589 * solid red (r = 255, g = 0, b = 0, a = 255).
23591 * For alpha channel, 0 represents completely transparent, and 255, opaque.
23593 * @see elm_map_route_color_get()
23597 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23600 * Get the route color.
23602 * @param route The route object.
23603 * @param r Pointer where to store the red channel value.
23604 * @param g Pointer where to store the green channel value.
23605 * @param b Pointer where to store the blue channel value.
23606 * @param a Pointer where to store the alpha channel value.
23608 * @see elm_map_route_color_set() for details.
23612 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23615 * Get the route distance in kilometers.
23617 * @param route The route object.
23618 * @return The distance of route (unit : km).
23622 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23625 * Get the information of route nodes.
23627 * @param route The route object.
23628 * @return Returns a string with the nodes of route.
23632 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23635 * Get the information of route waypoint.
23637 * @param route the route object.
23638 * @return Returns a string with information about waypoint of route.
23642 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23645 * Get the address of the name.
23647 * @param name The name handle.
23648 * @return Returns the address string of @p name.
23650 * This gets the coordinates of the @p name, created with one of the
23651 * conversion functions.
23653 * @see elm_map_utils_convert_name_into_coord()
23654 * @see elm_map_utils_convert_coord_into_name()
23658 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23661 * Get the current coordinates of the name.
23663 * @param name The name handle.
23664 * @param lat Pointer where to store the latitude.
23665 * @param lon Pointer where to store The longitude.
23667 * This gets the coordinates of the @p name, created with one of the
23668 * conversion functions.
23670 * @see elm_map_utils_convert_name_into_coord()
23671 * @see elm_map_utils_convert_coord_into_name()
23675 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23678 * Remove a name from the map.
23680 * @param name The name to remove.
23682 * Basically the struct handled by @p name will be freed, so convertions
23683 * between address and coordinates will be lost.
23685 * @see elm_map_utils_convert_name_into_coord()
23686 * @see elm_map_utils_convert_coord_into_name()
23690 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23695 * @param obj The map object.
23696 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23697 * @param cx Rotation's center horizontal position.
23698 * @param cy Rotation's center vertical position.
23700 * @see elm_map_rotate_get()
23704 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23707 * Get the rotate degree of the map
23709 * @param obj The map object
23710 * @param degree Pointer where to store degrees from 0.0 to 360.0
23711 * to rotate arount Z axis.
23712 * @param cx Pointer where to store rotation's center horizontal position.
23713 * @param cy Pointer where to store rotation's center vertical position.
23715 * @see elm_map_rotate_set() to set map rotation.
23719 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);
23722 * Enable or disable mouse wheel to be used to zoom in / out the map.
23724 * @param obj The map object.
23725 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23728 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23730 * It's disabled by default.
23732 * @see elm_map_wheel_disabled_get()
23736 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23739 * Get a value whether mouse wheel is enabled or not.
23741 * @param obj The map object.
23742 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23743 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23745 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23747 * @see elm_map_wheel_disabled_set() for details.
23751 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23755 * Add a track on the map
23757 * @param obj The map object.
23758 * @param emap The emap route object.
23759 * @return The route object. This is an elm object of type Route.
23761 * @see elm_route_add() for details.
23765 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23769 * Remove a track from the map
23771 * @param obj The map object.
23772 * @param route The track to remove.
23776 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23783 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23785 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23787 EAPI double elm_route_lon_min_get(Evas_Object *obj);
23788 EAPI double elm_route_lat_min_get(Evas_Object *obj);
23789 EAPI double elm_route_lon_max_get(Evas_Object *obj);
23790 EAPI double elm_route_lat_max_get(Evas_Object *obj);
23794 * @defgroup Panel Panel
23796 * @image html img/widget/panel/preview-00.png
23797 * @image latex img/widget/panel/preview-00.eps
23799 * @brief A panel is a type of animated container that contains subobjects.
23800 * It can be expanded or contracted by clicking the button on it's edge.
23802 * Orientations are as follows:
23803 * @li ELM_PANEL_ORIENT_TOP
23804 * @li ELM_PANEL_ORIENT_LEFT
23805 * @li ELM_PANEL_ORIENT_RIGHT
23807 * To set/get/unset the content of the panel, you can use
23808 * elm_object_content_set/get/unset APIs.
23809 * Once the content object is set, a previously set one will be deleted.
23810 * If you want to keep that old content object, use the
23811 * elm_object_content_unset() function
23813 * @ref tutorial_panel shows one way to use this widget.
23816 typedef enum _Elm_Panel_Orient
23818 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23819 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23820 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23821 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23822 } Elm_Panel_Orient;
23824 * @brief Adds a panel object
23826 * @param parent The parent object
23828 * @return The panel object, or NULL on failure
23830 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23832 * @brief Sets the orientation of the panel
23834 * @param parent The parent object
23835 * @param orient The panel orientation. Can be one of the following:
23836 * @li ELM_PANEL_ORIENT_TOP
23837 * @li ELM_PANEL_ORIENT_LEFT
23838 * @li ELM_PANEL_ORIENT_RIGHT
23840 * Sets from where the panel will (dis)appear.
23842 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
23844 * @brief Get the orientation of the panel.
23846 * @param obj The panel object
23847 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
23849 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23851 * @brief Set the content of the panel.
23853 * @param obj The panel object
23854 * @param content The panel content
23856 * Once the content object is set, a previously set one will be deleted.
23857 * If you want to keep that old content object, use the
23858 * elm_panel_content_unset() function.
23860 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23862 * @brief Get the content of the panel.
23864 * @param obj The panel object
23865 * @return The content that is being used
23867 * Return the content object which is set for this widget.
23869 * @see elm_panel_content_set()
23871 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23873 * @brief Unset the content of the panel.
23875 * @param obj The panel object
23876 * @return The content that was being used
23878 * Unparent and return the content object which was set for this widget.
23880 * @see elm_panel_content_set()
23882 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23884 * @brief Set the state of the panel.
23886 * @param obj The panel object
23887 * @param hidden If true, the panel will run the animation to contract
23889 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
23891 * @brief Get the state of the panel.
23893 * @param obj The panel object
23894 * @param hidden If true, the panel is in the "hide" state
23896 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23898 * @brief Toggle the hidden state of the panel from code
23900 * @param obj The panel object
23902 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
23908 * @defgroup Panes Panes
23909 * @ingroup Elementary
23911 * @image html img/widget/panes/preview-00.png
23912 * @image latex img/widget/panes/preview-00.eps width=\textwidth
23914 * @image html img/panes.png
23915 * @image latex img/panes.eps width=\textwidth
23917 * The panes adds a dragable bar between two contents. When dragged
23918 * this bar will resize contents size.
23920 * Panes can be displayed vertically or horizontally, and contents
23921 * size proportion can be customized (homogeneous by default).
23923 * Smart callbacks one can listen to:
23924 * - "press" - The panes has been pressed (button wasn't released yet).
23925 * - "unpressed" - The panes was released after being pressed.
23926 * - "clicked" - The panes has been clicked>
23927 * - "clicked,double" - The panes has been double clicked
23929 * Available styles for it:
23932 * Default contents parts of the panes widget that you can use for are:
23933 * @li "elm.swallow.left" - A leftside content of the panes
23934 * @li "elm.swallow.right" - A rightside content of the panes
23936 * If panes is displayed vertically, left content will be displayed at
23939 * Here is an example on its usage:
23940 * @li @ref panes_example
23943 #define ELM_PANES_CONTENT_LEFT "elm.swallow.left"
23944 #define ELM_PANES_CONTENT_RIGHT "elm.swallow.right"
23947 * @addtogroup Panes
23952 * Add a new panes widget to the given parent Elementary
23953 * (container) object.
23955 * @param parent The parent object.
23956 * @return a new panes widget handle or @c NULL, on errors.
23958 * This function inserts a new panes widget on the canvas.
23962 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23965 * Set the left content of the panes widget.
23967 * @param obj The panes object.
23968 * @param content The new left content object.
23970 * Once the content object is set, a previously set one will be deleted.
23971 * If you want to keep that old content object, use the
23972 * elm_panes_content_left_unset() function.
23974 * If panes is displayed vertically, left content will be displayed at
23977 * @see elm_panes_content_left_get()
23978 * @see elm_panes_content_right_set() to set content on the other side.
23982 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23985 * Set the right content of the panes widget.
23987 * @param obj The panes object.
23988 * @param content The new right content object.
23990 * Once the content object is set, a previously set one will be deleted.
23991 * If you want to keep that old content object, use the
23992 * elm_panes_content_right_unset() function.
23994 * If panes is displayed vertically, left content will be displayed at
23997 * @see elm_panes_content_right_get()
23998 * @see elm_panes_content_left_set() to set content on the other side.
24002 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24005 * Get the left content of the panes.
24007 * @param obj The panes object.
24008 * @return The left content object that is being used.
24010 * Return the left content object which is set for this widget.
24012 * @see elm_panes_content_left_set() for details.
24016 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24019 * Get the right content of the panes.
24021 * @param obj The panes object
24022 * @return The right content object that is being used
24024 * Return the right content object which is set for this widget.
24026 * @see elm_panes_content_right_set() for details.
24030 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24033 * Unset the left content used for the panes.
24035 * @param obj The panes object.
24036 * @return The left content object that was being used.
24038 * Unparent and return the left content object which was set for this widget.
24040 * @see elm_panes_content_left_set() for details.
24041 * @see elm_panes_content_left_get().
24045 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24048 * Unset the right content used for the panes.
24050 * @param obj The panes object.
24051 * @return The right content object that was being used.
24053 * Unparent and return the right content object which was set for this
24056 * @see elm_panes_content_right_set() for details.
24057 * @see elm_panes_content_right_get().
24061 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24064 * Get the size proportion of panes widget's left side.
24066 * @param obj The panes object.
24067 * @return float value between 0.0 and 1.0 representing size proportion
24070 * @see elm_panes_content_left_size_set() for more details.
24074 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24077 * Set the size proportion of panes widget's left side.
24079 * @param obj The panes object.
24080 * @param size Value between 0.0 and 1.0 representing size proportion
24083 * By default it's homogeneous, i.e., both sides have the same size.
24085 * If something different is required, it can be set with this function.
24086 * For example, if the left content should be displayed over
24087 * 75% of the panes size, @p size should be passed as @c 0.75.
24088 * This way, right content will be resized to 25% of panes size.
24090 * If displayed vertically, left content is displayed at top, and
24091 * right content at bottom.
24093 * @note This proportion will change when user drags the panes bar.
24095 * @see elm_panes_content_left_size_get()
24099 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24102 * Set the orientation of a given panes widget.
24104 * @param obj The panes object.
24105 * @param horizontal Use @c EINA_TRUE to make @p obj to be
24106 * @b horizontal, @c EINA_FALSE to make it @b vertical.
24108 * Use this function to change how your panes is to be
24109 * disposed: vertically or horizontally.
24111 * By default it's displayed horizontally.
24113 * @see elm_panes_horizontal_get()
24117 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24120 * Retrieve the orientation of a given panes widget.
24122 * @param obj The panes object.
24123 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24124 * @c EINA_FALSE if it's @b vertical (and on errors).
24126 * @see elm_panes_horizontal_set() for more details.
24130 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24131 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24132 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24139 * @defgroup Flip Flip
24141 * @image html img/widget/flip/preview-00.png
24142 * @image latex img/widget/flip/preview-00.eps
24144 * This widget holds 2 content objects(Evas_Object): one on the front and one
24145 * on the back. It allows you to flip from front to back and vice-versa using
24146 * various animations.
24148 * If either the front or back contents are not set the flip will treat that
24149 * as transparent. So if you wore to set the front content but not the back,
24150 * and then call elm_flip_go() you would see whatever is below the flip.
24152 * For a list of supported animations see elm_flip_go().
24154 * Signals that you can add callbacks for are:
24155 * "animate,begin" - when a flip animation was started
24156 * "animate,done" - when a flip animation is finished
24158 * @ref tutorial_flip show how to use most of the API.
24162 typedef enum _Elm_Flip_Mode
24164 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24165 ELM_FLIP_ROTATE_X_CENTER_AXIS,
24166 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24167 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24168 ELM_FLIP_CUBE_LEFT,
24169 ELM_FLIP_CUBE_RIGHT,
24171 ELM_FLIP_CUBE_DOWN,
24172 ELM_FLIP_PAGE_LEFT,
24173 ELM_FLIP_PAGE_RIGHT,
24177 typedef enum _Elm_Flip_Interaction
24179 ELM_FLIP_INTERACTION_NONE,
24180 ELM_FLIP_INTERACTION_ROTATE,
24181 ELM_FLIP_INTERACTION_CUBE,
24182 ELM_FLIP_INTERACTION_PAGE
24183 } Elm_Flip_Interaction;
24184 typedef enum _Elm_Flip_Direction
24186 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24187 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24188 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24189 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24190 } Elm_Flip_Direction;
24192 * @brief Add a new flip to the parent
24194 * @param parent The parent object
24195 * @return The new object or NULL if it cannot be created
24197 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24199 * @brief Set the front content of the flip widget.
24201 * @param obj The flip object
24202 * @param content The new front content object
24204 * Once the content object is set, a previously set one will be deleted.
24205 * If you want to keep that old content object, use the
24206 * elm_flip_content_front_unset() function.
24208 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24210 * @brief Set the back content of the flip widget.
24212 * @param obj The flip object
24213 * @param content The new back content object
24215 * Once the content object is set, a previously set one will be deleted.
24216 * If you want to keep that old content object, use the
24217 * elm_flip_content_back_unset() function.
24219 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24221 * @brief Get the front content used for the flip
24223 * @param obj The flip object
24224 * @return The front content object that is being used
24226 * Return the front content object which is set for this widget.
24228 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24230 * @brief Get the back content used for the flip
24232 * @param obj The flip object
24233 * @return The back content object that is being used
24235 * Return the back content object which is set for this widget.
24237 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24239 * @brief Unset the front content used for the flip
24241 * @param obj The flip object
24242 * @return The front content object that was being used
24244 * Unparent and return the front content object which was set for this widget.
24246 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24248 * @brief Unset the back content used for the flip
24250 * @param obj The flip object
24251 * @return The back content object that was being used
24253 * Unparent and return the back content object which was set for this widget.
24255 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24257 * @brief Get flip front visibility state
24259 * @param obj The flip objct
24260 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24263 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24265 * @brief Set flip perspective
24267 * @param obj The flip object
24268 * @param foc The coordinate to set the focus on
24269 * @param x The X coordinate
24270 * @param y The Y coordinate
24272 * @warning This function currently does nothing.
24274 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24276 * @brief Runs the flip animation
24278 * @param obj The flip object
24279 * @param mode The mode type
24281 * Flips the front and back contents using the @p mode animation. This
24282 * efectively hides the currently visible content and shows the hidden one.
24284 * There a number of possible animations to use for the flipping:
24285 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24286 * around a horizontal axis in the middle of its height, the other content
24287 * is shown as the other side of the flip.
24288 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24289 * around a vertical axis in the middle of its width, the other content is
24290 * shown as the other side of the flip.
24291 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24292 * around a diagonal axis in the middle of its width, the other content is
24293 * shown as the other side of the flip.
24294 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24295 * around a diagonal axis in the middle of its height, the other content is
24296 * shown as the other side of the flip.
24297 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24298 * as if the flip was a cube, the other content is show as the right face of
24300 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24301 * right as if the flip was a cube, the other content is show as the left
24302 * face of the cube.
24303 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24304 * flip was a cube, the other content is show as the bottom face of the cube.
24305 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24306 * the flip was a cube, the other content is show as the upper face of the
24308 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24309 * if the flip was a book, the other content is shown as the page below that.
24310 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24311 * as if the flip was a book, the other content is shown as the page below
24313 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24314 * flip was a book, the other content is shown as the page below that.
24315 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24316 * flip was a book, the other content is shown as the page below that.
24318 * @image html elm_flip.png
24319 * @image latex elm_flip.eps width=\textwidth
24321 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24323 * @brief Set the interactive flip mode
24325 * @param obj The flip object
24326 * @param mode The interactive flip mode to use
24328 * This sets if the flip should be interactive (allow user to click and
24329 * drag a side of the flip to reveal the back page and cause it to flip).
24330 * By default a flip is not interactive. You may also need to set which
24331 * sides of the flip are "active" for flipping and how much space they use
24332 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24333 * and elm_flip_interacton_direction_hitsize_set()
24335 * The four avilable mode of interaction are:
24336 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24337 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24338 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24339 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24341 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24342 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24343 * happen, those can only be acheived with elm_flip_go();
24345 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24347 * @brief Get the interactive flip mode
24349 * @param obj The flip object
24350 * @return The interactive flip mode
24352 * Returns the interactive flip mode set by elm_flip_interaction_set()
24354 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24356 * @brief Set which directions of the flip respond to interactive flip
24358 * @param obj The flip object
24359 * @param dir The direction to change
24360 * @param enabled If that direction is enabled or not
24362 * By default all directions are disabled, so you may want to enable the
24363 * desired directions for flipping if you need interactive flipping. You must
24364 * call this function once for each direction that should be enabled.
24366 * @see elm_flip_interaction_set()
24368 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24370 * @brief Get the enabled state of that flip direction
24372 * @param obj The flip object
24373 * @param dir The direction to check
24374 * @return If that direction is enabled or not
24376 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24378 * @see elm_flip_interaction_set()
24380 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24382 * @brief Set the amount of the flip that is sensitive to interactive flip
24384 * @param obj The flip object
24385 * @param dir The direction to modify
24386 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24388 * Set the amount of the flip that is sensitive to interactive flip, with 0
24389 * representing no area in the flip and 1 representing the entire flip. There
24390 * is however a consideration to be made in that the area will never be
24391 * smaller than the finger size set(as set in your Elementary configuration).
24393 * @see elm_flip_interaction_set()
24395 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24397 * @brief Get the amount of the flip that is sensitive to interactive flip
24399 * @param obj The flip object
24400 * @param dir The direction to check
24401 * @return The size set for that direction
24403 * Returns the amount os sensitive area set by
24404 * elm_flip_interacton_direction_hitsize_set().
24406 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24411 /* scrolledentry */
24412 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24413 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24414 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24415 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24416 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24417 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24418 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24419 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24420 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24421 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24422 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24423 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24424 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24425 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24426 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24427 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24428 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24429 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24430 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24431 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24432 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24433 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24434 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24435 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24436 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24437 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24438 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24439 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24440 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24441 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24442 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24443 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24444 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24445 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24446 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24447 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);
24448 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24449 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24450 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);
24451 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24452 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);
24453 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24454 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24455 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24456 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24457 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24458 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24459 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24460 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24461 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);
24462 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);
24463 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);
24464 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);
24465 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);
24466 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);
24467 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24468 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24469 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24470 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24471 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24472 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24473 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24474 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
24475 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
24476 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
24477 EINA_DEPRECATED EAPI Ecore_IMF_Context *elm_scrolled_entry_imf_context_get(Evas_Object *obj);
24478 EINA_DEPRECATED EAPI void elm_scrolled_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
24479 EINA_DEPRECATED EAPI void elm_scrolled_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
24482 * @defgroup Conformant Conformant
24483 * @ingroup Elementary
24485 * @image html img/widget/conformant/preview-00.png
24486 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24488 * @image html img/conformant.png
24489 * @image latex img/conformant.eps width=\textwidth
24491 * The aim is to provide a widget that can be used in elementary apps to
24492 * account for space taken up by the indicator, virtual keypad & softkey
24493 * windows when running the illume2 module of E17.
24495 * So conformant content will be sized and positioned considering the
24496 * space required for such stuff, and when they popup, as a keyboard
24497 * shows when an entry is selected, conformant content won't change.
24499 * Available styles for it:
24502 * Default contents parts of the conformant widget that you can use for are:
24503 * @li "elm.swallow.content" - A content of the conformant
24505 * See how to use this widget in this example:
24506 * @ref conformant_example
24510 * @addtogroup Conformant
24515 * Add a new conformant widget to the given parent Elementary
24516 * (container) object.
24518 * @param parent The parent object.
24519 * @return A new conformant widget handle or @c NULL, on errors.
24521 * This function inserts a new conformant widget on the canvas.
24523 * @ingroup Conformant
24525 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24528 * Set the content of the conformant widget.
24530 * @param obj The conformant object.
24531 * @param content The content to be displayed by the conformant.
24533 * Content will be sized and positioned considering the space required
24534 * to display a virtual keyboard. So it won't fill all the conformant
24535 * size. This way is possible to be sure that content won't resize
24536 * or be re-positioned after the keyboard is displayed.
24538 * Once the content object is set, a previously set one will be deleted.
24539 * If you want to keep that old content object, use the
24540 * elm_object_content_unset() function.
24542 * @see elm_object_content_unset()
24543 * @see elm_object_content_get()
24545 * @ingroup Conformant
24547 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24550 * Get the content of the conformant widget.
24552 * @param obj The conformant object.
24553 * @return The content that is being used.
24555 * Return the content object which is set for this widget.
24556 * It won't be unparent from conformant. For that, use
24557 * elm_object_content_unset().
24559 * @see elm_object_content_set().
24560 * @see elm_object_content_unset()
24562 * @ingroup Conformant
24564 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24567 * Unset the content of the conformant widget.
24569 * @param obj The conformant object.
24570 * @return The content that was being used.
24572 * Unparent and return the content object which was set for this widget.
24574 * @see elm_object_content_set().
24576 * @ingroup Conformant
24578 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24581 * Returns the Evas_Object that represents the content area.
24583 * @param obj The conformant object.
24584 * @return The content area of the widget.
24586 * @ingroup Conformant
24588 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24595 * @defgroup Mapbuf Mapbuf
24596 * @ingroup Elementary
24598 * @image html img/widget/mapbuf/preview-00.png
24599 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24601 * This holds one content object and uses an Evas Map of transformation
24602 * points to be later used with this content. So the content will be
24603 * moved, resized, etc as a single image. So it will improve performance
24604 * when you have a complex interafce, with a lot of elements, and will
24605 * need to resize or move it frequently (the content object and its
24608 * To set/get/unset the content of the mapbuf, you can use
24609 * elm_object_content_set/get/unset APIs.
24610 * Once the content object is set, a previously set one will be deleted.
24611 * If you want to keep that old content object, use the
24612 * elm_object_content_unset() function.
24614 * To enable map, elm_mapbuf_enabled_set() should be used.
24616 * See how to use this widget in this example:
24617 * @ref mapbuf_example
24621 * @addtogroup Mapbuf
24626 * Add a new mapbuf widget to the given parent Elementary
24627 * (container) object.
24629 * @param parent The parent object.
24630 * @return A new mapbuf widget handle or @c NULL, on errors.
24632 * This function inserts a new mapbuf widget on the canvas.
24636 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24639 * Set the content of the mapbuf.
24641 * @param obj The mapbuf object.
24642 * @param content The content that will be filled in this mapbuf object.
24644 * Once the content object is set, a previously set one will be deleted.
24645 * If you want to keep that old content object, use the
24646 * elm_mapbuf_content_unset() function.
24648 * To enable map, elm_mapbuf_enabled_set() should be used.
24652 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24655 * Get the content of the mapbuf.
24657 * @param obj The mapbuf object.
24658 * @return The content that is being used.
24660 * Return the content object which is set for this widget.
24662 * @see elm_mapbuf_content_set() for details.
24666 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24669 * Unset the content of the mapbuf.
24671 * @param obj The mapbuf object.
24672 * @return The content that was being used.
24674 * Unparent and return the content object which was set for this widget.
24676 * @see elm_mapbuf_content_set() for details.
24680 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24683 * Enable or disable the map.
24685 * @param obj The mapbuf object.
24686 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24688 * This enables the map that is set or disables it. On enable, the object
24689 * geometry will be saved, and the new geometry will change (position and
24690 * size) to reflect the map geometry set.
24692 * Also, when enabled, alpha and smooth states will be used, so if the
24693 * content isn't solid, alpha should be enabled, for example, otherwise
24694 * a black retangle will fill the content.
24696 * When disabled, the stored map will be freed and geometry prior to
24697 * enabling the map will be restored.
24699 * It's disabled by default.
24701 * @see elm_mapbuf_alpha_set()
24702 * @see elm_mapbuf_smooth_set()
24706 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24709 * Get a value whether map is enabled or not.
24711 * @param obj The mapbuf object.
24712 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24713 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24715 * @see elm_mapbuf_enabled_set() for details.
24719 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24722 * Enable or disable smooth map rendering.
24724 * @param obj The mapbuf object.
24725 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24728 * This sets smoothing for map rendering. If the object is a type that has
24729 * its own smoothing settings, then both the smooth settings for this object
24730 * and the map must be turned off.
24732 * By default smooth maps are enabled.
24736 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24739 * Get a value whether smooth map rendering is enabled or not.
24741 * @param obj The mapbuf object.
24742 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24743 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24745 * @see elm_mapbuf_smooth_set() for details.
24749 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24752 * Set or unset alpha flag for map rendering.
24754 * @param obj The mapbuf object.
24755 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24758 * This sets alpha flag for map rendering. If the object is a type that has
24759 * its own alpha settings, then this will take precedence. Only image objects
24760 * have this currently. It stops alpha blending of the map area, and is
24761 * useful if you know the object and/or all sub-objects is 100% solid.
24763 * Alpha is enabled by default.
24767 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24770 * Get a value whether alpha blending is enabled or not.
24772 * @param obj The mapbuf object.
24773 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24774 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24776 * @see elm_mapbuf_alpha_set() for details.
24780 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24787 * @defgroup Flipselector Flip Selector
24789 * @image html img/widget/flipselector/preview-00.png
24790 * @image latex img/widget/flipselector/preview-00.eps
24792 * A flip selector is a widget to show a set of @b text items, one
24793 * at a time, with the same sheet switching style as the @ref Clock
24794 * "clock" widget, when one changes the current displaying sheet
24795 * (thus, the "flip" in the name).
24797 * User clicks to flip sheets which are @b held for some time will
24798 * make the flip selector to flip continuosly and automatically for
24799 * the user. The interval between flips will keep growing in time,
24800 * so that it helps the user to reach an item which is distant from
24801 * the current selection.
24803 * Smart callbacks one can register to:
24804 * - @c "selected" - when the widget's selected text item is changed
24805 * - @c "overflowed" - when the widget's current selection is changed
24806 * from the first item in its list to the last
24807 * - @c "underflowed" - when the widget's current selection is changed
24808 * from the last item in its list to the first
24810 * Available styles for it:
24813 * Here is an example on its usage:
24814 * @li @ref flipselector_example
24818 * @addtogroup Flipselector
24822 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
24825 * Add a new flip selector widget to the given parent Elementary
24826 * (container) widget
24828 * @param parent The parent object
24829 * @return a new flip selector widget handle or @c NULL, on errors
24831 * This function inserts a new flip selector widget on the canvas.
24833 * @ingroup Flipselector
24835 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24838 * Programmatically select the next item of a flip selector widget
24840 * @param obj The flipselector object
24842 * @note The selection will be animated. Also, if it reaches the
24843 * end of its list of member items, it will continue with the first
24846 * @ingroup Flipselector
24848 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24851 * Programmatically select the previous item of a flip selector
24854 * @param obj The flipselector object
24856 * @note The selection will be animated. Also, if it reaches the
24857 * beginning of its list of member items, it will continue with the
24858 * last one backwards.
24860 * @ingroup Flipselector
24862 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24865 * Append a (text) item to a flip selector widget
24867 * @param obj The flipselector object
24868 * @param label The (text) label of the new item
24869 * @param func Convenience callback function to take place when
24871 * @param data Data passed to @p func, above
24872 * @return A handle to the item added or @c NULL, on errors
24874 * The widget's list of labels to show will be appended with the
24875 * given value. If the user wishes so, a callback function pointer
24876 * can be passed, which will get called when this same item is
24879 * @note The current selection @b won't be modified by appending an
24880 * element to the list.
24882 * @note The maximum length of the text label is going to be
24883 * determined <b>by the widget's theme</b>. Strings larger than
24884 * that value are going to be @b truncated.
24886 * @ingroup Flipselector
24888 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24891 * Prepend a (text) item to a flip selector widget
24893 * @param obj The flipselector object
24894 * @param label The (text) label of the new item
24895 * @param func Convenience callback function to take place when
24897 * @param data Data passed to @p func, above
24898 * @return A handle to the item added or @c NULL, on errors
24900 * The widget's list of labels to show will be prepended with the
24901 * given value. If the user wishes so, a callback function pointer
24902 * can be passed, which will get called when this same item is
24905 * @note The current selection @b won't be modified by prepending
24906 * an element to the list.
24908 * @note The maximum length of the text label is going to be
24909 * determined <b>by the widget's theme</b>. Strings larger than
24910 * that value are going to be @b truncated.
24912 * @ingroup Flipselector
24914 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24917 * Get the internal list of items in a given flip selector widget.
24919 * @param obj The flipselector object
24920 * @return The list of items (#Elm_Flipselector_Item as data) or
24921 * @c NULL on errors.
24923 * This list is @b not to be modified in any way and must not be
24924 * freed. Use the list members with functions like
24925 * elm_flipselector_item_label_set(),
24926 * elm_flipselector_item_label_get(),
24927 * elm_flipselector_item_del(),
24928 * elm_flipselector_item_selected_get(),
24929 * elm_flipselector_item_selected_set().
24931 * @warning This list is only valid until @p obj object's internal
24932 * items list is changed. It should be fetched again with another
24933 * call to this function when changes happen.
24935 * @ingroup Flipselector
24937 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24940 * Get the first item in the given flip selector widget's list of
24943 * @param obj The flipselector object
24944 * @return The first item or @c NULL, if it has no items (and on
24947 * @see elm_flipselector_item_append()
24948 * @see elm_flipselector_last_item_get()
24950 * @ingroup Flipselector
24952 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24955 * Get the last item in the given flip selector widget's list of
24958 * @param obj The flipselector object
24959 * @return The last item or @c NULL, if it has no items (and on
24962 * @see elm_flipselector_item_prepend()
24963 * @see elm_flipselector_first_item_get()
24965 * @ingroup Flipselector
24967 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24970 * Get the currently selected item in a flip selector widget.
24972 * @param obj The flipselector object
24973 * @return The selected item or @c NULL, if the widget has no items
24976 * @ingroup Flipselector
24978 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24981 * Set whether a given flip selector widget's item should be the
24982 * currently selected one.
24984 * @param item The flip selector item
24985 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
24987 * This sets whether @p item is or not the selected (thus, under
24988 * display) one. If @p item is different than one under display,
24989 * the latter will be unselected. If the @p item is set to be
24990 * unselected, on the other hand, the @b first item in the widget's
24991 * internal members list will be the new selected one.
24993 * @see elm_flipselector_item_selected_get()
24995 * @ingroup Flipselector
24997 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
25000 * Get whether a given flip selector widget's item is the currently
25003 * @param item The flip selector item
25004 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
25007 * @see elm_flipselector_item_selected_set()
25009 * @ingroup Flipselector
25011 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25014 * Delete a given item from a flip selector widget.
25016 * @param item The item to delete
25018 * @ingroup Flipselector
25020 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25023 * Get the label of a given flip selector widget's item.
25025 * @param item The item to get label from
25026 * @return The text label of @p item or @c NULL, on errors
25028 * @see elm_flipselector_item_label_set()
25030 * @ingroup Flipselector
25032 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25035 * Set the label of a given flip selector widget's item.
25037 * @param item The item to set label on
25038 * @param label The text label string, in UTF-8 encoding
25040 * @see elm_flipselector_item_label_get()
25042 * @ingroup Flipselector
25044 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
25047 * Gets the item before @p item in a flip selector widget's
25048 * internal list of items.
25050 * @param item The item to fetch previous from
25051 * @return The item before the @p item, in its parent's list. If
25052 * there is no previous item for @p item or there's an
25053 * error, @c NULL is returned.
25055 * @see elm_flipselector_item_next_get()
25057 * @ingroup Flipselector
25059 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25062 * Gets the item after @p item in a flip selector widget's
25063 * internal list of items.
25065 * @param item The item to fetch next from
25066 * @return The item after the @p item, in its parent's list. If
25067 * there is no next item for @p item or there's an
25068 * error, @c NULL is returned.
25070 * @see elm_flipselector_item_next_get()
25072 * @ingroup Flipselector
25074 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25077 * Set the interval on time updates for an user mouse button hold
25078 * on a flip selector widget.
25080 * @param obj The flip selector object
25081 * @param interval The (first) interval value in seconds
25083 * This interval value is @b decreased while the user holds the
25084 * mouse pointer either flipping up or flipping doww a given flip
25087 * This helps the user to get to a given item distant from the
25088 * current one easier/faster, as it will start to flip quicker and
25089 * quicker on mouse button holds.
25091 * The calculation for the next flip interval value, starting from
25092 * the one set with this call, is the previous interval divided by
25093 * 1.05, so it decreases a little bit.
25095 * The default starting interval value for automatic flips is
25098 * @see elm_flipselector_interval_get()
25100 * @ingroup Flipselector
25102 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25105 * Get the interval on time updates for an user mouse button hold
25106 * on a flip selector widget.
25108 * @param obj The flip selector object
25109 * @return The (first) interval value, in seconds, set on it
25111 * @see elm_flipselector_interval_set() for more details
25113 * @ingroup Flipselector
25115 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25122 * @addtogroup Calendar
25127 * @enum _Elm_Calendar_Mark_Repeat
25128 * @typedef Elm_Calendar_Mark_Repeat
25130 * Event periodicity, used to define if a mark should be repeated
25131 * @b beyond event's day. It's set when a mark is added.
25133 * So, for a mark added to 13th May with periodicity set to WEEKLY,
25134 * there will be marks every week after this date. Marks will be displayed
25135 * at 13th, 20th, 27th, 3rd June ...
25137 * Values don't work as bitmask, only one can be choosen.
25139 * @see elm_calendar_mark_add()
25141 * @ingroup Calendar
25143 typedef enum _Elm_Calendar_Mark_Repeat
25145 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25146 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25147 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25148 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*/
25149 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. */
25150 } Elm_Calendar_Mark_Repeat;
25152 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(). */
25155 * Add a new calendar widget to the given parent Elementary
25156 * (container) object.
25158 * @param parent The parent object.
25159 * @return a new calendar widget handle or @c NULL, on errors.
25161 * This function inserts a new calendar widget on the canvas.
25163 * @ref calendar_example_01
25165 * @ingroup Calendar
25167 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25170 * Get weekdays names displayed by the calendar.
25172 * @param obj The calendar object.
25173 * @return Array of seven strings to be used as weekday names.
25175 * By default, weekdays abbreviations get from system are displayed:
25176 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25177 * The first string is related to Sunday, the second to Monday...
25179 * @see elm_calendar_weekdays_name_set()
25181 * @ref calendar_example_05
25183 * @ingroup Calendar
25185 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25188 * Set weekdays names to be displayed by the calendar.
25190 * @param obj The calendar object.
25191 * @param weekdays Array of seven strings to be used as weekday names.
25192 * @warning It must have 7 elements, or it will access invalid memory.
25193 * @warning The strings must be NULL terminated ('@\0').
25195 * By default, weekdays abbreviations get from system are displayed:
25196 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25198 * The first string should be related to Sunday, the second to Monday...
25200 * The usage should be like this:
25202 * const char *weekdays[] =
25204 * "Sunday", "Monday", "Tuesday", "Wednesday",
25205 * "Thursday", "Friday", "Saturday"
25207 * elm_calendar_weekdays_names_set(calendar, weekdays);
25210 * @see elm_calendar_weekdays_name_get()
25212 * @ref calendar_example_02
25214 * @ingroup Calendar
25216 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25219 * Set the minimum and maximum values for the year
25221 * @param obj The calendar object
25222 * @param min The minimum year, greater than 1901;
25223 * @param max The maximum year;
25225 * Maximum must be greater than minimum, except if you don't wan't to set
25227 * Default values are 1902 and -1.
25229 * If the maximum year is a negative value, it will be limited depending
25230 * on the platform architecture (year 2037 for 32 bits);
25232 * @see elm_calendar_min_max_year_get()
25234 * @ref calendar_example_03
25236 * @ingroup Calendar
25238 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25241 * Get the minimum and maximum values for the year
25243 * @param obj The calendar object.
25244 * @param min The minimum year.
25245 * @param max The maximum year.
25247 * Default values are 1902 and -1.
25249 * @see elm_calendar_min_max_year_get() for more details.
25251 * @ref calendar_example_05
25253 * @ingroup Calendar
25255 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25258 * Enable or disable day selection
25260 * @param obj The calendar object.
25261 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25264 * Enabled by default. If disabled, the user still can select months,
25265 * but not days. Selected days are highlighted on calendar.
25266 * It should be used if you won't need such selection for the widget usage.
25268 * When a day is selected, or month is changed, smart callbacks for
25269 * signal "changed" will be called.
25271 * @see elm_calendar_day_selection_enable_get()
25273 * @ref calendar_example_04
25275 * @ingroup Calendar
25277 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25280 * Get a value whether day selection is enabled or not.
25282 * @see elm_calendar_day_selection_enable_set() for details.
25284 * @param obj The calendar object.
25285 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25286 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25288 * @ref calendar_example_05
25290 * @ingroup Calendar
25292 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25296 * Set selected date to be highlighted on calendar.
25298 * @param obj The calendar object.
25299 * @param selected_time A @b tm struct to represent the selected date.
25301 * Set the selected date, changing the displayed month if needed.
25302 * Selected date changes when the user goes to next/previous month or
25303 * select a day pressing over it on calendar.
25305 * @see elm_calendar_selected_time_get()
25307 * @ref calendar_example_04
25309 * @ingroup Calendar
25311 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25314 * Get selected date.
25316 * @param obj The calendar object
25317 * @param selected_time A @b tm struct to point to selected date
25318 * @return EINA_FALSE means an error ocurred and returned time shouldn't
25321 * Get date selected by the user or set by function
25322 * elm_calendar_selected_time_set().
25323 * Selected date changes when the user goes to next/previous month or
25324 * select a day pressing over it on calendar.
25326 * @see elm_calendar_selected_time_get()
25328 * @ref calendar_example_05
25330 * @ingroup Calendar
25332 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25335 * Set a function to format the string that will be used to display
25338 * @param obj The calendar object
25339 * @param format_function Function to set the month-year string given
25340 * the selected date
25342 * By default it uses strftime with "%B %Y" format string.
25343 * It should allocate the memory that will be used by the string,
25344 * that will be freed by the widget after usage.
25345 * A pointer to the string and a pointer to the time struct will be provided.
25350 * _format_month_year(struct tm *selected_time)
25353 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25354 * return strdup(buf);
25357 * elm_calendar_format_function_set(calendar, _format_month_year);
25360 * @ref calendar_example_02
25362 * @ingroup Calendar
25364 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25367 * Add a new mark to the calendar
25369 * @param obj The calendar object
25370 * @param mark_type A string used to define the type of mark. It will be
25371 * emitted to the theme, that should display a related modification on these
25372 * days representation.
25373 * @param mark_time A time struct to represent the date of inclusion of the
25374 * mark. For marks that repeats it will just be displayed after the inclusion
25375 * date in the calendar.
25376 * @param repeat Repeat the event following this periodicity. Can be a unique
25377 * mark (that don't repeat), daily, weekly, monthly or annually.
25378 * @return The created mark or @p NULL upon failure.
25380 * Add a mark that will be drawn in the calendar respecting the insertion
25381 * time and periodicity. It will emit the type as signal to the widget theme.
25382 * Default theme supports "holiday" and "checked", but it can be extended.
25384 * It won't immediately update the calendar, drawing the marks.
25385 * For this, call elm_calendar_marks_draw(). However, when user selects
25386 * next or previous month calendar forces marks drawn.
25388 * Marks created with this method can be deleted with
25389 * elm_calendar_mark_del().
25393 * struct tm selected_time;
25394 * time_t current_time;
25396 * current_time = time(NULL) + 5 * 84600;
25397 * localtime_r(¤t_time, &selected_time);
25398 * elm_calendar_mark_add(cal, "holiday", selected_time,
25399 * ELM_CALENDAR_ANNUALLY);
25401 * current_time = time(NULL) + 1 * 84600;
25402 * localtime_r(¤t_time, &selected_time);
25403 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25405 * elm_calendar_marks_draw(cal);
25408 * @see elm_calendar_marks_draw()
25409 * @see elm_calendar_mark_del()
25411 * @ref calendar_example_06
25413 * @ingroup Calendar
25415 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);
25418 * Delete mark from the calendar.
25420 * @param mark The mark to be deleted.
25422 * If deleting all calendar marks is required, elm_calendar_marks_clear()
25423 * should be used instead of getting marks list and deleting each one.
25425 * @see elm_calendar_mark_add()
25427 * @ref calendar_example_06
25429 * @ingroup Calendar
25431 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25434 * Remove all calendar's marks
25436 * @param obj The calendar object.
25438 * @see elm_calendar_mark_add()
25439 * @see elm_calendar_mark_del()
25441 * @ingroup Calendar
25443 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25447 * Get a list of all the calendar marks.
25449 * @param obj The calendar object.
25450 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25452 * @see elm_calendar_mark_add()
25453 * @see elm_calendar_mark_del()
25454 * @see elm_calendar_marks_clear()
25456 * @ingroup Calendar
25458 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25461 * Draw calendar marks.
25463 * @param obj The calendar object.
25465 * Should be used after adding, removing or clearing marks.
25466 * It will go through the entire marks list updating the calendar.
25467 * If lots of marks will be added, add all the marks and then call
25470 * When the month is changed, i.e. user selects next or previous month,
25471 * marks will be drawed.
25473 * @see elm_calendar_mark_add()
25474 * @see elm_calendar_mark_del()
25475 * @see elm_calendar_marks_clear()
25477 * @ref calendar_example_06
25479 * @ingroup Calendar
25481 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25482 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25483 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25484 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25487 * Set a day text color to the same that represents Saturdays.
25489 * @param obj The calendar object.
25490 * @param pos The text position. Position is the cell counter, from left
25491 * to right, up to down. It starts on 0 and ends on 41.
25493 * @deprecated use elm_calendar_mark_add() instead like:
25496 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25497 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25500 * @see elm_calendar_mark_add()
25502 * @ingroup Calendar
25504 EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25507 * Set a day text color to the same that represents Sundays.
25509 * @param obj The calendar object.
25510 * @param pos The text position. Position is the cell counter, from left
25511 * to right, up to down. It starts on 0 and ends on 41.
25513 * @deprecated use elm_calendar_mark_add() instead like:
25516 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25517 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25520 * @see elm_calendar_mark_add()
25522 * @ingroup Calendar
25524 EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25527 * Set a day text color to the same that represents Weekdays.
25529 * @param obj The calendar object
25530 * @param pos The text position. Position is the cell counter, from left
25531 * to right, up to down. It starts on 0 and ends on 41.
25533 * @deprecated use elm_calendar_mark_add() instead like:
25536 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25538 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25539 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25540 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25541 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25542 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25543 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25544 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25545 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25546 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25549 * @see elm_calendar_mark_add()
25551 * @ingroup Calendar
25553 EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25556 * Set the interval on time updates for an user mouse button hold
25557 * on calendar widgets' month selection.
25559 * @param obj The calendar object
25560 * @param interval The (first) interval value in seconds
25562 * This interval value is @b decreased while the user holds the
25563 * mouse pointer either selecting next or previous month.
25565 * This helps the user to get to a given month distant from the
25566 * current one easier/faster, as it will start to change quicker and
25567 * quicker on mouse button holds.
25569 * The calculation for the next change interval value, starting from
25570 * the one set with this call, is the previous interval divided by
25571 * 1.05, so it decreases a little bit.
25573 * The default starting interval value for automatic changes is
25576 * @see elm_calendar_interval_get()
25578 * @ingroup Calendar
25580 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25583 * Get the interval on time updates for an user mouse button hold
25584 * on calendar widgets' month selection.
25586 * @param obj The calendar object
25587 * @return The (first) interval value, in seconds, set on it
25589 * @see elm_calendar_interval_set() for more details
25591 * @ingroup Calendar
25593 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25600 * @defgroup Diskselector Diskselector
25601 * @ingroup Elementary
25603 * @image html img/widget/diskselector/preview-00.png
25604 * @image latex img/widget/diskselector/preview-00.eps
25606 * A diskselector is a kind of list widget. It scrolls horizontally,
25607 * and can contain label and icon objects. Three items are displayed
25608 * with the selected one in the middle.
25610 * It can act like a circular list with round mode and labels can be
25611 * reduced for a defined length for side items.
25613 * Smart callbacks one can listen to:
25614 * - "selected" - when item is selected, i.e. scroller stops.
25616 * Available styles for it:
25619 * List of examples:
25620 * @li @ref diskselector_example_01
25621 * @li @ref diskselector_example_02
25625 * @addtogroup Diskselector
25629 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(). */
25632 * Add a new diskselector widget to the given parent Elementary
25633 * (container) object.
25635 * @param parent The parent object.
25636 * @return a new diskselector widget handle or @c NULL, on errors.
25638 * This function inserts a new diskselector widget on the canvas.
25640 * @ingroup Diskselector
25642 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25645 * Enable or disable round mode.
25647 * @param obj The diskselector object.
25648 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25651 * Disabled by default. If round mode is enabled the items list will
25652 * work like a circle list, so when the user reaches the last item,
25653 * the first one will popup.
25655 * @see elm_diskselector_round_get()
25657 * @ingroup Diskselector
25659 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25662 * Get a value whether round mode is enabled or not.
25664 * @see elm_diskselector_round_set() for details.
25666 * @param obj The diskselector object.
25667 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25668 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25670 * @ingroup Diskselector
25672 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25675 * Get the side labels max length.
25677 * @deprecated use elm_diskselector_side_label_length_get() instead:
25679 * @param obj The diskselector object.
25680 * @return The max length defined for side labels, or 0 if not a valid
25683 * @ingroup Diskselector
25685 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25688 * Set the side labels max length.
25690 * @deprecated use elm_diskselector_side_label_length_set() instead:
25692 * @param obj The diskselector object.
25693 * @param len The max length defined for side labels.
25695 * @ingroup Diskselector
25697 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25700 * Get the side labels max length.
25702 * @see elm_diskselector_side_label_length_set() for details.
25704 * @param obj The diskselector object.
25705 * @return The max length defined for side labels, or 0 if not a valid
25708 * @ingroup Diskselector
25710 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25713 * Set the side labels max length.
25715 * @param obj The diskselector object.
25716 * @param len The max length defined for side labels.
25718 * Length is the number of characters of items' label that will be
25719 * visible when it's set on side positions. It will just crop
25720 * the string after defined size. E.g.:
25722 * An item with label "January" would be displayed on side position as
25723 * "Jan" if max length is set to 3, or "Janu", if this property
25726 * When it's selected, the entire label will be displayed, except for
25727 * width restrictions. In this case label will be cropped and "..."
25728 * will be concatenated.
25730 * Default side label max length is 3.
25732 * This property will be applyed over all items, included before or
25733 * later this function call.
25735 * @ingroup Diskselector
25737 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25740 * Set the number of items to be displayed.
25742 * @param obj The diskselector object.
25743 * @param num The number of items the diskselector will display.
25745 * Default value is 3, and also it's the minimun. If @p num is less
25746 * than 3, it will be set to 3.
25748 * Also, it can be set on theme, using data item @c display_item_num
25749 * on group "elm/diskselector/item/X", where X is style set.
25752 * group { name: "elm/diskselector/item/X";
25754 * item: "display_item_num" "5";
25757 * @ingroup Diskselector
25759 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25762 * Get the number of items in the diskselector object.
25764 * @param obj The diskselector object.
25766 * @ingroup Diskselector
25768 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25771 * Set bouncing behaviour when the scrolled content reaches an edge.
25773 * Tell the internal scroller object whether it should bounce or not
25774 * when it reaches the respective edges for each axis.
25776 * @param obj The diskselector object.
25777 * @param h_bounce Whether to bounce or not in the horizontal axis.
25778 * @param v_bounce Whether to bounce or not in the vertical axis.
25780 * @see elm_scroller_bounce_set()
25782 * @ingroup Diskselector
25784 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25787 * Get the bouncing behaviour of the internal scroller.
25789 * Get whether the internal scroller should bounce when the edge of each
25790 * axis is reached scrolling.
25792 * @param obj The diskselector object.
25793 * @param h_bounce Pointer where to store the bounce state of the horizontal
25795 * @param v_bounce Pointer where to store the bounce state of the vertical
25798 * @see elm_scroller_bounce_get()
25799 * @see elm_diskselector_bounce_set()
25801 * @ingroup Diskselector
25803 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25806 * Get the scrollbar policy.
25808 * @see elm_diskselector_scroller_policy_get() for details.
25810 * @param obj The diskselector object.
25811 * @param policy_h Pointer where to store horizontal scrollbar policy.
25812 * @param policy_v Pointer where to store vertical scrollbar policy.
25814 * @ingroup Diskselector
25816 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);
25819 * Set the scrollbar policy.
25821 * @param obj The diskselector object.
25822 * @param policy_h Horizontal scrollbar policy.
25823 * @param policy_v Vertical scrollbar policy.
25825 * This sets the scrollbar visibility policy for the given scroller.
25826 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
25827 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
25828 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
25829 * This applies respectively for the horizontal and vertical scrollbars.
25831 * The both are disabled by default, i.e., are set to
25832 * #ELM_SCROLLER_POLICY_OFF.
25834 * @ingroup Diskselector
25836 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
25839 * Remove all diskselector's items.
25841 * @param obj The diskselector object.
25843 * @see elm_diskselector_item_del()
25844 * @see elm_diskselector_item_append()
25846 * @ingroup Diskselector
25848 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25851 * Get a list of all the diskselector items.
25853 * @param obj The diskselector object.
25854 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
25855 * or @c NULL on failure.
25857 * @see elm_diskselector_item_append()
25858 * @see elm_diskselector_item_del()
25859 * @see elm_diskselector_clear()
25861 * @ingroup Diskselector
25863 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25866 * Appends a new item to the diskselector object.
25868 * @param obj The diskselector object.
25869 * @param label The label of the diskselector item.
25870 * @param icon The icon object to use at left side of the item. An
25871 * icon can be any Evas object, but usually it is an icon created
25872 * with elm_icon_add().
25873 * @param func The function to call when the item is selected.
25874 * @param data The data to associate with the item for related callbacks.
25876 * @return The created item or @c NULL upon failure.
25878 * A new item will be created and appended to the diskselector, i.e., will
25879 * be set as last item. Also, if there is no selected item, it will
25880 * be selected. This will always happens for the first appended item.
25882 * If no icon is set, label will be centered on item position, otherwise
25883 * the icon will be placed at left of the label, that will be shifted
25886 * Items created with this method can be deleted with
25887 * elm_diskselector_item_del().
25889 * Associated @p data can be properly freed when item is deleted if a
25890 * callback function is set with elm_diskselector_item_del_cb_set().
25892 * If a function is passed as argument, it will be called everytime this item
25893 * is selected, i.e., the user stops the diskselector with this
25894 * item on center position. If such function isn't needed, just passing
25895 * @c NULL as @p func is enough. The same should be done for @p data.
25897 * Simple example (with no function callback or data associated):
25899 * disk = elm_diskselector_add(win);
25900 * ic = elm_icon_add(win);
25901 * elm_icon_file_set(ic, "path/to/image", NULL);
25902 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25903 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
25906 * @see elm_diskselector_item_del()
25907 * @see elm_diskselector_item_del_cb_set()
25908 * @see elm_diskselector_clear()
25909 * @see elm_icon_add()
25911 * @ingroup Diskselector
25913 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);
25917 * Delete them item from the diskselector.
25919 * @param it The item of diskselector to be deleted.
25921 * If deleting all diskselector items is required, elm_diskselector_clear()
25922 * should be used instead of getting items list and deleting each one.
25924 * @see elm_diskselector_clear()
25925 * @see elm_diskselector_item_append()
25926 * @see elm_diskselector_item_del_cb_set()
25928 * @ingroup Diskselector
25930 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25933 * Set the function called when a diskselector item is freed.
25935 * @param it The item to set the callback on
25936 * @param func The function called
25938 * If there is a @p func, then it will be called prior item's memory release.
25939 * That will be called with the following arguments:
25941 * @li item's Evas object;
25944 * This way, a data associated to a diskselector item could be properly
25947 * @ingroup Diskselector
25949 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
25952 * Get the data associated to the item.
25954 * @param it The diskselector item
25955 * @return The data associated to @p it
25957 * The return value is a pointer to data associated to @p item when it was
25958 * created, with function elm_diskselector_item_append(). If no data
25959 * was passed as argument, it will return @c NULL.
25961 * @see elm_diskselector_item_append()
25963 * @ingroup Diskselector
25965 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25968 * Set the icon associated to the item.
25970 * @param it The diskselector item
25971 * @param icon The icon object to associate with @p it
25973 * The icon object to use at left side of the item. An
25974 * icon can be any Evas object, but usually it is an icon created
25975 * with elm_icon_add().
25977 * Once the icon object is set, a previously set one will be deleted.
25978 * @warning Setting the same icon for two items will cause the icon to
25979 * dissapear from the first item.
25981 * If an icon was passed as argument on item creation, with function
25982 * elm_diskselector_item_append(), it will be already
25983 * associated to the item.
25985 * @see elm_diskselector_item_append()
25986 * @see elm_diskselector_item_icon_get()
25988 * @ingroup Diskselector
25990 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
25993 * Get the icon associated to the item.
25995 * @param it The diskselector item
25996 * @return The icon associated to @p it
25998 * The return value is a pointer to the icon associated to @p item when it was
25999 * created, with function elm_diskselector_item_append(), or later
26000 * with function elm_diskselector_item_icon_set. If no icon
26001 * was passed as argument, it will return @c NULL.
26003 * @see elm_diskselector_item_append()
26004 * @see elm_diskselector_item_icon_set()
26006 * @ingroup Diskselector
26008 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26011 * Set the label of item.
26013 * @param it The item of diskselector.
26014 * @param label The label of item.
26016 * The label to be displayed by the item.
26018 * If no icon is set, label will be centered on item position, otherwise
26019 * the icon will be placed at left of the label, that will be shifted
26022 * An item with label "January" would be displayed on side position as
26023 * "Jan" if max length is set to 3 with function
26024 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
26027 * When this @p item is selected, the entire label will be displayed,
26028 * except for width restrictions.
26029 * In this case label will be cropped and "..." will be concatenated,
26030 * but only for display purposes. It will keep the entire string, so
26031 * if diskselector is resized the remaining characters will be displayed.
26033 * If a label was passed as argument on item creation, with function
26034 * elm_diskselector_item_append(), it will be already
26035 * displayed by the item.
26037 * @see elm_diskselector_side_label_lenght_set()
26038 * @see elm_diskselector_item_label_get()
26039 * @see elm_diskselector_item_append()
26041 * @ingroup Diskselector
26043 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
26046 * Get the label of item.
26048 * @param it The item of diskselector.
26049 * @return The label of item.
26051 * The return value is a pointer to the label associated to @p item when it was
26052 * created, with function elm_diskselector_item_append(), or later
26053 * with function elm_diskselector_item_label_set. If no label
26054 * was passed as argument, it will return @c NULL.
26056 * @see elm_diskselector_item_label_set() for more details.
26057 * @see elm_diskselector_item_append()
26059 * @ingroup Diskselector
26061 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26064 * Get the selected item.
26066 * @param obj The diskselector object.
26067 * @return The selected diskselector item.
26069 * The selected item can be unselected with function
26070 * elm_diskselector_item_selected_set(), and the first item of
26071 * diskselector will be selected.
26073 * The selected item always will be centered on diskselector, with
26074 * full label displayed, i.e., max lenght set to side labels won't
26075 * apply on the selected item. More details on
26076 * elm_diskselector_side_label_length_set().
26078 * @ingroup Diskselector
26080 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26083 * Set the selected state of an item.
26085 * @param it The diskselector item
26086 * @param selected The selected state
26088 * This sets the selected state of the given item @p it.
26089 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26091 * If a new item is selected the previosly selected will be unselected.
26092 * Previoulsy selected item can be get with function
26093 * elm_diskselector_selected_item_get().
26095 * If the item @p it is unselected, the first item of diskselector will
26098 * Selected items will be visible on center position of diskselector.
26099 * So if it was on another position before selected, or was invisible,
26100 * diskselector will animate items until the selected item reaches center
26103 * @see elm_diskselector_item_selected_get()
26104 * @see elm_diskselector_selected_item_get()
26106 * @ingroup Diskselector
26108 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26111 * Get whether the @p item is selected or not.
26113 * @param it The diskselector item.
26114 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26115 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26117 * @see elm_diskselector_selected_item_set() for details.
26118 * @see elm_diskselector_item_selected_get()
26120 * @ingroup Diskselector
26122 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26125 * Get the first item of the diskselector.
26127 * @param obj The diskselector object.
26128 * @return The first item, or @c NULL if none.
26130 * The list of items follows append order. So it will return the first
26131 * item appended to the widget that wasn't deleted.
26133 * @see elm_diskselector_item_append()
26134 * @see elm_diskselector_items_get()
26136 * @ingroup Diskselector
26138 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26141 * Get the last item of the diskselector.
26143 * @param obj The diskselector object.
26144 * @return The last item, or @c NULL if none.
26146 * The list of items follows append order. So it will return last first
26147 * item appended to the widget that wasn't deleted.
26149 * @see elm_diskselector_item_append()
26150 * @see elm_diskselector_items_get()
26152 * @ingroup Diskselector
26154 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26157 * Get the item before @p item in diskselector.
26159 * @param it The diskselector item.
26160 * @return The item before @p item, or @c NULL if none or on failure.
26162 * The list of items follows append order. So it will return item appended
26163 * just before @p item and that wasn't deleted.
26165 * If it is the first item, @c NULL will be returned.
26166 * First item can be get by elm_diskselector_first_item_get().
26168 * @see elm_diskselector_item_append()
26169 * @see elm_diskselector_items_get()
26171 * @ingroup Diskselector
26173 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26176 * Get the item after @p item in diskselector.
26178 * @param it The diskselector item.
26179 * @return The item after @p item, or @c NULL if none or on failure.
26181 * The list of items follows append order. So it will return item appended
26182 * just after @p item and that wasn't deleted.
26184 * If it is the last item, @c NULL will be returned.
26185 * Last item can be get by elm_diskselector_last_item_get().
26187 * @see elm_diskselector_item_append()
26188 * @see elm_diskselector_items_get()
26190 * @ingroup Diskselector
26192 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26195 * Set the text to be shown in the diskselector item.
26197 * @param item Target item
26198 * @param text The text to set in the content
26200 * Setup the text as tooltip to object. The item can have only one tooltip,
26201 * so any previous tooltip data is removed.
26203 * @see elm_object_tooltip_text_set() for more details.
26205 * @ingroup Diskselector
26207 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26210 * Set the content to be shown in the tooltip item.
26212 * Setup the tooltip to item. The item can have only one tooltip,
26213 * so any previous tooltip data is removed. @p func(with @p data) will
26214 * be called every time that need show the tooltip and it should
26215 * return a valid Evas_Object. This object is then managed fully by
26216 * tooltip system and is deleted when the tooltip is gone.
26218 * @param item the diskselector item being attached a tooltip.
26219 * @param func the function used to create the tooltip contents.
26220 * @param data what to provide to @a func as callback data/context.
26221 * @param del_cb called when data is not needed anymore, either when
26222 * another callback replaces @p func, the tooltip is unset with
26223 * elm_diskselector_item_tooltip_unset() or the owner @a item
26224 * dies. This callback receives as the first parameter the
26225 * given @a data, and @c event_info is the item.
26227 * @see elm_object_tooltip_content_cb_set() for more details.
26229 * @ingroup Diskselector
26231 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);
26234 * Unset tooltip from item.
26236 * @param item diskselector item to remove previously set tooltip.
26238 * Remove tooltip from item. The callback provided as del_cb to
26239 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26240 * it is not used anymore.
26242 * @see elm_object_tooltip_unset() for more details.
26243 * @see elm_diskselector_item_tooltip_content_cb_set()
26245 * @ingroup Diskselector
26247 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26251 * Sets a different style for this item tooltip.
26253 * @note before you set a style you should define a tooltip with
26254 * elm_diskselector_item_tooltip_content_cb_set() or
26255 * elm_diskselector_item_tooltip_text_set()
26257 * @param item diskselector item with tooltip already set.
26258 * @param style the theme style to use (default, transparent, ...)
26260 * @see elm_object_tooltip_style_set() for more details.
26262 * @ingroup Diskselector
26264 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26267 * Get the style for this item tooltip.
26269 * @param item diskselector item with tooltip already set.
26270 * @return style the theme style in use, defaults to "default". If the
26271 * object does not have a tooltip set, then NULL is returned.
26273 * @see elm_object_tooltip_style_get() for more details.
26274 * @see elm_diskselector_item_tooltip_style_set()
26276 * @ingroup Diskselector
26278 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26281 * Set the cursor to be shown when mouse is over the diskselector item
26283 * @param item Target item
26284 * @param cursor the cursor name to be used.
26286 * @see elm_object_cursor_set() for more details.
26288 * @ingroup Diskselector
26290 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26293 * Get the cursor to be shown when mouse is over the diskselector item
26295 * @param item diskselector item with cursor already set.
26296 * @return the cursor name.
26298 * @see elm_object_cursor_get() for more details.
26299 * @see elm_diskselector_cursor_set()
26301 * @ingroup Diskselector
26303 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26307 * Unset the cursor to be shown when mouse is over the diskselector item
26309 * @param item Target item
26311 * @see elm_object_cursor_unset() for more details.
26312 * @see elm_diskselector_cursor_set()
26314 * @ingroup Diskselector
26316 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26319 * Sets a different style for this item cursor.
26321 * @note before you set a style you should define a cursor with
26322 * elm_diskselector_item_cursor_set()
26324 * @param item diskselector item with cursor already set.
26325 * @param style the theme style to use (default, transparent, ...)
26327 * @see elm_object_cursor_style_set() for more details.
26329 * @ingroup Diskselector
26331 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26335 * Get the style for this item cursor.
26337 * @param item diskselector item with cursor already set.
26338 * @return style the theme style in use, defaults to "default". If the
26339 * object does not have a cursor set, then @c NULL is returned.
26341 * @see elm_object_cursor_style_get() for more details.
26342 * @see elm_diskselector_item_cursor_style_set()
26344 * @ingroup Diskselector
26346 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26350 * Set if the cursor set should be searched on the theme or should use
26351 * the provided by the engine, only.
26353 * @note before you set if should look on theme you should define a cursor
26354 * with elm_diskselector_item_cursor_set().
26355 * By default it will only look for cursors provided by the engine.
26357 * @param item widget item with cursor already set.
26358 * @param engine_only boolean to define if cursors set with
26359 * elm_diskselector_item_cursor_set() should be searched only
26360 * between cursors provided by the engine or searched on widget's
26363 * @see elm_object_cursor_engine_only_set() for more details.
26365 * @ingroup Diskselector
26367 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26370 * Get the cursor engine only usage for this item cursor.
26372 * @param item widget item with cursor already set.
26373 * @return engine_only boolean to define it cursors should be looked only
26374 * between the provided by the engine or searched on widget's theme as well.
26375 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26377 * @see elm_object_cursor_engine_only_get() for more details.
26378 * @see elm_diskselector_item_cursor_engine_only_set()
26380 * @ingroup Diskselector
26382 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26389 * @defgroup Colorselector Colorselector
26393 * @image html img/widget/colorselector/preview-00.png
26394 * @image latex img/widget/colorselector/preview-00.eps
26396 * @brief Widget for user to select a color.
26398 * Signals that you can add callbacks for are:
26399 * "changed" - When the color value changes(event_info is NULL).
26401 * See @ref tutorial_colorselector.
26404 * @brief Add a new colorselector to the parent
26406 * @param parent The parent object
26407 * @return The new object or NULL if it cannot be created
26409 * @ingroup Colorselector
26411 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26413 * Set a color for the colorselector
26415 * @param obj Colorselector object
26416 * @param r r-value of color
26417 * @param g g-value of color
26418 * @param b b-value of color
26419 * @param a a-value of color
26421 * @ingroup Colorselector
26423 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26425 * Get a color from the colorselector
26427 * @param obj Colorselector object
26428 * @param r integer pointer for r-value of color
26429 * @param g integer pointer for g-value of color
26430 * @param b integer pointer for b-value of color
26431 * @param a integer pointer for a-value of color
26433 * @ingroup Colorselector
26435 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26441 * @defgroup Ctxpopup Ctxpopup
26443 * @image html img/widget/ctxpopup/preview-00.png
26444 * @image latex img/widget/ctxpopup/preview-00.eps
26446 * @brief Context popup widet.
26448 * A ctxpopup is a widget that, when shown, pops up a list of items.
26449 * It automatically chooses an area inside its parent object's view
26450 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26451 * optimally fit into it. In the default theme, it will also point an
26452 * arrow to it's top left position at the time one shows it. Ctxpopup
26453 * items have a label and/or an icon. It is intended for a small
26454 * number of items (hence the use of list, not genlist).
26456 * @note Ctxpopup is a especialization of @ref Hover.
26458 * Signals that you can add callbacks for are:
26459 * "dismissed" - the ctxpopup was dismissed
26461 * Default contents parts of the ctxpopup widget that you can use for are:
26462 * @li "elm.swallow.content" - A content of the ctxpopup
26464 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26467 typedef enum _Elm_Ctxpopup_Direction
26469 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26471 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26472 the clicked area */
26473 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26474 the clicked area */
26475 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26477 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26478 } Elm_Ctxpopup_Direction;
26479 #define Elm_Ctxpopup_Item Elm_Object_Item
26482 * @brief Add a new Ctxpopup object to the parent.
26484 * @param parent Parent object
26485 * @return New object or @c NULL, if it cannot be created
26487 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26489 * @brief Set the Ctxpopup's parent
26491 * @param obj The ctxpopup object
26492 * @param area The parent to use
26494 * Set the parent object.
26496 * @note elm_ctxpopup_add() will automatically call this function
26497 * with its @c parent argument.
26499 * @see elm_ctxpopup_add()
26500 * @see elm_hover_parent_set()
26502 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26504 * @brief Get the Ctxpopup's parent
26506 * @param obj The ctxpopup object
26508 * @see elm_ctxpopup_hover_parent_set() for more information
26510 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26512 * @brief Clear all items in the given ctxpopup object.
26514 * @param obj Ctxpopup object
26516 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26518 * @brief Change the ctxpopup's orientation to horizontal or vertical.
26520 * @param obj Ctxpopup object
26521 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26523 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26525 * @brief Get the value of current ctxpopup object's orientation.
26527 * @param obj Ctxpopup object
26528 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26530 * @see elm_ctxpopup_horizontal_set()
26532 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26534 * @brief Add a new item to a ctxpopup object.
26536 * @param obj Ctxpopup object
26537 * @param icon Icon to be set on new item
26538 * @param label The Label of the new item
26539 * @param func Convenience function called when item selected
26540 * @param data Data passed to @p func
26541 * @return A handle to the item added or @c NULL, on errors
26543 * @warning Ctxpopup can't hold both an item list and a content at the same
26544 * time. When an item is added, any previous content will be removed.
26546 * @see elm_ctxpopup_content_set()
26548 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);
26550 * @brief Delete the given item in a ctxpopup object.
26552 * @param it Ctxpopup item to be deleted
26554 * @see elm_ctxpopup_item_append()
26556 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26558 * @brief Set the ctxpopup item's state as disabled or enabled.
26560 * @param it Ctxpopup item to be enabled/disabled
26561 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26563 * When disabled the item is greyed out to indicate it's state.
26565 EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26567 * @brief Get the ctxpopup item's disabled/enabled state.
26569 * @param it Ctxpopup item to be enabled/disabled
26570 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26572 * @see elm_ctxpopup_item_disabled_set()
26574 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26576 * @brief Get the icon object for the given ctxpopup item.
26578 * @param it Ctxpopup item
26579 * @return icon object or @c NULL, if the item does not have icon or an error
26582 * @see elm_ctxpopup_item_append()
26583 * @see elm_ctxpopup_item_icon_set()
26585 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26587 * @brief Sets the side icon associated with the ctxpopup item
26589 * @param it Ctxpopup item
26590 * @param icon Icon object to be set
26592 * Once the icon object is set, a previously set one will be deleted.
26593 * @warning Setting the same icon for two items will cause the icon to
26594 * dissapear from the first item.
26596 * @see elm_ctxpopup_item_append()
26598 EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26600 * @brief Get the label for the given ctxpopup item.
26602 * @param it Ctxpopup item
26603 * @return label string or @c NULL, if the item does not have label or an
26606 * @see elm_ctxpopup_item_append()
26607 * @see elm_ctxpopup_item_label_set()
26609 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26611 * @brief (Re)set the label on the given ctxpopup item.
26613 * @param it Ctxpopup item
26614 * @param label String to set as label
26616 EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26618 * @brief Set an elm widget as the content of the ctxpopup.
26620 * @param obj Ctxpopup object
26621 * @param content Content to be swallowed
26623 * If the content object is already set, a previous one will bedeleted. If
26624 * you want to keep that old content object, use the
26625 * elm_ctxpopup_content_unset() function.
26627 * @deprecated use elm_object_content_set()
26629 * @warning Ctxpopup can't hold both a item list and a content at the same
26630 * time. When a content is set, any previous items will be removed.
26632 EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26634 * @brief Unset the ctxpopup content
26636 * @param obj Ctxpopup object
26637 * @return The content that was being used
26639 * Unparent and return the content object which was set for this widget.
26641 * @deprecated use elm_object_content_unset()
26643 * @see elm_ctxpopup_content_set()
26645 EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26647 * @brief Set the direction priority of a ctxpopup.
26649 * @param obj Ctxpopup object
26650 * @param first 1st priority of direction
26651 * @param second 2nd priority of direction
26652 * @param third 3th priority of direction
26653 * @param fourth 4th priority of direction
26655 * This functions gives a chance to user to set the priority of ctxpopup
26656 * showing direction. This doesn't guarantee the ctxpopup will appear in the
26657 * requested direction.
26659 * @see Elm_Ctxpopup_Direction
26661 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);
26663 * @brief Get the direction priority of a ctxpopup.
26665 * @param obj Ctxpopup object
26666 * @param first 1st priority of direction to be returned
26667 * @param second 2nd priority of direction to be returned
26668 * @param third 3th priority of direction to be returned
26669 * @param fourth 4th priority of direction to be returned
26671 * @see elm_ctxpopup_direction_priority_set() for more information.
26673 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);
26676 * @brief Get the current direction of a ctxpopup.
26678 * @param obj Ctxpopup object
26679 * @return current direction of a ctxpopup
26681 * @warning Once the ctxpopup showed up, the direction would be determined
26683 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26692 * @defgroup Transit Transit
26693 * @ingroup Elementary
26695 * Transit is designed to apply various animated transition effects to @c
26696 * Evas_Object, such like translation, rotation, etc. For using these
26697 * effects, create an @ref Elm_Transit and add the desired transition effects.
26699 * Once the effects are added into transit, they will be automatically
26700 * managed (their callback will be called until the duration is ended, and
26701 * they will be deleted on completion).
26705 * Elm_Transit *trans = elm_transit_add();
26706 * elm_transit_object_add(trans, obj);
26707 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26708 * elm_transit_duration_set(transit, 1);
26709 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26710 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26711 * elm_transit_repeat_times_set(transit, 3);
26714 * Some transition effects are used to change the properties of objects. They
26716 * @li @ref elm_transit_effect_translation_add
26717 * @li @ref elm_transit_effect_color_add
26718 * @li @ref elm_transit_effect_rotation_add
26719 * @li @ref elm_transit_effect_wipe_add
26720 * @li @ref elm_transit_effect_zoom_add
26721 * @li @ref elm_transit_effect_resizing_add
26723 * Other transition effects are used to make one object disappear and another
26724 * object appear on its old place. These effects are:
26726 * @li @ref elm_transit_effect_flip_add
26727 * @li @ref elm_transit_effect_resizable_flip_add
26728 * @li @ref elm_transit_effect_fade_add
26729 * @li @ref elm_transit_effect_blend_add
26731 * It's also possible to make a transition chain with @ref
26732 * elm_transit_chain_transit_add.
26734 * @warning We strongly recommend to use elm_transit just when edje can not do
26735 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26736 * animations can be manipulated inside the theme.
26738 * List of examples:
26739 * @li @ref transit_example_01_explained
26740 * @li @ref transit_example_02_explained
26741 * @li @ref transit_example_03_c
26742 * @li @ref transit_example_04_c
26748 * @enum Elm_Transit_Tween_Mode
26750 * The type of acceleration used in the transition.
26754 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26755 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26756 over time, then decrease again
26758 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26760 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26762 } Elm_Transit_Tween_Mode;
26765 * @enum Elm_Transit_Effect_Flip_Axis
26767 * The axis where flip effect should be applied.
26771 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26772 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26773 } Elm_Transit_Effect_Flip_Axis;
26775 * @enum Elm_Transit_Effect_Wipe_Dir
26777 * The direction where the wipe effect should occur.
26781 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26782 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26783 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26784 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26785 } Elm_Transit_Effect_Wipe_Dir;
26786 /** @enum Elm_Transit_Effect_Wipe_Type
26788 * Whether the wipe effect should show or hide the object.
26792 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26794 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26796 } Elm_Transit_Effect_Wipe_Type;
26799 * @typedef Elm_Transit
26801 * The Transit created with elm_transit_add(). This type has the information
26802 * about the objects which the transition will be applied, and the
26803 * transition effects that will be used. It also contains info about
26804 * duration, number of repetitions, auto-reverse, etc.
26806 typedef struct _Elm_Transit Elm_Transit;
26807 typedef void Elm_Transit_Effect;
26809 * @typedef Elm_Transit_Effect_Transition_Cb
26811 * Transition callback called for this effect on each transition iteration.
26813 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
26815 * Elm_Transit_Effect_End_Cb
26817 * Transition callback called for this effect when the transition is over.
26819 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
26822 * Elm_Transit_Del_Cb
26824 * A callback called when the transit is deleted.
26826 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
26831 * @note Is not necessary to delete the transit object, it will be deleted at
26832 * the end of its operation.
26833 * @note The transit will start playing when the program enter in the main loop, is not
26834 * necessary to give a start to the transit.
26836 * @return The transit object.
26840 EAPI Elm_Transit *elm_transit_add(void);
26843 * Stops the animation and delete the @p transit object.
26845 * Call this function if you wants to stop the animation before the duration
26846 * time. Make sure the @p transit object is still alive with
26847 * elm_transit_del_cb_set() function.
26848 * All added effects will be deleted, calling its repective data_free_cb
26849 * functions. The function setted by elm_transit_del_cb_set() will be called.
26851 * @see elm_transit_del_cb_set()
26853 * @param transit The transit object to be deleted.
26856 * @warning Just call this function if you are sure the transit is alive.
26858 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26861 * Add a new effect to the transit.
26863 * @note The cb function and the data are the key to the effect. If you try to
26864 * add an already added effect, nothing is done.
26865 * @note After the first addition of an effect in @p transit, if its
26866 * effect list become empty again, the @p transit will be killed by
26867 * elm_transit_del(transit) function.
26871 * Elm_Transit *transit = elm_transit_add();
26872 * elm_transit_effect_add(transit,
26873 * elm_transit_effect_blend_op,
26874 * elm_transit_effect_blend_context_new(),
26875 * elm_transit_effect_blend_context_free);
26878 * @param transit The transit object.
26879 * @param transition_cb The operation function. It is called when the
26880 * animation begins, it is the function that actually performs the animation.
26881 * It is called with the @p data, @p transit and the time progression of the
26882 * animation (a double value between 0.0 and 1.0).
26883 * @param effect The context data of the effect.
26884 * @param end_cb The function to free the context data, it will be called
26885 * at the end of the effect, it must finalize the animation and free the
26889 * @warning The transit free the context data at the and of the transition with
26890 * the data_free_cb function, do not use the context data in another transit.
26892 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);
26895 * Delete an added effect.
26897 * This function will remove the effect from the @p transit, calling the
26898 * data_free_cb to free the @p data.
26900 * @see elm_transit_effect_add()
26902 * @note If the effect is not found, nothing is done.
26903 * @note If the effect list become empty, this function will call
26904 * elm_transit_del(transit), that is, it will kill the @p transit.
26906 * @param transit The transit object.
26907 * @param transition_cb The operation function.
26908 * @param effect The context data of the effect.
26912 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);
26915 * Add new object to apply the effects.
26917 * @note After the first addition of an object in @p transit, if its
26918 * object list become empty again, the @p transit will be killed by
26919 * elm_transit_del(transit) function.
26920 * @note If the @p obj belongs to another transit, the @p obj will be
26921 * removed from it and it will only belong to the @p transit. If the old
26922 * transit stays without objects, it will die.
26923 * @note When you add an object into the @p transit, its state from
26924 * evas_object_pass_events_get(obj) is saved, and it is applied when the
26925 * transit ends, if you change this state whith evas_object_pass_events_set()
26926 * after add the object, this state will change again when @p transit stops to
26929 * @param transit The transit object.
26930 * @param obj Object to be animated.
26933 * @warning It is not allowed to add a new object after transit begins to go.
26935 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26938 * Removes an added object from the transit.
26940 * @note If the @p obj is not in the @p transit, nothing is done.
26941 * @note If the list become empty, this function will call
26942 * elm_transit_del(transit), that is, it will kill the @p transit.
26944 * @param transit The transit object.
26945 * @param obj Object to be removed from @p transit.
26948 * @warning It is not allowed to remove objects after transit begins to go.
26950 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26953 * Get the objects of the transit.
26955 * @param transit The transit object.
26956 * @return a Eina_List with the objects from the transit.
26960 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26963 * Enable/disable keeping up the objects states.
26964 * If it is not kept, the objects states will be reset when transition ends.
26966 * @note @p transit can not be NULL.
26967 * @note One state includes geometry, color, map data.
26969 * @param transit The transit object.
26970 * @param state_keep Keeping or Non Keeping.
26974 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
26977 * Get a value whether the objects states will be reset or not.
26979 * @note @p transit can not be NULL
26981 * @see elm_transit_objects_final_state_keep_set()
26983 * @param transit The transit object.
26984 * @return EINA_TRUE means the states of the objects will be reset.
26985 * If @p transit is NULL, EINA_FALSE is returned
26989 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26992 * Set the event enabled when transit is operating.
26994 * If @p enabled is EINA_TRUE, the objects of the transit will receives
26995 * events from mouse and keyboard during the animation.
26996 * @note When you add an object with elm_transit_object_add(), its state from
26997 * evas_object_pass_events_get(obj) is saved, and it is applied when the
26998 * transit ends, if you change this state with evas_object_pass_events_set()
26999 * after adding the object, this state will change again when @p transit stops
27002 * @param transit The transit object.
27003 * @param enabled Events are received when enabled is @c EINA_TRUE, and
27004 * ignored otherwise.
27008 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
27011 * Get the value of event enabled status.
27013 * @see elm_transit_event_enabled_set()
27015 * @param transit The Transit object
27016 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
27017 * EINA_FALSE is returned
27021 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27024 * Set the user-callback function when the transit is deleted.
27026 * @note Using this function twice will overwrite the first function setted.
27027 * @note the @p transit object will be deleted after call @p cb function.
27029 * @param transit The transit object.
27030 * @param cb Callback function pointer. This function will be called before
27031 * the deletion of the transit.
27032 * @param data Callback funtion user data. It is the @p op parameter.
27036 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
27039 * Set reverse effect automatically.
27041 * If auto reverse is setted, after running the effects with the progress
27042 * parameter from 0 to 1, it will call the effecs again with the progress
27043 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
27044 * where the duration was setted with the function elm_transit_add and
27045 * the repeat with the function elm_transit_repeat_times_set().
27047 * @param transit The transit object.
27048 * @param reverse EINA_TRUE means the auto_reverse is on.
27052 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
27055 * Get if the auto reverse is on.
27057 * @see elm_transit_auto_reverse_set()
27059 * @param transit The transit object.
27060 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27061 * EINA_FALSE is returned
27065 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27068 * Set the transit repeat count. Effect will be repeated by repeat count.
27070 * This function sets the number of repetition the transit will run after
27071 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27072 * If the @p repeat is a negative number, it will repeat infinite times.
27074 * @note If this function is called during the transit execution, the transit
27075 * will run @p repeat times, ignoring the times it already performed.
27077 * @param transit The transit object
27078 * @param repeat Repeat count
27082 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27085 * Get the transit repeat count.
27087 * @see elm_transit_repeat_times_set()
27089 * @param transit The Transit object.
27090 * @return The repeat count. If @p transit is NULL
27095 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27098 * Set the transit animation acceleration type.
27100 * This function sets the tween mode of the transit that can be:
27101 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27102 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27103 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27104 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27106 * @param transit The transit object.
27107 * @param tween_mode The tween type.
27111 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27114 * Get the transit animation acceleration type.
27116 * @note @p transit can not be NULL
27118 * @param transit The transit object.
27119 * @return The tween type. If @p transit is NULL
27120 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27124 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27127 * Set the transit animation time
27129 * @note @p transit can not be NULL
27131 * @param transit The transit object.
27132 * @param duration The animation time.
27136 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27139 * Get the transit animation time
27141 * @note @p transit can not be NULL
27143 * @param transit The transit object.
27145 * @return The transit animation time.
27149 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27152 * Starts the transition.
27153 * Once this API is called, the transit begins to measure the time.
27155 * @note @p transit can not be NULL
27157 * @param transit The transit object.
27161 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27164 * Pause/Resume the transition.
27166 * If you call elm_transit_go again, the transit will be started from the
27167 * beginning, and will be unpaused.
27169 * @note @p transit can not be NULL
27171 * @param transit The transit object.
27172 * @param paused Whether the transition should be paused or not.
27176 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27179 * Get the value of paused status.
27181 * @see elm_transit_paused_set()
27183 * @note @p transit can not be NULL
27185 * @param transit The transit object.
27186 * @return EINA_TRUE means transition is paused. If @p transit is NULL
27187 * EINA_FALSE is returned
27191 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27194 * Get the time progression of the animation (a double value between 0.0 and 1.0).
27196 * The value returned is a fraction (current time / total time). It
27197 * represents the progression position relative to the total.
27199 * @note @p transit can not be NULL
27201 * @param transit The transit object.
27203 * @return The time progression value. If @p transit is NULL
27208 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27211 * Makes the chain relationship between two transits.
27213 * @note @p transit can not be NULL. Transit would have multiple chain transits.
27214 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27216 * @param transit The transit object.
27217 * @param chain_transit The chain transit object. This transit will be operated
27218 * after transit is done.
27220 * This function adds @p chain_transit transition to a chain after the @p
27221 * transit, and will be started as soon as @p transit ends. See @ref
27222 * transit_example_02_explained for a full example.
27226 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27229 * Cut off the chain relationship between two transits.
27231 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27232 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27234 * @param transit The transit object.
27235 * @param chain_transit The chain transit object.
27237 * This function remove the @p chain_transit transition from the @p transit.
27241 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27244 * Get the current chain transit list.
27246 * @note @p transit can not be NULL.
27248 * @param transit The transit object.
27249 * @return chain transit list.
27253 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
27256 * Add the Resizing Effect to Elm_Transit.
27258 * @note This API is one of the facades. It creates resizing effect context
27259 * and add it's required APIs to elm_transit_effect_add.
27261 * @see elm_transit_effect_add()
27263 * @param transit Transit object.
27264 * @param from_w Object width size when effect begins.
27265 * @param from_h Object height size when effect begins.
27266 * @param to_w Object width size when effect ends.
27267 * @param to_h Object height size when effect ends.
27268 * @return Resizing effect context data.
27272 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);
27275 * Add the Translation Effect to Elm_Transit.
27277 * @note This API is one of the facades. It creates translation effect context
27278 * and add it's required APIs to elm_transit_effect_add.
27280 * @see elm_transit_effect_add()
27282 * @param transit Transit object.
27283 * @param from_dx X Position variation when effect begins.
27284 * @param from_dy Y Position variation when effect begins.
27285 * @param to_dx X Position variation when effect ends.
27286 * @param to_dy Y Position variation when effect ends.
27287 * @return Translation effect context data.
27290 * @warning It is highly recommended just create a transit with this effect when
27291 * the window that the objects of the transit belongs has already been created.
27292 * This is because this effect needs the geometry information about the objects,
27293 * and if the window was not created yet, it can get a wrong information.
27295 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);
27298 * Add the Zoom Effect to Elm_Transit.
27300 * @note This API is one of the facades. It creates zoom effect context
27301 * and add it's required APIs to elm_transit_effect_add.
27303 * @see elm_transit_effect_add()
27305 * @param transit Transit object.
27306 * @param from_rate Scale rate when effect begins (1 is current rate).
27307 * @param to_rate Scale rate when effect ends.
27308 * @return Zoom effect context data.
27311 * @warning It is highly recommended just create a transit with this effect when
27312 * the window that the objects of the transit belongs has already been created.
27313 * This is because this effect needs the geometry information about the objects,
27314 * and if the window was not created yet, it can get a wrong information.
27316 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27319 * Add the Flip Effect to Elm_Transit.
27321 * @note This API is one of the facades. It creates flip effect context
27322 * and add it's required APIs to elm_transit_effect_add.
27323 * @note This effect is applied to each pair of objects in the order they are listed
27324 * in the transit list of objects. The first object in the pair will be the
27325 * "front" object and the second will be the "back" object.
27327 * @see elm_transit_effect_add()
27329 * @param transit Transit object.
27330 * @param axis Flipping Axis(X or Y).
27331 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27332 * @return Flip effect context data.
27335 * @warning It is highly recommended just create a transit with this effect when
27336 * the window that the objects of the transit belongs has already been created.
27337 * This is because this effect needs the geometry information about the objects,
27338 * and if the window was not created yet, it can get a wrong information.
27340 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27343 * Add the Resizable Flip Effect to Elm_Transit.
27345 * @note This API is one of the facades. It creates resizable flip effect context
27346 * and add it's required APIs to elm_transit_effect_add.
27347 * @note This effect is applied to each pair of objects in the order they are listed
27348 * in the transit list of objects. The first object in the pair will be the
27349 * "front" object and the second will be the "back" object.
27351 * @see elm_transit_effect_add()
27353 * @param transit Transit object.
27354 * @param axis Flipping Axis(X or Y).
27355 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27356 * @return Resizable flip effect context data.
27359 * @warning It is highly recommended just create a transit with this effect when
27360 * the window that the objects of the transit belongs has already been created.
27361 * This is because this effect needs the geometry information about the objects,
27362 * and if the window was not created yet, it can get a wrong information.
27364 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27367 * Add the Wipe Effect to Elm_Transit.
27369 * @note This API is one of the facades. It creates wipe effect context
27370 * and add it's required APIs to elm_transit_effect_add.
27372 * @see elm_transit_effect_add()
27374 * @param transit Transit object.
27375 * @param type Wipe type. Hide or show.
27376 * @param dir Wipe Direction.
27377 * @return Wipe effect context data.
27380 * @warning It is highly recommended just create a transit with this effect when
27381 * the window that the objects of the transit belongs has already been created.
27382 * This is because this effect needs the geometry information about the objects,
27383 * and if the window was not created yet, it can get a wrong information.
27385 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27388 * Add the Color Effect to Elm_Transit.
27390 * @note This API is one of the facades. It creates color effect context
27391 * and add it's required APIs to elm_transit_effect_add.
27393 * @see elm_transit_effect_add()
27395 * @param transit Transit object.
27396 * @param from_r RGB R when effect begins.
27397 * @param from_g RGB G when effect begins.
27398 * @param from_b RGB B when effect begins.
27399 * @param from_a RGB A when effect begins.
27400 * @param to_r RGB R when effect ends.
27401 * @param to_g RGB G when effect ends.
27402 * @param to_b RGB B when effect ends.
27403 * @param to_a RGB A when effect ends.
27404 * @return Color effect context data.
27408 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);
27411 * Add the Fade Effect to Elm_Transit.
27413 * @note This API is one of the facades. It creates fade effect context
27414 * and add it's required APIs to elm_transit_effect_add.
27415 * @note This effect is applied to each pair of objects in the order they are listed
27416 * in the transit list of objects. The first object in the pair will be the
27417 * "before" object and the second will be the "after" object.
27419 * @see elm_transit_effect_add()
27421 * @param transit Transit object.
27422 * @return Fade effect context data.
27425 * @warning It is highly recommended just create a transit with this effect when
27426 * the window that the objects of the transit belongs has already been created.
27427 * This is because this effect needs the color information about the objects,
27428 * and if the window was not created yet, it can get a wrong information.
27430 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27433 * Add the Blend Effect to Elm_Transit.
27435 * @note This API is one of the facades. It creates blend effect context
27436 * and add it's required APIs to elm_transit_effect_add.
27437 * @note This effect is applied to each pair of objects in the order they are listed
27438 * in the transit list of objects. The first object in the pair will be the
27439 * "before" object and the second will be the "after" object.
27441 * @see elm_transit_effect_add()
27443 * @param transit Transit object.
27444 * @return Blend effect context data.
27447 * @warning It is highly recommended just create a transit with this effect when
27448 * the window that the objects of the transit belongs has already been created.
27449 * This is because this effect needs the color information about the objects,
27450 * and if the window was not created yet, it can get a wrong information.
27452 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27455 * Add the Rotation Effect to Elm_Transit.
27457 * @note This API is one of the facades. It creates rotation effect context
27458 * and add it's required APIs to elm_transit_effect_add.
27460 * @see elm_transit_effect_add()
27462 * @param transit Transit object.
27463 * @param from_degree Degree when effect begins.
27464 * @param to_degree Degree when effect is ends.
27465 * @return Rotation effect context data.
27468 * @warning It is highly recommended just create a transit with this effect when
27469 * the window that the objects of the transit belongs has already been created.
27470 * This is because this effect needs the geometry information about the objects,
27471 * and if the window was not created yet, it can get a wrong information.
27473 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27476 * Add the ImageAnimation Effect to Elm_Transit.
27478 * @note This API is one of the facades. It creates image animation effect context
27479 * and add it's required APIs to elm_transit_effect_add.
27480 * The @p images parameter is a list images paths. This list and
27481 * its contents will be deleted at the end of the effect by
27482 * elm_transit_effect_image_animation_context_free() function.
27486 * char buf[PATH_MAX];
27487 * Eina_List *images = NULL;
27488 * Elm_Transit *transi = elm_transit_add();
27490 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27491 * images = eina_list_append(images, eina_stringshare_add(buf));
27493 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27494 * images = eina_list_append(images, eina_stringshare_add(buf));
27495 * elm_transit_effect_image_animation_add(transi, images);
27499 * @see elm_transit_effect_add()
27501 * @param transit Transit object.
27502 * @param images Eina_List of images file paths. This list and
27503 * its contents will be deleted at the end of the effect by
27504 * elm_transit_effect_image_animation_context_free() function.
27505 * @return Image Animation effect context data.
27509 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27515 typedef struct _Elm_Store Elm_Store;
27516 typedef struct _Elm_Store_DBsystem Elm_Store_DBsystem;
27517 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
27518 typedef struct _Elm_Store_Item Elm_Store_Item;
27519 typedef struct _Elm_Store_Item_DBsystem Elm_Store_Item_DBsystem;
27520 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
27521 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
27522 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27523 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
27524 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
27525 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
27526 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
27527 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
27529 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27530 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27531 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27532 typedef void (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
27533 typedef int (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
27534 typedef void (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
27535 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27539 ELM_STORE_ITEM_MAPPING_NONE = 0,
27540 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27541 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27542 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27543 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27544 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27545 // can add more here as needed by common apps
27546 ELM_STORE_ITEM_MAPPING_LAST
27547 } Elm_Store_Item_Mapping_Type;
27549 struct _Elm_Store_Item_Mapping_Icon
27551 // FIXME: allow edje file icons
27553 Elm_Icon_Lookup_Order lookup_order;
27554 Eina_Bool standard_name : 1;
27555 Eina_Bool no_scale : 1;
27556 Eina_Bool smooth : 1;
27557 Eina_Bool scale_up : 1;
27558 Eina_Bool scale_down : 1;
27561 struct _Elm_Store_Item_Mapping_Empty
27566 struct _Elm_Store_Item_Mapping_Photo
27571 struct _Elm_Store_Item_Mapping_Custom
27573 Elm_Store_Item_Mapping_Cb func;
27576 struct _Elm_Store_Item_Mapping
27578 Elm_Store_Item_Mapping_Type type;
27583 Elm_Store_Item_Mapping_Empty empty;
27584 Elm_Store_Item_Mapping_Icon icon;
27585 Elm_Store_Item_Mapping_Photo photo;
27586 Elm_Store_Item_Mapping_Custom custom;
27587 // add more types here
27591 struct _Elm_Store_Item_Info
27596 Eina_Bool rec_item;
27597 int pre_group_index;
27599 Elm_Genlist_Item_Class *item_class;
27600 const Elm_Store_Item_Mapping *mapping;
27605 struct _Elm_Store_Item_Info_Filesystem
27607 Elm_Store_Item_Info base;
27611 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27612 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27614 EAPI Elm_Store *elm_store_dbsystem_new(void);
27615 EAPI void elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
27616 EAPI void elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
27617 EAPI void elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
27618 EAPI void elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
27619 EAPI int elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27620 EAPI void *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27621 EAPI void elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
27622 EAPI int elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27623 EAPI Elm_Store_Item *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
27624 EAPI void elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27625 EAPI void elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
27626 EAPI void elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27627 EAPI void elm_store_free(Elm_Store *st);
27628 EAPI Elm_Store *elm_store_filesystem_new(void);
27629 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27630 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27631 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27633 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27635 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27636 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27637 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27638 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27639 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27640 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27642 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27643 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27644 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27645 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27646 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27647 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27648 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27651 * @defgroup SegmentControl SegmentControl
27652 * @ingroup Elementary
27654 * @image html img/widget/segment_control/preview-00.png
27655 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27657 * @image html img/segment_control.png
27658 * @image latex img/segment_control.eps width=\textwidth
27660 * Segment control widget is a horizontal control made of multiple segment
27661 * items, each segment item functioning similar to discrete two state button.
27662 * A segment control groups the items together and provides compact
27663 * single button with multiple equal size segments.
27665 * Segment item size is determined by base widget
27666 * size and the number of items added.
27667 * Only one segment item can be at selected state. A segment item can display
27668 * combination of Text and any Evas_Object like Images or other widget.
27670 * Smart callbacks one can listen to:
27671 * - "changed" - When the user clicks on a segment item which is not
27672 * previously selected and get selected. The event_info parameter is the
27673 * segment item pointer.
27675 * Available styles for it:
27678 * Here is an example on its usage:
27679 * @li @ref segment_control_example
27683 * @addtogroup SegmentControl
27687 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27690 * Add a new segment control widget to the given parent Elementary
27691 * (container) object.
27693 * @param parent The parent object.
27694 * @return a new segment control widget handle or @c NULL, on errors.
27696 * This function inserts a new segment control widget on the canvas.
27698 * @ingroup SegmentControl
27700 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27703 * Append a new item to the segment control object.
27705 * @param obj The segment control object.
27706 * @param icon The icon object to use for the left side of the item. An
27707 * icon can be any Evas object, but usually it is an icon created
27708 * with elm_icon_add().
27709 * @param label The label of the item.
27710 * Note that, NULL is different from empty string "".
27711 * @return The created item or @c NULL upon failure.
27713 * A new item will be created and appended to the segment control, i.e., will
27714 * be set as @b last item.
27716 * If it should be inserted at another position,
27717 * elm_segment_control_item_insert_at() should be used instead.
27719 * Items created with this function can be deleted with function
27720 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27722 * @note @p label set to @c NULL is different from empty string "".
27724 * only has icon, it will be displayed bigger and centered. If it has
27725 * icon and label, even that an empty string, icon will be smaller and
27726 * positioned at left.
27730 * sc = elm_segment_control_add(win);
27731 * ic = elm_icon_add(win);
27732 * elm_icon_file_set(ic, "path/to/image", NULL);
27733 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27734 * elm_segment_control_item_add(sc, ic, "label");
27735 * evas_object_show(sc);
27738 * @see elm_segment_control_item_insert_at()
27739 * @see elm_segment_control_item_del()
27741 * @ingroup SegmentControl
27743 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27746 * Insert a new item to the segment control object at specified position.
27748 * @param obj The segment control object.
27749 * @param icon The icon object to use for the left side of the item. An
27750 * icon can be any Evas object, but usually it is an icon created
27751 * with elm_icon_add().
27752 * @param label The label of the item.
27753 * @param index Item position. Value should be between 0 and items count.
27754 * @return The created item or @c NULL upon failure.
27756 * Index values must be between @c 0, when item will be prepended to
27757 * segment control, and items count, that can be get with
27758 * elm_segment_control_item_count_get(), case when item will be appended
27759 * to segment control, just like elm_segment_control_item_add().
27761 * Items created with this function can be deleted with function
27762 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27764 * @note @p label set to @c NULL is different from empty string "".
27766 * only has icon, it will be displayed bigger and centered. If it has
27767 * icon and label, even that an empty string, icon will be smaller and
27768 * positioned at left.
27770 * @see elm_segment_control_item_add()
27771 * @see elm_segment_control_item_count_get()
27772 * @see elm_segment_control_item_del()
27774 * @ingroup SegmentControl
27776 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);
27779 * Remove a segment control item from its parent, deleting it.
27781 * @param it The item to be removed.
27783 * Items can be added with elm_segment_control_item_add() or
27784 * elm_segment_control_item_insert_at().
27786 * @ingroup SegmentControl
27788 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27791 * Remove a segment control item at given index from its parent,
27794 * @param obj The segment control object.
27795 * @param index The position of the segment control item to be deleted.
27797 * Items can be added with elm_segment_control_item_add() or
27798 * elm_segment_control_item_insert_at().
27800 * @ingroup SegmentControl
27802 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27805 * Get the Segment items count from segment control.
27807 * @param obj The segment control object.
27808 * @return Segment items count.
27810 * It will just return the number of items added to segment control @p obj.
27812 * @ingroup SegmentControl
27814 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27817 * Get the item placed at specified index.
27819 * @param obj The segment control object.
27820 * @param index The index of the segment item.
27821 * @return The segment control item or @c NULL on failure.
27823 * Index is the position of an item in segment control widget. Its
27824 * range is from @c 0 to <tt> count - 1 </tt>.
27825 * Count is the number of items, that can be get with
27826 * elm_segment_control_item_count_get().
27828 * @ingroup SegmentControl
27830 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27833 * Get the label of item.
27835 * @param obj The segment control object.
27836 * @param index The index of the segment item.
27837 * @return The label of the item at @p index.
27839 * The return value is a pointer to the label associated to the item when
27840 * it was created, with function elm_segment_control_item_add(), or later
27841 * with function elm_segment_control_item_label_set. If no label
27842 * was passed as argument, it will return @c NULL.
27844 * @see elm_segment_control_item_label_set() for more details.
27845 * @see elm_segment_control_item_add()
27847 * @ingroup SegmentControl
27849 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27852 * Set the label of item.
27854 * @param it The item of segment control.
27855 * @param text The label of item.
27857 * The label to be displayed by the item.
27858 * Label will be at right of the icon (if set).
27860 * If a label was passed as argument on item creation, with function
27861 * elm_control_segment_item_add(), it will be already
27862 * displayed by the item.
27864 * @see elm_segment_control_item_label_get()
27865 * @see elm_segment_control_item_add()
27867 * @ingroup SegmentControl
27869 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
27872 * Get the icon associated to the item.
27874 * @param obj The segment control object.
27875 * @param index The index of the segment item.
27876 * @return The left side icon associated to the item at @p index.
27878 * The return value is a pointer to the icon associated to the item when
27879 * it was created, with function elm_segment_control_item_add(), or later
27880 * with function elm_segment_control_item_icon_set(). If no icon
27881 * was passed as argument, it will return @c NULL.
27883 * @see elm_segment_control_item_add()
27884 * @see elm_segment_control_item_icon_set()
27886 * @ingroup SegmentControl
27888 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27891 * Set the icon associated to the item.
27893 * @param it The segment control item.
27894 * @param icon The icon object to associate with @p it.
27896 * The icon object to use at left side of the item. An
27897 * icon can be any Evas object, but usually it is an icon created
27898 * with elm_icon_add().
27900 * Once the icon object is set, a previously set one will be deleted.
27901 * @warning Setting the same icon for two items will cause the icon to
27902 * dissapear from the first item.
27904 * If an icon was passed as argument on item creation, with function
27905 * elm_segment_control_item_add(), it will be already
27906 * associated to the item.
27908 * @see elm_segment_control_item_add()
27909 * @see elm_segment_control_item_icon_get()
27911 * @ingroup SegmentControl
27913 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27916 * Get the index of an item.
27918 * @param it The segment control item.
27919 * @return The position of item in segment control widget.
27921 * Index is the position of an item in segment control widget. Its
27922 * range is from @c 0 to <tt> count - 1 </tt>.
27923 * Count is the number of items, that can be get with
27924 * elm_segment_control_item_count_get().
27926 * @ingroup SegmentControl
27928 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27931 * Get the base object of the item.
27933 * @param it The segment control item.
27934 * @return The base object associated with @p it.
27936 * Base object is the @c Evas_Object that represents that item.
27938 * @ingroup SegmentControl
27940 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27943 * Get the selected item.
27945 * @param obj The segment control object.
27946 * @return The selected item or @c NULL if none of segment items is
27949 * The selected item can be unselected with function
27950 * elm_segment_control_item_selected_set().
27952 * The selected item always will be highlighted on segment control.
27954 * @ingroup SegmentControl
27956 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27959 * Set the selected state of an item.
27961 * @param it The segment control item
27962 * @param select The selected state
27964 * This sets the selected state of the given item @p it.
27965 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27967 * If a new item is selected the previosly selected will be unselected.
27968 * Previoulsy selected item can be get with function
27969 * elm_segment_control_item_selected_get().
27971 * The selected item always will be highlighted on segment control.
27973 * @see elm_segment_control_item_selected_get()
27975 * @ingroup SegmentControl
27977 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
27984 * @defgroup Grid Grid
27986 * The grid is a grid layout widget that lays out a series of children as a
27987 * fixed "grid" of widgets using a given percentage of the grid width and
27988 * height each using the child object.
27990 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
27991 * widgets size itself. The default is 100 x 100, so that means the
27992 * position and sizes of children will effectively be percentages (0 to 100)
27993 * of the width or height of the grid widget
27999 * Add a new grid to the parent
28001 * @param parent The parent object
28002 * @return The new object or NULL if it cannot be created
28006 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
28009 * Set the virtual size of the grid
28011 * @param obj The grid object
28012 * @param w The virtual width of the grid
28013 * @param h The virtual height of the grid
28017 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
28020 * Get the virtual size of the grid
28022 * @param obj The grid object
28023 * @param w Pointer to integer to store the virtual width of the grid
28024 * @param h Pointer to integer to store the virtual height of the grid
28028 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
28031 * Pack child at given position and size
28033 * @param obj The grid object
28034 * @param subobj The child to pack
28035 * @param x The virtual x coord at which to pack it
28036 * @param y The virtual y coord at which to pack it
28037 * @param w The virtual width at which to pack it
28038 * @param h The virtual height at which to pack it
28042 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
28045 * Unpack a child from a grid object
28047 * @param obj The grid object
28048 * @param subobj The child to unpack
28052 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
28055 * Faster way to remove all child objects from a grid object.
28057 * @param obj The grid object
28058 * @param clear If true, it will delete just removed children
28062 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28065 * Set packing of an existing child at to position and size
28067 * @param subobj The child to set packing of
28068 * @param x The virtual x coord at which to pack it
28069 * @param y The virtual y coord at which to pack it
28070 * @param w The virtual width at which to pack it
28071 * @param h The virtual height at which to pack it
28075 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28078 * get packing of a child
28080 * @param subobj The child to query
28081 * @param x Pointer to integer to store the virtual x coord
28082 * @param y Pointer to integer to store the virtual y coord
28083 * @param w Pointer to integer to store the virtual width
28084 * @param h Pointer to integer to store the virtual height
28088 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28094 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28095 EINA_DEPRECATED EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28096 EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28097 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28098 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
28099 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
28102 * @defgroup Video Video
28104 * @addtogroup Video
28107 * Elementary comes with two object that help design application that need
28108 * to display video. The main one, Elm_Video, display a video by using Emotion.
28109 * It does embedded the video inside an Edje object, so you can do some
28110 * animation depending on the video state change. It does also implement a
28111 * ressource management policy to remove this burden from the application writer.
28113 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28114 * It take care of updating its content according to Emotion event and provide a
28115 * way to theme itself. It also does automatically raise the priority of the
28116 * linked Elm_Video so it will use the video decoder if available. It also does
28117 * activate the remember function on the linked Elm_Video object.
28119 * Signals that you can add callback for are :
28121 * "forward,clicked" - the user clicked the forward button.
28122 * "info,clicked" - the user clicked the info button.
28123 * "next,clicked" - the user clicked the next button.
28124 * "pause,clicked" - the user clicked the pause button.
28125 * "play,clicked" - the user clicked the play button.
28126 * "prev,clicked" - the user clicked the prev button.
28127 * "rewind,clicked" - the user clicked the rewind button.
28128 * "stop,clicked" - the user clicked the stop button.
28130 * To set the video of the player, you can use elm_object_content_set() API.
28135 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28137 * @param parent The parent object
28138 * @return a new player widget handle or @c NULL, on errors.
28140 * This function inserts a new player widget on the canvas.
28142 * @see elm_object_content_set()
28146 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28149 * @brief Link a Elm_Payer with an Elm_Video object.
28151 * @param player the Elm_Player object.
28152 * @param video The Elm_Video object.
28154 * This mean that action on the player widget will affect the
28155 * video object and the state of the video will be reflected in
28156 * the player itself.
28158 * @see elm_player_add()
28159 * @see elm_video_add()
28163 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28166 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28168 * @param parent The parent object
28169 * @return a new video widget handle or @c NULL, on errors.
28171 * This function inserts a new video widget on the canvas.
28173 * @seeelm_video_file_set()
28174 * @see elm_video_uri_set()
28178 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28181 * @brief Define the file that will be the video source.
28183 * @param video The video object to define the file for.
28184 * @param filename The file to target.
28186 * This function will explicitly define a filename as a source
28187 * for the video of the Elm_Video object.
28189 * @see elm_video_uri_set()
28190 * @see elm_video_add()
28191 * @see elm_player_add()
28195 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28198 * @brief Define the uri that will be the video source.
28200 * @param video The video object to define the file for.
28201 * @param uri The uri to target.
28203 * This function will define an uri as a source for the video of the
28204 * Elm_Video object. URI could be remote source of video, like http:// or local source
28205 * like for example WebCam who are most of the time v4l2:// (but that depend and
28206 * you should use Emotion API to request and list the available Webcam on your system).
28208 * @see elm_video_file_set()
28209 * @see elm_video_add()
28210 * @see elm_player_add()
28214 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28217 * @brief Get the underlying Emotion object.
28219 * @param video The video object to proceed the request on.
28220 * @return the underlying Emotion object.
28224 EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28227 * @brief Start to play the video
28229 * @param video The video object to proceed the request on.
28231 * Start to play the video and cancel all suspend state.
28235 EAPI void elm_video_play(Evas_Object *video);
28238 * @brief Pause the video
28240 * @param video The video object to proceed the request on.
28242 * Pause the video and start a timer to trigger suspend mode.
28246 EAPI void elm_video_pause(Evas_Object *video);
28249 * @brief Stop the video
28251 * @param video The video object to proceed the request on.
28253 * Stop the video and put the emotion in deep sleep mode.
28257 EAPI void elm_video_stop(Evas_Object *video);
28260 * @brief Is the video actually playing.
28262 * @param video The video object to proceed the request on.
28263 * @return EINA_TRUE if the video is actually playing.
28265 * You should consider watching event on the object instead of polling
28266 * the object state.
28270 EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28273 * @brief Is it possible to seek inside the video.
28275 * @param video The video object to proceed the request on.
28276 * @return EINA_TRUE if is possible to seek inside the video.
28280 EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28283 * @brief Is the audio muted.
28285 * @param video The video object to proceed the request on.
28286 * @return EINA_TRUE if the audio is muted.
28290 EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28293 * @brief Change the mute state of the Elm_Video object.
28295 * @param video The video object to proceed the request on.
28296 * @param mute The new mute state.
28300 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28303 * @brief Get the audio level of the current video.
28305 * @param video The video object to proceed the request on.
28306 * @return the current audio level.
28310 EAPI double elm_video_audio_level_get(const Evas_Object *video);
28313 * @brief Set the audio level of anElm_Video object.
28315 * @param video The video object to proceed the request on.
28316 * @param volume The new audio volume.
28320 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28322 EAPI double elm_video_play_position_get(const Evas_Object *video);
28323 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28324 EAPI double elm_video_play_length_get(const Evas_Object *video);
28325 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28326 EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28327 EAPI const char *elm_video_title_get(const Evas_Object *video);
28332 // FIXME: incomplete - carousel. don't use this until this comment is removed
28333 typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
28334 EAPI Evas_Object *elm_carousel_add(Evas_Object *parent);
28335 EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
28336 EAPI void elm_carousel_item_del(Elm_Carousel_Item *item);
28337 EAPI void elm_carousel_item_select(Elm_Carousel_Item *item);
28338 /* smart callbacks called:
28339 * "clicked" - when the user clicks on a carousel item and becomes selected
28344 typedef enum _Elm_Datefield_ItemType
28346 ELM_DATEFIELD_YEAR = 0,
28347 ELM_DATEFIELD_MONTH,
28348 ELM_DATEFIELD_DATE,
28349 ELM_DATEFIELD_HOUR,
28350 ELM_DATEFIELD_MINUTE,
28352 } Elm_Datefield_ItemType;
28354 EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
28355 EAPI void elm_datefield_format_set(Evas_Object *obj, const char *fmt);
28356 EAPI char *elm_datefield_format_get(const Evas_Object *obj);
28357 EAPI void elm_datefield_item_enabled_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, Eina_Bool enable);
28358 EAPI Eina_Bool elm_datefield_item_enabled_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28359 EAPI void elm_datefield_item_value_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value);
28360 EAPI int elm_datefield_item_value_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28361 EAPI void elm_datefield_item_min_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28362 EAPI int elm_datefield_item_min_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28363 EAPI Eina_Bool elm_datefield_item_min_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28364 EAPI void elm_datefield_item_max_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28365 EAPI int elm_datefield_item_max_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28366 EAPI Eina_Bool elm_datefield_item_max_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28368 /* smart callbacks called:
28369 * "changed" - when datefield value is changed, this signal is sent.
28372 ////////////////////// DEPRECATED ///////////////////////////////////
28374 typedef enum _Elm_Datefield_Layout
28376 ELM_DATEFIELD_LAYOUT_TIME,
28377 ELM_DATEFIELD_LAYOUT_DATE,
28378 ELM_DATEFIELD_LAYOUT_DATEANDTIME
28379 } Elm_Datefield_Layout;
28381 EINA_DEPRECATED EAPI void elm_datefield_layout_set(Evas_Object *obj, Elm_Datefield_Layout layout);
28382 EINA_DEPRECATED EAPI Elm_Datefield_Layout elm_datefield_layout_get(const Evas_Object *obj);
28383 EINA_DEPRECATED EAPI void elm_datefield_date_format_set(Evas_Object *obj, const char *fmt);
28384 EINA_DEPRECATED EAPI const char *elm_datefield_date_format_get(const Evas_Object *obj);
28385 EINA_DEPRECATED EAPI void elm_datefield_time_mode_set(Evas_Object *obj, Eina_Bool mode);
28386 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_time_mode_get(const Evas_Object *obj);
28387 EINA_DEPRECATED EAPI void elm_datefield_date_set(Evas_Object *obj, int year, int month, int day, int hour, int min);
28388 EINA_DEPRECATED EAPI void elm_datefield_date_get(const Evas_Object *obj, int *year, int *month, int *day, int *hour, int *min);
28389 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_max_set(Evas_Object *obj, int year, int month, int day);
28390 EINA_DEPRECATED EAPI void elm_datefield_date_max_get(const Evas_Object *obj, int *year, int *month, int *day);
28391 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_min_set(Evas_Object *obj, int year, int month, int day);
28392 EINA_DEPRECATED EAPI void elm_datefield_date_min_get(const Evas_Object *obj, int *year, int *month, int *day);
28393 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);
28394 EINA_DEPRECATED EAPI void elm_datefield_input_panel_state_callback_del(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value));
28395 /////////////////////////////////////////////////////////////////////
28398 typedef enum _Elm_Popup_Response
28400 ELM_POPUP_RESPONSE_NONE = -1,
28401 ELM_POPUP_RESPONSE_TIMEOUT = -2,
28402 ELM_POPUP_RESPONSE_OK = -3,
28403 ELM_POPUP_RESPONSE_CANCEL = -4,
28404 ELM_POPUP_RESPONSE_CLOSE = -5
28405 } Elm_Popup_Response;
28407 typedef enum _Elm_Popup_Mode
28409 ELM_POPUP_TYPE_NONE = 0,
28410 ELM_POPUP_TYPE_ALERT = (1 << 0)
28413 typedef enum _Elm_Popup_Orient
28415 ELM_POPUP_ORIENT_TOP,
28416 ELM_POPUP_ORIENT_CENTER,
28417 ELM_POPUP_ORIENT_BOTTOM,
28418 ELM_POPUP_ORIENT_LEFT,
28419 ELM_POPUP_ORIENT_RIGHT,
28420 ELM_POPUP_ORIENT_TOP_LEFT,
28421 ELM_POPUP_ORIENT_TOP_RIGHT,
28422 ELM_POPUP_ORIENT_BOTTOM_LEFT,
28423 ELM_POPUP_ORIENT_BOTTOM_RIGHT
28424 } Elm_Popup_Orient;
28426 /* smart callbacks called:
28427 * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
28430 EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
28431 EAPI void elm_popup_desc_set(Evas_Object *obj, const char *text);
28432 EAPI const char *elm_popup_desc_get(Evas_Object *obj);
28433 EAPI void elm_popup_title_label_set(Evas_Object *obj, const char *text);
28434 EAPI const char *elm_popup_title_label_get(Evas_Object *obj);
28435 EAPI void elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
28436 EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
28437 EAPI void elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
28438 EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
28439 EAPI void elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text, ...);
28440 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, ... );
28441 EAPI void elm_popup_timeout_set(Evas_Object *obj, double timeout);
28442 EAPI void elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
28443 EAPI void elm_popup_response(Evas_Object *obj, int response_id);
28444 EAPI void elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
28445 EAPI int elm_popup_run(Evas_Object *obj);
28447 /* NavigationBar */
28448 #define NAVIBAR_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28449 #define NAVIBAR_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28453 ELM_NAVIGATIONBAR_FUNCTION_BUTTON1,
28454 ELM_NAVIGATIONBAR_FUNCTION_BUTTON2,
28455 ELM_NAVIGATIONBAR_FUNCTION_BUTTON3,
28456 ELM_NAVIGATIONBAR_BACK_BUTTON
28457 } Elm_Navi_Button_Type;
28459 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_add(Evas_Object *parent);
28460 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);
28461 EINA_DEPRECATED EAPI void elm_navigationbar_pop(Evas_Object *obj);
28462 EINA_DEPRECATED EAPI void elm_navigationbar_to_content_pop(Evas_Object *obj, Evas_Object *content);
28463 EINA_DEPRECATED EAPI void elm_navigationbar_title_label_set(Evas_Object *obj, Evas_Object *content, const char *title);
28464 EINA_DEPRECATED EAPI const char *elm_navigationbar_title_label_get(Evas_Object *obj, Evas_Object *content);
28465 EINA_DEPRECATED EAPI void elm_navigationbar_title_object_add(Evas_Object *obj, Evas_Object *content, Evas_Object *title_obj);
28466 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_title_object_get(Evas_Object *obj, Evas_Object *content);
28467 EINA_DEPRECATED EAPI Eina_List *elm_navigationbar_title_object_list_get(Evas_Object *obj, Evas_Object *content);
28468 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_content_top_get(Evas_Object *obj);
28469 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_content_bottom_get(Evas_Object *obj);
28470 EINA_DEPRECATED EAPI void elm_navigationbar_hidden_set(Evas_Object *obj, Eina_Bool hidden);
28471 EINA_DEPRECATED EAPI void elm_navigationbar_title_button_set(Evas_Object *obj, Evas_Object *content, Evas_Object *button, Elm_Navi_Button_Type button_type);
28472 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_title_button_get(Evas_Object *obj, Evas_Object *content, Elm_Navi_Button_Type button_type);
28473 EINA_DEPRECATED EAPI const char *elm_navigationbar_subtitle_label_get(Evas_Object *obj, Evas_Object *content);
28474 EINA_DEPRECATED EAPI void elm_navigationbar_subtitle_label_set(Evas_Object *obj, Evas_Object *content, const char *subtitle);
28475 EINA_DEPRECATED EAPI void elm_navigationbar_title_object_list_unset(Evas_Object *obj, Evas_Object *content, Eina_List **list);
28476 EINA_DEPRECATED EAPI void elm_navigationbar_animation_disabled_set(Evas_Object *obj, Eina_Bool disable);
28477 EINA_DEPRECATED EAPI void elm_navigationbar_title_object_visible_set(Evas_Object *obj, Evas_Object *content, Eina_Bool visible);
28478 EINA_DEPRECATED Eina_Bool elm_navigationbar_title_object_visible_get(Evas_Object *obj, Evas_Object *content);
28479 EINA_DEPRECATED EAPI void elm_navigationbar_title_icon_set(Evas_Object *obj, Evas_Object *content, Evas_Object *icon);
28480 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_title_icon_get(Evas_Object *obj, Evas_Object *content);
28482 /* NavigationBar */
28483 #define NAVIBAR_EX_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28484 #define NAVIBAR_EX_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28488 ELM_NAVIGATIONBAR_EX_BACK_BUTTON,
28489 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON1,
28490 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON2,
28491 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON3,
28492 ELM_NAVIGATIONBAR_EX_MAX
28493 } Elm_Navi_ex_Button_Type;
28494 typedef struct _Elm_Navigationbar_ex_Item Elm_Navigationbar_ex_Item;
28496 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_add(Evas_Object *parent);
28497 EINA_DEPRECATED EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_push(Evas_Object *obj, Evas_Object *content, const char *item_style);
28498 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_pop(Evas_Object *obj);
28499 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_promote(Elm_Navigationbar_ex_Item* item);
28500 EINA_DEPRECATED EAPI void elm_navigationbar_ex_to_item_pop(Elm_Navigationbar_ex_Item* item);
28501 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_title_label_set(Elm_Navigationbar_ex_Item *item, const char *title);
28502 EINA_DEPRECATED EAPI const char *elm_navigationbar_ex_item_title_label_get(Elm_Navigationbar_ex_Item* item);
28503 EINA_DEPRECATED EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_top_get(const Evas_Object *obj);
28504 EINA_DEPRECATED EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_bottom_get(const Evas_Object *obj);
28505 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);
28506 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_title_button_get(Elm_Navigationbar_ex_Item* item, int button_type);
28507 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_title_object_set(Elm_Navigationbar_ex_Item* item, Evas_Object *title_obj);
28508 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_title_object_unset(Elm_Navigationbar_ex_Item* item);
28509 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_title_hidden_set(Elm_Navigationbar_ex_Item* item, Eina_Bool hidden);
28510 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_title_object_get(Elm_Navigationbar_ex_Item* item);
28511 EINA_DEPRECATED EAPI const char *elm_navigationbar_ex_item_subtitle_label_get(Elm_Navigationbar_ex_Item* item);
28512 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_subtitle_label_set( Elm_Navigationbar_ex_Item* item, const char *subtitle);
28513 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_style_set(Elm_Navigationbar_ex_Item* item, const char* item_style);
28514 EINA_DEPRECATED EAPI const char *elm_navigationbar_ex_item_style_get(Elm_Navigationbar_ex_Item* item);
28515 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_content_unset(Elm_Navigationbar_ex_Item* item);
28516 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_content_get(Elm_Navigationbar_ex_Item* item);
28517 EINA_DEPRECATED EAPI void elm_navigationbar_ex_delete_on_pop_set(Evas_Object *obj, Eina_Bool del_on_pop);
28518 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_icon_get(Elm_Navigationbar_ex_Item* item);
28519 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_icon_set(Elm_Navigationbar_ex_Item* item, Evas_Object *icon);
28520 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_title_button_unset(Elm_Navigationbar_ex_Item* item, int button_type);
28521 EINA_DEPRECATED EAPI void elm_navigationbar_ex_animation_disable_set(Evas_Object *obj, Eina_Bool disable);
28522 EINA_DEPRECATED EAPI void elm_navigationbar_ex_title_object_visible_set(Elm_Navigationbar_ex_Item* item, Eina_Bool visible);
28523 EINA_DEPRECATED Eina_Bool elm_navigationbar_ex_title_object_visible_get(Elm_Navigationbar_ex_Item* item);
28526 * @defgroup Naviframe Naviframe
28527 * @ingroup Elementary
28529 * @brief Naviframe is a kind of view manager for the applications.
28531 * Naviframe provides functions to switch different pages with stack
28532 * mechanism. It means if one page(item) needs to be changed to the new one,
28533 * then naviframe would push the new page to it's internal stack. Of course,
28534 * it can be back to the previous page by popping the top page. Naviframe
28535 * provides some transition effect while the pages are switching (same as
28538 * Since each item could keep the different styles, users could keep the
28539 * same look & feel for the pages or different styles for the items in it's
28542 * Signals that you can add callback for are:
28543 * @li "transition,finished" - When the transition is finished in changing
28545 * @li "title,clicked" - User clicked title area
28547 * Default contents parts of the naviframe items that you can use for are:
28548 * @li "elm.swallow.content" - A main content of the page
28549 * @li "elm.swallow.icon" - A icon in the title area
28550 * @li "elm.swallow.prev_btn" - A button to go to the previous page
28551 * @li "elm.swallow.next_btn" - A button to go to the next page
28553 * Default text parts of the naviframe items that you can use for are:
28554 * @li "elm.text.title" - Title label in the title area
28555 * @li "elm.text.subtitle" - Sub-title label in the title area
28557 * @ref tutorial_naviframe gives a good overview of the usage of the API.
28560 //Available commonly
28561 #define ELM_NAVIFRAME_ITEM_CONTENT "elm.swallow.content"
28562 #define ELM_NAVIFRAME_ITEM_ICON "elm.swallow.icon"
28563 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER "elm.swallow.optionheader"
28564 #define ELM_NAVIFRAME_ITEM_TITLE_LABEL "elm.text.title"
28565 #define ELM_NAVIFRAME_ITEM_PREV_BTN "elm.swallow.prev_btn"
28566 #define ELM_NAVIFRAME_ITEM_TITLE_LEFT_BTN "elm.swallow.left_btn"
28567 #define ELM_NAVIFRAME_ITEM_TITLE_RIGHT_BTN "elm.swallow.right_btn"
28568 #define ELM_NAVIFRAME_ITEM_TITLE_MORE_BTN "elm.swallow.more_btn"
28569 #define ELM_NAVIFRAME_ITEM_CONTROLBAR "elm.swallow.controlbar"
28570 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_CLOSE "elm,state,optionheader,close", ""
28571 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_OPEN "elm,state,optionheader,open", ""
28572 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_CLOSE "elm,state,optionheader,instant_close", ""
28573 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_OPEN "elm,state,optionheader,instant_open", ""
28575 //Available only in a style - "2line"
28576 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER2 "elm.swallow.optionheader2"
28578 //Available only in a style - "segment"
28579 #define ELM_NAVIFRAME_ITEM_SEGMENT2 "elm.swallow.segment2"
28580 #define ELM_NAVIFRAME_ITEM_SEGMENT3 "elm.swallow.segment3"
28583 * @addtogroup Naviframe
28588 * @brief Add a new Naviframe object to the parent.
28590 * @param parent Parent object
28591 * @return New object or @c NULL, if it cannot be created
28593 * @ingroup Naviframe
28595 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28597 * @brief Push a new item to the top of the naviframe stack (and show it).
28599 * @param obj The naviframe object
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 pushed becomes one page of the naviframe, this item will be
28614 * deleted when it is popped.
28616 * @see also elm_naviframe_item_style_set()
28617 * @see also elm_naviframe_item_insert_before()
28618 * @see also elm_naviframe_item_insert_after()
28620 * The following styles are available for this item:
28623 * @ingroup Naviframe
28625 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);
28627 * @brief Insert a new item into the naviframe before item @p before.
28629 * @param before The naviframe item to insert before.
28630 * @param title_label The label in the title area. The name of the title
28631 * label part is "elm.text.title"
28632 * @param prev_btn The button to go to the previous item. If it is NULL,
28633 * then naviframe will create a back button automatically. The name of
28634 * the prev_btn part is "elm.swallow.prev_btn"
28635 * @param next_btn The button to go to the next item. Or It could be just an
28636 * extra function button. The name of the next_btn part is
28637 * "elm.swallow.next_btn"
28638 * @param content The main content object. The name of content part is
28639 * "elm.swallow.content"
28640 * @param item_style The current item style name. @c NULL would be default.
28641 * @return The created item or @c NULL upon failure.
28643 * The item is inserted into the naviframe straight away without any
28644 * transition operations. This item will be deleted when it is popped.
28646 * @see also elm_naviframe_item_style_set()
28647 * @see also elm_naviframe_item_push()
28648 * @see also elm_naviframe_item_insert_after()
28650 * The following styles are available for this item:
28653 * @ingroup Naviframe
28655 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);
28657 * @brief Insert a new item into the naviframe after item @p after.
28659 * @param after The naviframe item to insert after.
28660 * @param title_label The label in the title area. The name of the title
28661 * label part is "elm.text.title"
28662 * @param prev_btn The button to go to the previous item. If it is NULL,
28663 * then naviframe will create a back button automatically. The name of
28664 * the prev_btn part is "elm.swallow.prev_btn"
28665 * @param next_btn The button to go to the next item. Or It could be just an
28666 * extra function button. The name of the next_btn part is
28667 * "elm.swallow.next_btn"
28668 * @param content The main content object. The name of content part is
28669 * "elm.swallow.content"
28670 * @param item_style The current item style name. @c NULL would be default.
28671 * @return The created item or @c NULL upon failure.
28673 * The item is inserted into the naviframe straight away without any
28674 * transition operations. This item will be deleted when it is popped.
28676 * @see also elm_naviframe_item_style_set()
28677 * @see also elm_naviframe_item_push()
28678 * @see also elm_naviframe_item_insert_before()
28680 * The following styles are available for this item:
28683 * @ingroup Naviframe
28685 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);
28687 * @brief Pop an item that is on top of the stack
28689 * @param obj The naviframe object
28690 * @return @c NULL or the content object(if the
28691 * elm_naviframe_content_preserve_on_pop_get is true).
28693 * This pops an item that is on the top(visible) of the naviframe, makes it
28694 * disappear, then deletes the item. The item that was underneath it on the
28695 * stack will become visible.
28697 * @see also elm_naviframe_content_preserve_on_pop_get()
28699 * @ingroup Naviframe
28701 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28703 * @brief Pop the items between the top and the above one on the given item.
28705 * @param it The naviframe item
28707 * @ingroup Naviframe
28709 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28711 * Promote an item already in the naviframe stack to the top of the stack
28713 * @param it The naviframe item
28715 * This will take the indicated item and promote it to the top of the stack
28716 * as if it had been pushed there. The item must already be inside the
28717 * naviframe stack to work.
28720 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28722 * @brief Delete the given item instantly.
28724 * @param it The naviframe item
28726 * This just deletes the given item from the naviframe item list instantly.
28727 * So this would not emit any signals for view transitions but just change
28728 * the current view if the given item is a top one.
28730 * @ingroup Naviframe
28732 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28734 * @brief preserve the content objects when items are popped.
28736 * @param obj The naviframe object
28737 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28739 * @see also elm_naviframe_content_preserve_on_pop_get()
28741 * @ingroup Naviframe
28743 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28745 * @brief Get a value whether preserve mode is enabled or not.
28747 * @param obj The naviframe object
28748 * @return If @c EINA_TRUE, preserve mode is enabled
28750 * @see also elm_naviframe_content_preserve_on_pop_set()
28752 * @ingroup Naviframe
28754 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28756 * @brief Get a top item on the naviframe stack
28758 * @param obj The naviframe object
28759 * @return The top item on the naviframe stack or @c NULL, if the stack is
28762 * @ingroup Naviframe
28764 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28766 * @brief Get a bottom item on the naviframe stack
28768 * @param obj The naviframe object
28769 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28772 * @ingroup Naviframe
28774 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28776 * @brief Set an item style
28778 * @param obj The naviframe item
28779 * @param item_style The current item style name. @c NULL would be default
28781 * The following styles are available for this item:
28784 * @see also elm_naviframe_item_style_get()
28786 * @ingroup Naviframe
28788 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28790 * @brief Get an item style
28792 * @param obj The naviframe item
28793 * @return The current item style name
28795 * @see also elm_naviframe_item_style_set()
28797 * @ingroup Naviframe
28799 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28801 * @brief Show/Hide the title area
28803 * @param it The naviframe item
28804 * @param visible If @c EINA_TRUE, title area will be visible, hidden
28807 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
28809 * @see also elm_naviframe_item_title_visible_get()
28811 * @ingroup Naviframe
28813 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28815 * @brief Get a value whether title area is visible or not.
28817 * @param it The naviframe item
28818 * @return If @c EINA_TRUE, title area is visible
28820 * @see also elm_naviframe_item_title_visible_set()
28822 * @ingroup Naviframe
28824 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28827 * @brief Set creating prev button automatically or not
28829 * @param obj The naviframe object
28830 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28831 * be created internally when you pass the @c NULL to the prev_btn
28832 * parameter in elm_naviframe_item_push
28834 * @see also elm_naviframe_item_push()
28836 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28838 * @brief Get a value whether prev button(back button) will be auto pushed or
28841 * @param obj The naviframe object
28842 * @return If @c EINA_TRUE, prev button will be auto pushed.
28844 * @see also elm_naviframe_item_push()
28845 * elm_naviframe_prev_btn_auto_pushed_set()
28847 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28849 * @brief Get a list of all the naviframe items.
28851 * @param obj The naviframe object
28852 * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
28853 * or @c NULL on failure.
28855 EAPI Eina_Inlist *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28862 #define CONTROLBAR_SYSTEM_ICON_ALBUMS "controlbar_albums"
28863 #define CONTROLBAR_SYSTEM_ICON_ARTISTS "controlbar_artists"
28864 #define CONTROLBAR_SYSTEM_ICON_SONGS "controlbar_songs"
28865 #define CONTROLBAR_SYSTEM_ICON_PLAYLIST "controlbar_playlist"
28866 #define CONTROLBAR_SYSTEM_ICON_MORE "controlbar_more"
28867 #define CONTROLBAR_SYSTEM_ICON_CONTACTS "controlbar_contacts"
28868 #define CONTROLBAR_SYSTEM_ICON_DIALER "controlbar_dialer"
28869 #define CONTROLBAR_SYSTEM_ICON_FAVORITES "controlbar_favorites"
28870 #define CONTROLBAR_SYSTEM_ICON_LOGS "controlbar_logs"
28872 typedef enum _Elm_Controlbar_Mode_Type
28874 ELM_CONTROLBAR_MODE_DEFAULT = 0,
28875 ELM_CONTROLBAR_MODE_TRANSLUCENCE,
28876 ELM_CONTROLBAR_MODE_TRANSPARENCY,
28877 ELM_CONTROLBAR_MODE_LARGE,
28878 ELM_CONTROLBAR_MODE_SMALL,
28879 ELM_CONTROLBAR_MODE_LEFT,
28880 ELM_CONTROLBAR_MODE_RIGHT
28881 } Elm_Controlbar_Mode_Type;
28883 typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
28884 EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
28885 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
28886 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
28887 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);
28888 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);
28889 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);
28890 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);
28891 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);
28892 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);
28893 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
28894 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
28895 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
28896 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
28897 EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
28898 EAPI void elm_controlbar_item_del(Elm_Controlbar_Item *it);
28899 EAPI void elm_controlbar_item_select(Elm_Controlbar_Item *it);
28900 EAPI void elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
28901 EAPI Eina_Bool elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
28902 EAPI void elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
28903 EAPI Eina_Bool elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
28904 EAPI void elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
28905 EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
28906 EAPI void elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
28907 EAPI const char *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
28908 EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
28909 EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
28910 EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
28911 EAPI const Eina_List *elm_controlbar_items_get(const Evas_Object *obj);
28912 EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
28913 EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
28914 EAPI void elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
28915 EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
28916 EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
28917 EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
28918 EAPI void elm_controlbar_mode_set(Evas_Object *obj, int mode);
28919 EAPI void elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
28920 EAPI void elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
28921 EAPI void elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
28924 EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
28925 EAPI void elm_searchbar_text_set(Evas_Object *obj, const char *entry);
28926 EAPI const char *elm_searchbar_text_get(Evas_Object *obj);
28927 EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
28928 EAPI Evas_Object *elm_searchbar_editfield_get(Evas_Object *obj);
28929 EAPI void elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
28930 EAPI void elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
28931 EAPI void elm_searchbar_clear(Evas_Object *obj);
28932 EAPI void elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);
28934 EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
28935 EAPI void elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
28936 EAPI void elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
28937 EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
28940 EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
28941 EAPI void elm_nocontents_label_set(Evas_Object *obj, const char *label);
28942 EAPI const char *elm_nocontents_label_get(const Evas_Object *obj);
28943 EAPI void elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
28944 EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
28949 ELM_TICKERNOTI_ORIENT_TOP = 0,
28950 ELM_TICKERNOTI_ORIENT_BOTTOM,
28951 ELM_TICKERNOTI_ORIENT_LAST
28952 } Elm_Tickernoti_Orient;
28954 EAPI Evas_Object *elm_tickernoti_add (Evas_Object *parent);
28955 EAPI void elm_tickernoti_orient_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
28956 EAPI Elm_Tickernoti_Orient elm_tickernoti_orient_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28957 EAPI int elm_tickernoti_rotation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28958 EAPI void elm_tickernoti_rotation_set (Evas_Object *obj, int angle) EINA_ARG_NONNULL(1);
28959 EAPI Evas_Object *elm_tickernoti_win_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28960 /* #### Below APIs and data structures are going to be deprecated, announcment will be made soon ####*/
28963 ELM_TICKERNOTI_DEFAULT,
28964 ELM_TICKERNOTI_DETAILVIEW
28965 } Elm_Tickernoti_Mode;
28966 EAPI void elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
28967 EAPI const char *elm_tickernoti_detailview_label_get (const Evas_Object *obj)EINA_ARG_NONNULL(1);
28968 EAPI void elm_tickernoti_detailview_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(2);
28969 EAPI Evas_Object *elm_tickernoti_detailview_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28970 EAPI void elm_tickernoti_detailview_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
28971 EAPI Evas_Object *elm_tickernoti_detailview_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28972 EAPI Evas_Object *elm_tickernoti_detailview_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28973 EAPI void elm_tickernoti_mode_set (Evas_Object *obj, Elm_Tickernoti_Mode mode) EINA_ARG_NONNULL(1);
28974 EAPI Elm_Tickernoti_Mode elm_tickernoti_mode_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28975 EAPI void elm_tickernoti_orientation_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
28976 EAPI Elm_Tickernoti_Orient elm_tickernoti_orientation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28977 EAPI void elm_tickernoti_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
28978 EAPI const char *elm_tickernoti_label_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28979 EAPI void elm_tickernoti_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
28980 EAPI Evas_Object *elm_tickernoti_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28981 EAPI void elm_tickernoti_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(1);
28982 EAPI Evas_Object *elm_tickernoti_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28983 /* ############################################################################### */
28985 * Parts which can be used with elm_object_text_part_set() and
28986 * elm_object_text_part_get():
28988 * @li NULL/"default" - Operates on tickernoti content-text
28990 * Parts which can be used with elm_object_content_part_set(),
28991 * elm_object_content_part_get() and elm_object_content_part_unset():
28993 * @li "icon" - Operates on tickernoti's icon
28994 * @li "button" - Operates on tickernoti's button
28996 * smart callbacks called:
28997 * @li "clicked" - emitted when tickernoti is clicked, except at the
28998 * swallow/button region, if any.
28999 * @li "hide" - emitted when the tickernoti is completely hidden. In case of
29000 * any hide animation, this signal is emitted after the animation.
29004 typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
29006 struct _Colorpalette_Color
29008 unsigned int r, g, b;
29011 EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
29012 EAPI void elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
29013 EAPI void elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
29014 /* smart callbacks called:
29015 * "clicked" - when image clicked
29019 EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
29020 EAPI void elm_editfield_label_set(Evas_Object *obj, const char *label);
29021 EAPI const char *elm_editfield_label_get(Evas_Object *obj);
29022 EAPI void elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
29023 EAPI const char *elm_editfield_guide_text_get(Evas_Object *obj);
29024 EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
29025 // EAPI Evas_Object *elm_editfield_clear_button_show(Evas_Object *obj, Eina_Bool show);
29026 EAPI void elm_editfield_right_icon_set(Evas_Object *obj, Evas_Object *icon);
29027 EAPI Evas_Object *elm_editfield_right_icon_get(Evas_Object *obj);
29028 EAPI void elm_editfield_left_icon_set(Evas_Object *obj, Evas_Object *icon);
29029 EAPI Evas_Object *elm_editfield_left_icon_get(Evas_Object *obj);
29030 EAPI void elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
29031 EAPI Eina_Bool elm_editfield_entry_single_line_get(Evas_Object *obj);
29032 EAPI void elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
29033 EAPI Eina_Bool elm_editfield_eraser_get(Evas_Object *obj);
29034 /* smart callbacks called:
29035 * "clicked" - when an editfield is clicked
29036 * "unfocused" - when an editfield is unfocused
29040 /* Sliding Drawer */
29041 typedef enum _Elm_SlidingDrawer_Pos
29043 ELM_SLIDINGDRAWER_BOTTOM,
29044 ELM_SLIDINGDRAWER_LEFT,
29045 ELM_SLIDINGDRAWER_RIGHT,
29046 ELM_SLIDINGDRAWER_TOP
29047 } Elm_SlidingDrawer_Pos;
29049 typedef struct _Elm_SlidingDrawer_Drag_Value
29052 } Elm_SlidingDrawer_Drag_Value;
29054 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_add(Evas_Object *parent);
29055 EINA_DEPRECATED EAPI void elm_slidingdrawer_content_set (Evas_Object *obj, Evas_Object *content);
29056 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_content_unset(Evas_Object *obj);
29057 EINA_DEPRECATED EAPI void elm_slidingdrawer_pos_set(Evas_Object *obj, Elm_SlidingDrawer_Pos pos);
29058 EINA_DEPRECATED EAPI void elm_slidingdrawer_max_drag_value_set(Evas_Object *obj, double dw, double dh);
29059 EINA_DEPRECATED EAPI void elm_slidingdrawer_drag_value_set(Evas_Object *obj, double dx, double dy);
29061 /* multibuttonentry */
29062 typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
29063 typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
29064 EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent);
29065 EAPI const char *elm_multibuttonentry_label_get(const Evas_Object *obj);
29066 EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
29067 EAPI Evas_Object *elm_multibuttonentry_entry_get(const Evas_Object *obj);
29068 EAPI const char * elm_multibuttonentry_guide_text_get(const Evas_Object *obj);
29069 EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
29070 EAPI int elm_multibuttonentry_contracted_state_get(const Evas_Object *obj);
29071 EAPI void elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
29072 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
29073 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
29074 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
29075 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
29076 EAPI const Eina_List *elm_multibuttonentry_items_get(const Evas_Object *obj);
29077 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(const Evas_Object *obj);
29078 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(const Evas_Object *obj);
29079 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(const Evas_Object *obj);
29080 EAPI void elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
29081 EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
29082 EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
29083 EAPI void elm_multibuttonentry_items_del(Evas_Object *obj);
29084 EAPI const char *elm_multibuttonentry_item_label_get(const Elm_Multibuttonentry_Item *item);
29085 EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
29086 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
29087 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
29088 EAPI void *elm_multibuttonentry_item_data_get(const Elm_Multibuttonentry_Item *item);
29089 EAPI void elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
29090 EAPI void elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
29091 /* smart callback called:
29092 * "selected" - This signal is emitted when the selected item of multibuttonentry is changed.
29093 * "added" - This signal is emitted when a new multibuttonentry item is added.
29094 * "deleted" - This signal is emitted when a multibuttonentry item is deleted.
29095 * "expanded" - This signal is emitted when a multibuttonentry is expanded.
29096 * "contracted" - This signal is emitted when a multibuttonentry is contracted.
29097 * "contracted,state,changed" - This signal is emitted when the contracted state of multibuttonentry is changed.
29098 * "item,selected" - This signal is emitted when the selected item of multibuttonentry is changed.
29099 * "item,added" - This signal is emitted when a new multibuttonentry item is added.
29100 * "item,deleted" - This signal is emitted when a multibuttonentry item is deleted.
29101 * "item,clicked" - This signal is emitted when a multibuttonentry item is clicked.
29102 * "clicked" - This signal is emitted when a multibuttonentry is clicked.
29103 * "unfocused" - This signal is emitted when a multibuttonentry is unfocused.
29105 /* available styles:
29110 typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
29111 EAPI Evas_Object *elm_stackedicon_add(Evas_Object *parent);
29112 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
29113 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
29114 EAPI void elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
29115 EAPI Eina_List *elm_stackedicon_item_list_get(Evas_Object *obj);
29116 /* smart callback called:
29117 * "expanded" - This signal is emitted when a stackedicon is expanded.
29118 * "clicked" - This signal is emitted when a stackedicon is clicked.
29120 /* available styles:
29124 /* dialoguegroup */
29125 typedef struct _Dialogue_Item Dialogue_Item;
29127 typedef enum _Elm_Dialoguegourp_Item_Style
29129 ELM_DIALOGUEGROUP_ITEM_STYLE_DEFAULT = 0,
29130 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD = (1 << 0),
29131 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD_WITH_TITLE = (1 << 1),
29132 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_TITLE = (1 << 2),
29133 ELM_DIALOGUEGROUP_ITEM_STYLE_HIDDEN = (1 << 3),
29134 ELM_DIALOGUEGROUP_ITEM_STYLE_DATAVIEW = (1 << 4),
29135 ELM_DIALOGUEGROUP_ITEM_STYLE_NO_BG = (1 << 5),
29136 ELM_DIALOGUEGROUP_ITEM_STYLE_SUB = (1 << 6),
29137 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT = (1 << 7),
29138 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_MERGE = (1 << 8),
29139 ELM_DIALOGUEGROUP_ITEM_STYLE_LAST = (1 << 9)
29140 } Elm_Dialoguegroup_Item_Style;
29142 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_add(Evas_Object *parent);
29143 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_append(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
29144 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_prepend(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
29145 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_after(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *after, Elm_Dialoguegroup_Item_Style style);
29146 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_before(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *before, Elm_Dialoguegroup_Item_Style style);
29147 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove(Dialogue_Item *item);
29148 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove_all(Evas_Object *obj);
29149 EINA_DEPRECATED EAPI void elm_dialoguegroup_title_set(Evas_Object *obj, const char *title);
29150 EINA_DEPRECATED EAPI const char *elm_dialoguegroup_title_get(Evas_Object *obj);
29151 EINA_DEPRECATED EAPI void elm_dialoguegroup_press_effect_set(Dialogue_Item *item, Eina_Bool press);
29152 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_press_effect_get(Dialogue_Item *item);
29153 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_item_content_get(Dialogue_Item *item);
29154 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_style_set(Dialogue_Item *item, Elm_Dialoguegroup_Item_Style style);
29155 EINA_DEPRECATED EAPI Elm_Dialoguegroup_Item_Style elm_dialoguegroup_item_style_get(Dialogue_Item *item);
29156 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_disabled_set(Dialogue_Item *item, Eina_Bool disabled);
29157 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_item_disabled_get(Dialogue_Item *item);
29162 ELM_DAYSELECTOR_SUN,
29163 ELM_DAYSELECTOR_MON,
29164 ELM_DAYSELECTOR_TUE,
29165 ELM_DAYSELECTOR_WED,
29166 ELM_DAYSELECTOR_THU,
29167 ELM_DAYSELECTOR_FRI,
29168 ELM_DAYSELECTOR_SAT
29169 } Elm_DaySelector_Day;
29171 EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
29172 EAPI Eina_Bool elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
29173 EAPI void elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
29176 typedef struct _Imageslider_Item Elm_Imageslider_Item;
29177 typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
29178 EAPI Evas_Object *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
29179 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);
29180 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);
29181 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);
29182 EAPI void elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29183 EAPI Elm_Imageslider_Item *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
29184 EAPI Eina_Bool elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29185 EAPI void elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29186 EAPI const char *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29187 EAPI Elm_Imageslider_Item *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29188 EAPI Elm_Imageslider_Item *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29189 EAPI void elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
29190 EAPI void elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
29191 EAPI void elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
29192 EAPI void elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);