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);
897 EAPI Eina_Bool elm_need_ethumb(void);
900 * This must be called before any other function that handle with
901 * elm_web objects or ewk_view instances.
905 EAPI Eina_Bool elm_need_web(void);
908 * Set a new policy's value (for a given policy group/identifier).
910 * @param policy policy identifier, as in @ref Elm_Policy.
911 * @param value policy value, which depends on the identifier
913 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
915 * Elementary policies define applications' behavior,
916 * somehow. These behaviors are divided in policy groups (see
917 * #Elm_Policy enumeration). This call will emit the Ecore event
918 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
919 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
922 * @note Currently, we have only one policy identifier/group
923 * (#ELM_POLICY_QUIT), which has two possible values.
927 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
930 * Gets the policy value for given policy identifier.
932 * @param policy policy identifier, as in #Elm_Policy.
933 * @return The currently set policy value, for that
934 * identifier. Will be @c 0 if @p policy passed is invalid.
938 EAPI int elm_policy_get(unsigned int policy);
941 * Change the language of the current application
943 * The @p lang passed must be the full name of the locale to use, for
944 * example "en_US.utf8" or "es_ES@euro".
946 * Changing language with this function will make Elementary run through
947 * all its widgets, translating strings set with
948 * elm_object_domain_translatable_text_part_set(). This way, an entire
949 * UI can have its language changed without having to restart the program.
951 * For more complex cases, like having formatted strings that need
952 * translation, widgets will also emit a "language,changed" signal that
953 * the user can listen to to manually translate the text.
955 * @param lang Language to set, must be the full name of the locale
959 EAPI void elm_language_set(const char *lang);
962 * Set a label of an object
964 * @param obj The Elementary object
965 * @param part The text part name to set (NULL for the default label)
966 * @param label The new text of the label
968 * @note Elementary objects may have many labels (e.g. Action Slider)
972 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
974 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
977 * Get a label of an object
979 * @param obj The Elementary object
980 * @param part The text part name to get (NULL for the default label)
981 * @return text of the label or NULL for any error
983 * @note Elementary objects may have many labels (e.g. Action Slider)
987 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
989 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
992 * Set the text for an objects' part, marking it as translatable.
994 * The string to set as @p text must be the original one. Do not pass the
995 * return of @c gettext() here. Elementary will translate the string
996 * internally and set it on the object using elm_object_text_part_set(),
997 * also storing the original string so that it can be automatically
998 * translated when the language is changed with elm_language_set().
1000 * The @p domain will be stored along to find the translation in the
1001 * correct catalog. It can be NULL, in which case it will use whatever
1002 * domain was set by the application with @c textdomain(). This is useful
1003 * in case you are building a library on top of Elementary that will have
1004 * its own translatable strings, that should not be mixed with those of
1005 * programs using the library.
1007 * @param obj The object containing the text part
1008 * @param part The name of the part to set
1009 * @param domain The translation domain to use
1010 * @param text The original, non-translated text to set
1014 EAPI void elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1016 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1018 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1021 * Gets the original string set as translatable for an object
1023 * When setting translated strings, the function elm_object_text_part_get()
1024 * will return the translation returned by @c gettext(). To get the
1025 * original string use this function.
1027 * @param obj The object
1028 * @param part The name of the part that was set
1030 * @return The original, untranslated string
1034 EAPI const char *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1036 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1039 * Set a content of an object
1041 * @param obj The Elementary object
1042 * @param part The content part name to set (NULL for the default content)
1043 * @param content The new content of the object
1045 * @note Elementary objects may have many contents
1049 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1051 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
1054 * Get a content of an object
1056 * @param obj The Elementary object
1057 * @param item The content part name to get (NULL for the default content)
1058 * @return content of the object or NULL for any error
1060 * @note Elementary objects may have many contents
1064 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1066 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
1069 * Unset a content of an object
1071 * @param obj The Elementary object
1072 * @param item The content part name to unset (NULL for the default content)
1074 * @note Elementary objects may have many contents
1078 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1080 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1083 * Get the widget object's handle which contains a given item
1085 * @param item The Elementary object item
1086 * @return The widget object
1088 * @note This returns the widget object itself that an item belongs to.
1092 EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1095 * Set a content of an object item
1097 * @param it The Elementary object item
1098 * @param part The content part name to set (NULL for the default content)
1099 * @param content The new content of the object item
1101 * @note Elementary object items may have many contents
1105 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1107 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1110 * Get a content of an object item
1112 * @param it The Elementary object item
1113 * @param part The content part name to unset (NULL for the default content)
1114 * @return content of the object item or NULL for any error
1116 * @note Elementary object items may have many contents
1120 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1122 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1125 * Unset a content of an object item
1127 * @param it The Elementary object item
1128 * @param part The content part name to unset (NULL for the default content)
1130 * @note Elementary object items may have many contents
1134 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1136 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1139 * Set a label of an object item
1141 * @param it The Elementary object item
1142 * @param part The text part name to set (NULL for the default label)
1143 * @param label The new text of the label
1145 * @note Elementary object items may have many labels
1149 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1151 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1154 * Get a label of an object item
1156 * @param it The Elementary object item
1157 * @param part The text part name to get (NULL for the default label)
1158 * @return text of the label or NULL for any error
1160 * @note Elementary object items may have many labels
1164 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1166 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1169 * Set the text to read out when in accessibility mode
1171 * @param obj The object which is to be described
1172 * @param txt The text that describes the widget to people with poor or no vision
1176 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1179 * Set the text to read out when in accessibility mode
1181 * @param it The object item which is to be described
1182 * @param txt The text that describes the widget to people with poor or no vision
1186 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1189 * Get the data associated with an object item
1190 * @param it The object item
1191 * @return The data associated with @p it
1195 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1198 * Set the data associated with an object item
1199 * @param it The object item
1200 * @param data The data to be associated with @p it
1204 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1207 * Send a signal to the edje object of the widget item.
1209 * This function sends a signal to the edje object of the obj item. An
1210 * edje program can respond to a signal by specifying matching
1211 * 'signal' and 'source' fields.
1213 * @param it The Elementary object item
1214 * @param emission The signal's name.
1215 * @param source The signal's source.
1218 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1225 * @defgroup Caches Caches
1227 * These are functions which let one fine-tune some cache values for
1228 * Elementary applications, thus allowing for performance adjustments.
1234 * @brief Flush all caches.
1236 * Frees all data that was in cache and is not currently being used to reduce
1237 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1238 * to calling all of the following functions:
1239 * @li edje_file_cache_flush()
1240 * @li edje_collection_cache_flush()
1241 * @li eet_clearcache()
1242 * @li evas_image_cache_flush()
1243 * @li evas_font_cache_flush()
1244 * @li evas_render_dump()
1245 * @note Evas caches are flushed for every canvas associated with a window.
1249 EAPI void elm_all_flush(void);
1252 * Get the configured cache flush interval time
1254 * This gets the globally configured cache flush interval time, in
1257 * @return The cache flush interval time
1260 * @see elm_all_flush()
1262 EAPI int elm_cache_flush_interval_get(void);
1265 * Set the configured cache flush interval time
1267 * This sets the globally configured cache flush interval time, in ticks
1269 * @param size The cache flush interval time
1272 * @see elm_all_flush()
1274 EAPI void elm_cache_flush_interval_set(int size);
1277 * Set the configured cache flush interval time for all applications on the
1280 * This sets the globally configured cache flush interval time -- in ticks
1281 * -- for all applications on the display.
1283 * @param size The cache flush interval time
1286 EAPI void elm_cache_flush_interval_all_set(int size);
1289 * Get the configured cache flush enabled state
1291 * This gets the globally configured cache flush state - if it is enabled
1292 * or not. When cache flushing is enabled, elementary will regularly
1293 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1294 * memory and allow usage to re-seed caches and data in memory where it
1295 * can do so. An idle application will thus minimise its memory usage as
1296 * data will be freed from memory and not be re-loaded as it is idle and
1297 * not rendering or doing anything graphically right now.
1299 * @return The cache flush state
1302 * @see elm_all_flush()
1304 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1307 * Set the configured cache flush enabled state
1309 * This sets the globally configured cache flush enabled state.
1311 * @param size The cache flush enabled state
1314 * @see elm_all_flush()
1316 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1319 * Set the configured cache flush enabled state for all applications on the
1322 * This sets the globally configured cache flush enabled state for all
1323 * applications on the display.
1325 * @param size The cache flush enabled state
1328 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1331 * Get the configured font cache size
1333 * This gets the globally configured font cache size, in bytes.
1335 * @return The font cache size
1338 EAPI int elm_font_cache_get(void);
1341 * Set the configured font cache size
1343 * This sets the globally configured font cache size, in bytes
1345 * @param size The font cache size
1348 EAPI void elm_font_cache_set(int size);
1351 * Set the configured font cache size for all applications on the
1354 * This sets the globally configured font cache size -- in bytes
1355 * -- for all applications on the display.
1357 * @param size The font cache size
1360 EAPI void elm_font_cache_all_set(int size);
1363 * Get the configured image cache size
1365 * This gets the globally configured image cache size, in bytes
1367 * @return The image cache size
1370 EAPI int elm_image_cache_get(void);
1373 * Set the configured image cache size
1375 * This sets the globally configured image cache size, in bytes
1377 * @param size The image cache size
1380 EAPI void elm_image_cache_set(int size);
1383 * Set the configured image cache size for all applications on the
1386 * This sets the globally configured image cache size -- in bytes
1387 * -- for all applications on the display.
1389 * @param size The image cache size
1392 EAPI void elm_image_cache_all_set(int size);
1395 * Get the configured edje file cache size.
1397 * This gets the globally configured edje file cache size, in number
1400 * @return The edje file cache size
1403 EAPI int elm_edje_file_cache_get(void);
1406 * Set the configured edje file cache size
1408 * This sets the globally configured edje file cache size, in number
1411 * @param size The edje file cache size
1414 EAPI void elm_edje_file_cache_set(int size);
1417 * Set the configured edje file cache size for all applications on the
1420 * This sets the globally configured edje file cache size -- in number
1421 * of files -- for all applications on the display.
1423 * @param size The edje file cache size
1426 EAPI void elm_edje_file_cache_all_set(int size);
1429 * Get the configured edje collections (groups) cache size.
1431 * This gets the globally configured edje collections cache size, in
1432 * number of collections.
1434 * @return The edje collections cache size
1437 EAPI int elm_edje_collection_cache_get(void);
1440 * Set the configured edje collections (groups) cache size
1442 * This sets the globally configured edje collections cache size, in
1443 * number of collections.
1445 * @param size The edje collections cache size
1448 EAPI void elm_edje_collection_cache_set(int size);
1451 * Set the configured edje collections (groups) cache size for all
1452 * applications on the display
1454 * This sets the globally configured edje collections cache size -- in
1455 * number of collections -- for all applications on the display.
1457 * @param size The edje collections cache size
1460 EAPI void elm_edje_collection_cache_all_set(int size);
1467 * @defgroup Scaling Widget Scaling
1469 * Different widgets can be scaled independently. These functions
1470 * allow you to manipulate this scaling on a per-widget basis. The
1471 * object and all its children get their scaling factors multiplied
1472 * by the scale factor set. This is multiplicative, in that if a
1473 * child also has a scale size set it is in turn multiplied by its
1474 * parent's scale size. @c 1.0 means ādon't scaleā, @c 2.0 is
1475 * double size, @c 0.5 is half, etc.
1477 * @ref general_functions_example_page "This" example contemplates
1478 * some of these functions.
1482 * Get the global scaling factor
1484 * This gets the globally configured scaling factor that is applied to all
1487 * @return The scaling factor
1490 EAPI double elm_scale_get(void);
1493 * Set the global scaling factor
1495 * This sets the globally configured scaling factor that is applied to all
1498 * @param scale The scaling factor to set
1501 EAPI void elm_scale_set(double scale);
1504 * Set the global scaling factor for all applications on the display
1506 * This sets the globally configured scaling factor that is applied to all
1507 * objects for all applications.
1508 * @param scale The scaling factor to set
1511 EAPI void elm_scale_all_set(double scale);
1514 * Set the scaling factor for a given Elementary object
1516 * @param obj The Elementary to operate on
1517 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1522 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1525 * Get the scaling factor for a given Elementary object
1527 * @param obj The object
1528 * @return The scaling factor set by elm_object_scale_set()
1532 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1535 * @defgroup Password_last_show Password last input show
1537 * Last show feature of password mode enables user to view
1538 * the last input entered for few seconds before masking it.
1539 * These functions allow to set this feature in password mode
1540 * of entry widget and also allow to manipulate the duration
1541 * for which the input has to be visible.
1547 * Get show last setting of password mode.
1549 * This gets the show last input setting of password mode which might be
1550 * enabled or disabled.
1552 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1554 * @ingroup Password_last_show
1556 EAPI Eina_Bool elm_password_show_last_get(void);
1559 * Set show last setting in password mode.
1561 * This enables or disables show last setting of password mode.
1563 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1564 * @see elm_password_show_last_timeout_set()
1565 * @ingroup Password_last_show
1567 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1570 * Get's the timeout value in last show password mode.
1572 * This gets the time out value for which the last input entered in password
1573 * mode will be visible.
1575 * @return The timeout value of last show password mode.
1576 * @ingroup Password_last_show
1578 EAPI double elm_password_show_last_timeout_get(void);
1581 * Set's the timeout value in last show password mode.
1583 * This sets the time out value for which the last input entered in password
1584 * mode will be visible.
1586 * @param password_show_last_timeout The timeout value.
1587 * @see elm_password_show_last_set()
1588 * @ingroup Password_last_show
1590 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1597 * @defgroup UI-Mirroring Selective Widget mirroring
1599 * These functions allow you to set ui-mirroring on specific
1600 * widgets or the whole interface. Widgets can be in one of two
1601 * modes, automatic and manual. Automatic means they'll be changed
1602 * according to the system mirroring mode and manual means only
1603 * explicit changes will matter. You are not supposed to change
1604 * mirroring state of a widget set to automatic, will mostly work,
1605 * but the behavior is not really defined.
1610 EAPI Eina_Bool elm_mirrored_get(void);
1611 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1614 * Get the system mirrored mode. This determines the default mirrored mode
1617 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1619 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1622 * Set the system mirrored mode. This determines the default mirrored mode
1625 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1627 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1630 * Returns the widget's mirrored mode setting.
1632 * @param obj The widget.
1633 * @return mirrored mode setting of the object.
1636 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1639 * Sets the widget's mirrored mode setting.
1640 * When widget in automatic mode, it follows the system mirrored mode set by
1641 * elm_mirrored_set().
1642 * @param obj The widget.
1643 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1645 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1652 * Set the style to use by a widget
1654 * Sets the style name that will define the appearance of a widget. Styles
1655 * vary from widget to widget and may also be defined by other themes
1656 * by means of extensions and overlays.
1658 * @param obj The Elementary widget to style
1659 * @param style The style name to use
1661 * @see elm_theme_extension_add()
1662 * @see elm_theme_extension_del()
1663 * @see elm_theme_overlay_add()
1664 * @see elm_theme_overlay_del()
1668 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1670 * Get the style used by the widget
1672 * This gets the style being used for that widget. Note that the string
1673 * pointer is only valid as longas the object is valid and the style doesn't
1676 * @param obj The Elementary widget to query for its style
1677 * @return The style name used
1679 * @see elm_object_style_set()
1683 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1686 * @defgroup Styles Styles
1688 * Widgets can have different styles of look. These generic API's
1689 * set styles of widgets, if they support them (and if the theme(s)
1692 * @ref general_functions_example_page "This" example contemplates
1693 * some of these functions.
1697 * Set the disabled state of an Elementary object.
1699 * @param obj The Elementary object to operate on
1700 * @param disabled The state to put in in: @c EINA_TRUE for
1701 * disabled, @c EINA_FALSE for enabled
1703 * Elementary objects can be @b disabled, in which state they won't
1704 * receive input and, in general, will be themed differently from
1705 * their normal state, usually greyed out. Useful for contexts
1706 * where you don't want your users to interact with some of the
1707 * parts of you interface.
1709 * This sets the state for the widget, either disabling it or
1714 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1717 * Get the disabled state of an Elementary object.
1719 * @param obj The Elementary object to operate on
1720 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1721 * if it's enabled (or on errors)
1723 * This gets the state of the widget, which might be enabled or disabled.
1727 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1730 * @defgroup WidgetNavigation Widget Tree Navigation.
1732 * How to check if an Evas Object is an Elementary widget? How to
1733 * get the first elementary widget that is parent of the given
1734 * object? These are all covered in widget tree navigation.
1736 * @ref general_functions_example_page "This" example contemplates
1737 * some of these functions.
1741 * Check if the given Evas Object is an Elementary widget.
1743 * @param obj the object to query.
1744 * @return @c EINA_TRUE if it is an elementary widget variant,
1745 * @c EINA_FALSE otherwise
1746 * @ingroup WidgetNavigation
1748 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1751 * Get the first parent of the given object that is an Elementary
1754 * @param obj the Elementary object to query parent from.
1755 * @return the parent object that is an Elementary widget, or @c
1756 * NULL, if it was not found.
1758 * Use this to query for an object's parent widget.
1760 * @note Most of Elementary users wouldn't be mixing non-Elementary
1761 * smart objects in the objects tree of an application, as this is
1762 * an advanced usage of Elementary with Evas. So, except for the
1763 * application's window, which is the root of that tree, all other
1764 * objects would have valid Elementary widget parents.
1766 * @ingroup WidgetNavigation
1768 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1771 * Get the top level parent of an Elementary widget.
1773 * @param obj The object to query.
1774 * @return The top level Elementary widget, or @c NULL if parent cannot be
1776 * @ingroup WidgetNavigation
1778 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1781 * Get the string that represents this Elementary widget.
1783 * @note Elementary is weird and exposes itself as a single
1784 * Evas_Object_Smart_Class of type "elm_widget", so
1785 * evas_object_type_get() always return that, making debug and
1786 * language bindings hard. This function tries to mitigate this
1787 * problem, but the solution is to change Elementary to use
1788 * proper inheritance.
1790 * @param obj the object to query.
1791 * @return Elementary widget name, or @c NULL if not a valid widget.
1792 * @ingroup WidgetNavigation
1794 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1797 * @defgroup Config Elementary Config
1799 * Elementary configuration is formed by a set options bounded to a
1800 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1801 * "finger size", etc. These are functions with which one syncronizes
1802 * changes made to those values to the configuration storing files, de
1803 * facto. You most probably don't want to use the functions in this
1804 * group unlees you're writing an elementary configuration manager.
1810 * Save back Elementary's configuration, so that it will persist on
1813 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1816 * This function will take effect -- thus, do I/O -- immediately. Use
1817 * it when you want to apply all configuration changes at once. The
1818 * current configuration set will get saved onto the current profile
1819 * configuration file.
1822 EAPI Eina_Bool elm_config_save(void);
1825 * Reload Elementary's configuration, bounded to current selected
1828 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1831 * Useful when you want to force reloading of configuration values for
1832 * a profile. If one removes user custom configuration directories,
1833 * for example, it will force a reload with system values insted.
1836 EAPI void elm_config_reload(void);
1843 * @defgroup Profile Elementary Profile
1845 * Profiles are pre-set options that affect the whole look-and-feel of
1846 * Elementary-based applications. There are, for example, profiles
1847 * aimed at desktop computer applications and others aimed at mobile,
1848 * touchscreen-based ones. You most probably don't want to use the
1849 * functions in this group unlees you're writing an elementary
1850 * configuration manager.
1856 * Get Elementary's profile in use.
1858 * This gets the global profile that is applied to all Elementary
1861 * @return The profile's name
1864 EAPI const char *elm_profile_current_get(void);
1867 * Get an Elementary's profile directory path in the filesystem. One
1868 * may want to fetch a system profile's dir or an user one (fetched
1871 * @param profile The profile's name
1872 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1873 * or a system one (@c EINA_FALSE)
1874 * @return The profile's directory path.
1877 * @note You must free it with elm_profile_dir_free().
1879 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1882 * Free an Elementary's profile directory path, as returned by
1883 * elm_profile_dir_get().
1885 * @param p_dir The profile's path
1889 EAPI void elm_profile_dir_free(const char *p_dir);
1892 * Get Elementary's list of available profiles.
1894 * @return The profiles list. List node data are the profile name
1898 * @note One must free this list, after usage, with the function
1899 * elm_profile_list_free().
1901 EAPI Eina_List *elm_profile_list_get(void);
1904 * Free Elementary's list of available profiles.
1906 * @param l The profiles list, as returned by elm_profile_list_get().
1910 EAPI void elm_profile_list_free(Eina_List *l);
1913 * Set Elementary's profile.
1915 * This sets the global profile that is applied to Elementary
1916 * applications. Just the process the call comes from will be
1919 * @param profile The profile's name
1923 EAPI void elm_profile_set(const char *profile);
1926 * Set Elementary's profile.
1928 * This sets the global profile that is applied to all Elementary
1929 * applications. All running Elementary windows will be affected.
1931 * @param profile The profile's name
1935 EAPI void elm_profile_all_set(const char *profile);
1942 * @defgroup Engine Elementary Engine
1944 * These are functions setting and querying which rendering engine
1945 * Elementary will use for drawing its windows' pixels.
1947 * The following are the available engines:
1948 * @li "software_x11"
1951 * @li "software_16_x11"
1952 * @li "software_8_x11"
1955 * @li "software_gdi"
1956 * @li "software_16_wince_gdi"
1958 * @li "software_16_sdl"
1962 * @li "opengl_cocoa"
1969 * @brief Get Elementary's rendering engine in use.
1971 * @return The rendering engine's name
1972 * @note there's no need to free the returned string, here.
1974 * This gets the global rendering engine that is applied to all Elementary
1977 * @see elm_engine_set()
1979 EAPI const char *elm_engine_current_get(void);
1982 * @brief Set Elementary's rendering engine for use.
1984 * @param engine The rendering engine's name
1986 * This sets global rendering engine that is applied to all Elementary
1987 * applications. Note that it will take effect only to Elementary windows
1988 * created after this is called.
1990 * @see elm_win_add()
1992 EAPI void elm_engine_set(const char *engine);
1999 * @defgroup Fonts Elementary Fonts
2001 * These are functions dealing with font rendering, selection and the
2002 * like for Elementary applications. One might fetch which system
2003 * fonts are there to use and set custom fonts for individual classes
2004 * of UI items containing text (text classes).
2009 typedef struct _Elm_Text_Class
2015 typedef struct _Elm_Font_Overlay
2017 const char *text_class;
2019 Evas_Font_Size size;
2022 typedef struct _Elm_Font_Properties
2026 } Elm_Font_Properties;
2029 * Get Elementary's list of supported text classes.
2031 * @return The text classes list, with @c Elm_Text_Class blobs as data.
2034 * Release the list with elm_text_classes_list_free().
2036 EAPI const Eina_List *elm_text_classes_list_get(void);
2039 * Free Elementary's list of supported text classes.
2043 * @see elm_text_classes_list_get().
2045 EAPI void elm_text_classes_list_free(const Eina_List *list);
2048 * Get Elementary's list of font overlays, set with
2049 * elm_font_overlay_set().
2051 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2056 * For each text class, one can set a <b>font overlay</b> for it,
2057 * overriding the default font properties for that class coming from
2058 * the theme in use. There is no need to free this list.
2060 * @see elm_font_overlay_set() and elm_font_overlay_unset().
2062 EAPI const Eina_List *elm_font_overlay_list_get(void);
2065 * Set a font overlay for a given Elementary text class.
2067 * @param text_class Text class name
2068 * @param font Font name and style string
2069 * @param size Font size
2073 * @p font has to be in the format returned by
2074 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2075 * and elm_font_overlay_unset().
2077 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2080 * Unset a font overlay for a given Elementary text class.
2082 * @param text_class Text class name
2086 * This will bring back text elements belonging to text class
2087 * @p text_class back to their default font settings.
2089 EAPI void elm_font_overlay_unset(const char *text_class);
2092 * Apply the changes made with elm_font_overlay_set() and
2093 * elm_font_overlay_unset() on the current Elementary window.
2097 * This applies all font overlays set to all objects in the UI.
2099 EAPI void elm_font_overlay_apply(void);
2102 * Apply the changes made with elm_font_overlay_set() and
2103 * elm_font_overlay_unset() on all Elementary application windows.
2107 * This applies all font overlays set to all objects in the UI.
2109 EAPI void elm_font_overlay_all_apply(void);
2112 * Translate a font (family) name string in fontconfig's font names
2113 * syntax into an @c Elm_Font_Properties struct.
2115 * @param font The font name and styles string
2116 * @return the font properties struct
2120 * @note The reverse translation can be achived with
2121 * elm_font_fontconfig_name_get(), for one style only (single font
2122 * instance, not family).
2124 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2127 * Free font properties return by elm_font_properties_get().
2129 * @param efp the font properties struct
2133 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2136 * Translate a font name, bound to a style, into fontconfig's font names
2139 * @param name The font (family) name
2140 * @param style The given style (may be @c NULL)
2142 * @return the font name and style string
2146 * @note The reverse translation can be achived with
2147 * elm_font_properties_get(), for one style only (single font
2148 * instance, not family).
2150 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2153 * Free the font string return by elm_font_fontconfig_name_get().
2155 * @param efp the font properties struct
2159 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2162 * Create a font hash table of available system fonts.
2164 * One must call it with @p list being the return value of
2165 * evas_font_available_list(). The hash will be indexed by font
2166 * (family) names, being its values @c Elm_Font_Properties blobs.
2168 * @param list The list of available system fonts, as returned by
2169 * evas_font_available_list().
2170 * @return the font hash.
2174 * @note The user is supposed to get it populated at least with 3
2175 * default font families (Sans, Serif, Monospace), which should be
2176 * present on most systems.
2178 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2181 * Free the hash return by elm_font_available_hash_add().
2183 * @param hash the hash to be freed.
2187 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2194 * @defgroup Fingers Fingers
2196 * Elementary is designed to be finger-friendly for touchscreens,
2197 * and so in addition to scaling for display resolution, it can
2198 * also scale based on finger "resolution" (or size). You can then
2199 * customize the granularity of the areas meant to receive clicks
2202 * Different profiles may have pre-set values for finger sizes.
2204 * @ref general_functions_example_page "This" example contemplates
2205 * some of these functions.
2211 * Get the configured "finger size"
2213 * @return The finger size
2215 * This gets the globally configured finger size, <b>in pixels</b>
2219 EAPI Evas_Coord elm_finger_size_get(void);
2222 * Set the configured finger size
2224 * This sets the globally configured finger size in pixels
2226 * @param size The finger size
2229 EAPI void elm_finger_size_set(Evas_Coord size);
2232 * Set the configured finger size for all applications on the display
2234 * This sets the globally configured finger size in pixels for all
2235 * applications on the display
2237 * @param size The finger size
2240 EAPI void elm_finger_size_all_set(Evas_Coord size);
2247 * @defgroup Focus Focus
2249 * An Elementary application has, at all times, one (and only one)
2250 * @b focused object. This is what determines where the input
2251 * events go to within the application's window. Also, focused
2252 * objects can be decorated differently, in order to signal to the
2253 * user where the input is, at a given moment.
2255 * Elementary applications also have the concept of <b>focus
2256 * chain</b>: one can cycle through all the windows' focusable
2257 * objects by input (tab key) or programmatically. The default
2258 * focus chain for an application is the one define by the order in
2259 * which the widgets where added in code. One will cycle through
2260 * top level widgets, and, for each one containg sub-objects, cycle
2261 * through them all, before returning to the level
2262 * above. Elementary also allows one to set @b custom focus chains
2263 * for their applications.
2265 * Besides the focused decoration a widget may exhibit, when it
2266 * gets focus, Elementary has a @b global focus highlight object
2267 * that can be enabled for a window. If one chooses to do so, this
2268 * extra highlight effect will surround the current focused object,
2271 * @note Some Elementary widgets are @b unfocusable, after
2272 * creation, by their very nature: they are not meant to be
2273 * interacted with input events, but are there just for visual
2276 * @ref general_functions_example_page "This" example contemplates
2277 * some of these functions.
2281 * Get the enable status of the focus highlight
2283 * This gets whether the highlight on focused objects is enabled or not
2286 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2289 * Set the enable status of the focus highlight
2291 * Set whether to show or not the highlight on focused objects
2292 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2295 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2298 * Get the enable status of the highlight animation
2300 * Get whether the focus highlight, if enabled, will animate its switch from
2301 * one object to the next
2304 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2307 * Set the enable status of the highlight animation
2309 * Set whether the focus highlight, if enabled, will animate its switch from
2310 * one object to the next
2311 * @param animate Enable animation if EINA_TRUE, disable otherwise
2314 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2317 * Get the whether an Elementary object has the focus or not.
2319 * @param obj The Elementary object to get the information from
2320 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2321 * not (and on errors).
2323 * @see elm_object_focus_set()
2327 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2329 * Set/unset focus to a given Elementary object.
2331 * @param obj The Elementary object to operate on.
2332 * @param enable @c EINA_TRUE Set focus to a given object,
2333 * @c EINA_FALSE Unset focus to a given object.
2335 * @note When you set focus to this object, if it can handle focus, will
2336 * take the focus away from the one who had it previously and will, for
2337 * now on, be the one receiving input events. Unsetting focus will remove
2338 * the focus from @p obj, passing it back to the previous element in the
2341 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2345 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2348 * Make a given Elementary object the focused one.
2350 * @param obj The Elementary object to make focused.
2352 * @note This object, if it can handle focus, will take the focus
2353 * away from the one who had it previously and will, for now on, be
2354 * the one receiving input events.
2356 * @see elm_object_focus_get()
2360 EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2363 * Remove the focus from an Elementary object
2365 * @param obj The Elementary to take focus from
2367 * This removes the focus from @p obj, passing it back to the
2368 * previous element in the focus chain list.
2370 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2374 EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2377 * Set the ability for an Element object to be focused
2379 * @param obj The Elementary object to operate on
2380 * @param enable @c EINA_TRUE if the object can be focused, @c
2381 * EINA_FALSE if not (and on errors)
2383 * This sets whether the object @p obj is able to take focus or
2384 * not. Unfocusable objects do nothing when programmatically
2385 * focused, being the nearest focusable parent object the one
2386 * really getting focus. Also, when they receive mouse input, they
2387 * will get the event, but not take away the focus from where it
2392 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2395 * Get whether an Elementary object is focusable or not
2397 * @param obj The Elementary object to operate on
2398 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2399 * EINA_FALSE if not (and on errors)
2401 * @note Objects which are meant to be interacted with by input
2402 * events are created able to be focused, by default. All the
2407 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2410 * Set custom focus chain.
2412 * This function overwrites any previous custom focus chain within
2413 * the list of objects. The previous list will be deleted and this list
2414 * will be managed by elementary. After it is set, don't modify it.
2416 * @note On focus cycle, only will be evaluated children of this container.
2418 * @param obj The container object
2419 * @param objs Chain of objects to pass focus
2422 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2425 * Unset a custom focus chain on a given Elementary widget
2427 * @param obj The container object to remove focus chain from
2429 * Any focus chain previously set on @p obj (for its child objects)
2430 * is removed entirely after this call.
2434 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2437 * Get custom focus chain
2439 * @param obj The container object
2442 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2445 * Append object to custom focus chain.
2447 * @note If relative_child equal to NULL or not in custom chain, the object
2448 * will be added in end.
2450 * @note On focus cycle, only will be evaluated children of this container.
2452 * @param obj The container object
2453 * @param child The child to be added in custom chain
2454 * @param relative_child The relative object to position the child
2457 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2460 * Prepend object to custom focus chain.
2462 * @note If relative_child equal to NULL or not in custom chain, the object
2463 * will be added in begin.
2465 * @note On focus cycle, only will be evaluated children of this container.
2467 * @param obj The container object
2468 * @param child The child to be added in custom chain
2469 * @param relative_child The relative object to position the child
2472 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2475 * Give focus to next object in object tree.
2477 * Give focus to next object in focus chain of one object sub-tree.
2478 * If the last object of chain already have focus, the focus will go to the
2479 * first object of chain.
2481 * @param obj The object root of sub-tree
2482 * @param dir Direction to cycle the focus
2486 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2489 * Give focus to near object in one direction.
2491 * Give focus to near object in direction of one object.
2492 * If none focusable object in given direction, the focus will not change.
2494 * @param obj The reference object
2495 * @param x Horizontal component of direction to focus
2496 * @param y Vertical component of direction to focus
2500 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2503 * Make the elementary object and its children to be unfocusable
2506 * @param obj The Elementary object to operate on
2507 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2508 * @c EINA_FALSE for focusable.
2510 * This sets whether the object @p obj and its children objects
2511 * are able to take focus or not. If the tree is set as unfocusable,
2512 * newest focused object which is not in this tree will get focus.
2513 * This API can be helpful for an object to be deleted.
2514 * When an object will be deleted soon, it and its children may not
2515 * want to get focus (by focus reverting or by other focus controls).
2516 * Then, just use this API before deleting.
2518 * @see elm_object_tree_unfocusable_get()
2522 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2525 * Get whether an Elementary object and its children are unfocusable or not.
2527 * @param obj The Elementary object to get the information from
2528 * @return @c EINA_TRUE, if the tree is unfocussable,
2529 * @c EINA_FALSE if not (and on errors).
2531 * @see elm_object_tree_unfocusable_set()
2535 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2538 * @defgroup Scrolling Scrolling
2540 * These are functions setting how scrollable views in Elementary
2541 * widgets should behave on user interaction.
2547 * Get whether scrollers should bounce when they reach their
2548 * viewport's edge during a scroll.
2550 * @return the thumb scroll bouncing state
2552 * This is the default behavior for touch screens, in general.
2553 * @ingroup Scrolling
2555 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2558 * Set whether scrollers should bounce when they reach their
2559 * viewport's edge during a scroll.
2561 * @param enabled the thumb scroll bouncing state
2563 * @see elm_thumbscroll_bounce_enabled_get()
2564 * @ingroup Scrolling
2566 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2569 * Set whether scrollers should bounce when they reach their
2570 * viewport's edge during a scroll, for all Elementary application
2573 * @param enabled the thumb scroll bouncing state
2575 * @see elm_thumbscroll_bounce_enabled_get()
2576 * @ingroup Scrolling
2578 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2581 * Get the amount of inertia a scroller will impose at bounce
2584 * @return the thumb scroll bounce friction
2586 * @ingroup Scrolling
2588 EAPI double elm_scroll_bounce_friction_get(void);
2591 * Set the amount of inertia a scroller will impose at bounce
2594 * @param friction the thumb scroll bounce friction
2596 * @see elm_thumbscroll_bounce_friction_get()
2597 * @ingroup Scrolling
2599 EAPI void elm_scroll_bounce_friction_set(double friction);
2602 * Set the amount of inertia a scroller will impose at bounce
2603 * animations, for all Elementary application windows.
2605 * @param friction the thumb scroll bounce friction
2607 * @see elm_thumbscroll_bounce_friction_get()
2608 * @ingroup Scrolling
2610 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2613 * Get the amount of inertia a <b>paged</b> scroller will impose at
2614 * page fitting animations.
2616 * @return the page scroll friction
2618 * @ingroup Scrolling
2620 EAPI double elm_scroll_page_scroll_friction_get(void);
2623 * Set the amount of inertia a <b>paged</b> scroller will impose at
2624 * page fitting animations.
2626 * @param friction the page scroll friction
2628 * @see elm_thumbscroll_page_scroll_friction_get()
2629 * @ingroup Scrolling
2631 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2634 * Set the amount of inertia a <b>paged</b> scroller will impose at
2635 * page fitting animations, for all Elementary application windows.
2637 * @param friction the page scroll friction
2639 * @see elm_thumbscroll_page_scroll_friction_get()
2640 * @ingroup Scrolling
2642 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2645 * Get the amount of inertia a scroller will impose at region bring
2648 * @return the bring in scroll friction
2650 * @ingroup Scrolling
2652 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2655 * Set the amount of inertia a scroller will impose at region bring
2658 * @param friction the bring in scroll friction
2660 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2661 * @ingroup Scrolling
2663 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2666 * Set the amount of inertia a scroller will impose at region bring
2667 * animations, for all Elementary application windows.
2669 * @param friction the bring in scroll friction
2671 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2672 * @ingroup Scrolling
2674 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2677 * Get the amount of inertia scrollers will impose at animations
2678 * triggered by Elementary widgets' zooming API.
2680 * @return the zoom friction
2682 * @ingroup Scrolling
2684 EAPI double elm_scroll_zoom_friction_get(void);
2687 * Set the amount of inertia scrollers will impose at animations
2688 * triggered by Elementary widgets' zooming API.
2690 * @param friction the zoom friction
2692 * @see elm_thumbscroll_zoom_friction_get()
2693 * @ingroup Scrolling
2695 EAPI void elm_scroll_zoom_friction_set(double friction);
2698 * Set the amount of inertia scrollers will impose at animations
2699 * triggered by Elementary widgets' zooming API, for all Elementary
2700 * application windows.
2702 * @param friction the zoom friction
2704 * @see elm_thumbscroll_zoom_friction_get()
2705 * @ingroup Scrolling
2707 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2710 * Get whether scrollers should be draggable from any point in their
2713 * @return the thumb scroll state
2715 * @note This is the default behavior for touch screens, in general.
2716 * @note All other functions namespaced with "thumbscroll" will only
2717 * have effect if this mode is enabled.
2719 * @ingroup Scrolling
2721 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2724 * Set whether scrollers should be draggable from any point in their
2727 * @param enabled the thumb scroll state
2729 * @see elm_thumbscroll_enabled_get()
2730 * @ingroup Scrolling
2732 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2735 * Set whether scrollers should be draggable from any point in their
2736 * views, for all Elementary application windows.
2738 * @param enabled the thumb scroll state
2740 * @see elm_thumbscroll_enabled_get()
2741 * @ingroup Scrolling
2743 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2746 * Get the number of pixels one should travel while dragging a
2747 * scroller's view to actually trigger scrolling.
2749 * @return the thumb scroll threshould
2751 * One would use higher values for touch screens, in general, because
2752 * of their inherent imprecision.
2753 * @ingroup Scrolling
2755 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2758 * Set the number of pixels one should travel while dragging a
2759 * scroller's view to actually trigger scrolling.
2761 * @param threshold the thumb scroll threshould
2763 * @see elm_thumbscroll_threshould_get()
2764 * @ingroup Scrolling
2766 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2769 * Set the number of pixels one should travel while dragging a
2770 * scroller's view to actually trigger scrolling, for all Elementary
2771 * application windows.
2773 * @param threshold the thumb scroll threshould
2775 * @see elm_thumbscroll_threshould_get()
2776 * @ingroup Scrolling
2778 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2781 * Get the minimum speed of mouse cursor movement which will trigger
2782 * list self scrolling animation after a mouse up event
2785 * @return the thumb scroll momentum threshould
2787 * @ingroup Scrolling
2789 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2792 * Set the minimum speed of mouse cursor movement which will trigger
2793 * list self scrolling animation after a mouse up event
2796 * @param threshold the thumb scroll momentum threshould
2798 * @see elm_thumbscroll_momentum_threshould_get()
2799 * @ingroup Scrolling
2801 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2804 * Set the minimum speed of mouse cursor movement which will trigger
2805 * list self scrolling animation after a mouse up event
2806 * (pixels/second), for all Elementary application windows.
2808 * @param threshold the thumb scroll momentum threshould
2810 * @see elm_thumbscroll_momentum_threshould_get()
2811 * @ingroup Scrolling
2813 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2816 * Get the amount of inertia a scroller will impose at self scrolling
2819 * @return the thumb scroll friction
2821 * @ingroup Scrolling
2823 EAPI double elm_scroll_thumbscroll_friction_get(void);
2826 * Set the amount of inertia a scroller will impose at self scrolling
2829 * @param friction the thumb scroll friction
2831 * @see elm_thumbscroll_friction_get()
2832 * @ingroup Scrolling
2834 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
2837 * Set the amount of inertia a scroller will impose at self scrolling
2838 * animations, for all Elementary application windows.
2840 * @param friction the thumb scroll friction
2842 * @see elm_thumbscroll_friction_get()
2843 * @ingroup Scrolling
2845 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
2848 * Get the amount of lag between your actual mouse cursor dragging
2849 * movement and a scroller's view movement itself, while pushing it
2850 * into bounce state manually.
2852 * @return the thumb scroll border friction
2854 * @ingroup Scrolling
2856 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
2859 * Set the amount of lag between your actual mouse cursor dragging
2860 * movement and a scroller's view movement itself, while pushing it
2861 * into bounce state manually.
2863 * @param friction the thumb scroll border friction. @c 0.0 for
2864 * perfect synchrony between two movements, @c 1.0 for maximum
2867 * @see elm_thumbscroll_border_friction_get()
2868 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2870 * @ingroup Scrolling
2872 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
2875 * Set the amount of lag between your actual mouse cursor dragging
2876 * movement and a scroller's view movement itself, while pushing it
2877 * into bounce state manually, for all Elementary application windows.
2879 * @param friction the thumb scroll border friction. @c 0.0 for
2880 * perfect synchrony between two movements, @c 1.0 for maximum
2883 * @see elm_thumbscroll_border_friction_get()
2884 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2886 * @ingroup Scrolling
2888 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
2891 * Get the sensitivity amount which is be multiplied by the length of
2894 * @return the thumb scroll sensitivity friction
2896 * @ingroup Scrolling
2898 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
2901 * Set the sensitivity amount which is be multiplied by the length of
2904 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2905 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2908 * @see elm_thumbscroll_sensitivity_friction_get()
2909 * @note parameter value will get bound to 0.1 - 1.0 interval, always
2911 * @ingroup Scrolling
2913 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
2916 * Set the sensitivity amount which is be multiplied by the length of
2917 * mouse dragging, for all Elementary application windows.
2919 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2920 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2923 * @see elm_thumbscroll_sensitivity_friction_get()
2924 * @note parameter value will get bound to 0.1 - 1.0 interval, always
2926 * @ingroup Scrolling
2928 EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
2935 * @defgroup Scrollhints Scrollhints
2937 * Objects when inside a scroller can scroll, but this may not always be
2938 * desirable in certain situations. This allows an object to hint to itself
2939 * and parents to "not scroll" in one of 2 ways. If any child object of a
2940 * scroller has pushed a scroll freeze or hold then it affects all parent
2941 * scrollers until all children have released them.
2943 * 1. To hold on scrolling. This means just flicking and dragging may no
2944 * longer scroll, but pressing/dragging near an edge of the scroller will
2945 * still scroll. This is automatically used by the entry object when
2948 * 2. To totally freeze scrolling. This means it stops. until
2955 * Push the scroll hold by 1
2957 * This increments the scroll hold count by one. If it is more than 0 it will
2958 * take effect on the parents of the indicated object.
2960 * @param obj The object
2961 * @ingroup Scrollhints
2963 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2966 * Pop the scroll hold by 1
2968 * This decrements the scroll hold count by one. If it is more than 0 it will
2969 * take effect on the parents of the indicated object.
2971 * @param obj The object
2972 * @ingroup Scrollhints
2974 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2977 * Push the scroll freeze by 1
2979 * This increments the scroll freeze count by one. If it is more
2980 * than 0 it will take effect on the parents of the indicated
2983 * @param obj The object
2984 * @ingroup Scrollhints
2986 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2989 * Pop the scroll freeze by 1
2991 * This decrements the scroll freeze count by one. If it is more
2992 * than 0 it will take effect on the parents of the indicated
2995 * @param obj The object
2996 * @ingroup Scrollhints
2998 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3001 * Lock the scrolling of the given widget (and thus all parents)
3003 * This locks the given object from scrolling in the X axis (and implicitly
3004 * also locks all parent scrollers too from doing the same).
3006 * @param obj The object
3007 * @param lock The lock state (1 == locked, 0 == unlocked)
3008 * @ingroup Scrollhints
3010 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3013 * Lock the scrolling of the given widget (and thus all parents)
3015 * This locks the given object from scrolling in the Y axis (and implicitly
3016 * also locks all parent scrollers too from doing the same).
3018 * @param obj The object
3019 * @param lock The lock state (1 == locked, 0 == unlocked)
3020 * @ingroup Scrollhints
3022 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3025 * Get the scrolling lock of the given widget
3027 * This gets the lock for X axis scrolling.
3029 * @param obj The object
3030 * @ingroup Scrollhints
3032 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3035 * Get the scrolling lock of the given widget
3037 * This gets the lock for X axis scrolling.
3039 * @param obj The object
3040 * @ingroup Scrollhints
3042 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3049 * Send a signal to the widget edje object.
3051 * This function sends a signal to the edje object of the obj. An
3052 * edje program can respond to a signal by specifying matching
3053 * 'signal' and 'source' fields.
3055 * @param obj The object
3056 * @param emission The signal's name.
3057 * @param source The signal's source.
3060 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3063 * Add a callback for a signal emitted by widget edje object.
3065 * This function connects a callback function to a signal emitted by the
3066 * edje object of the obj.
3067 * Globs can occur in either the emission or source name.
3069 * @param obj The object
3070 * @param emission The signal's name.
3071 * @param source The signal's source.
3072 * @param func The callback function to be executed when the signal is
3074 * @param data A pointer to data to pass in to the callback function.
3077 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);
3080 * Remove a signal-triggered callback from a widget edje object.
3082 * This function removes a callback, previoulsy attached to a
3083 * signal emitted by the edje object of the obj. The parameters
3084 * emission, source and func must match exactly those passed to a
3085 * previous call to elm_object_signal_callback_add(). The data
3086 * pointer that was passed to this call will be returned.
3088 * @param obj The object
3089 * @param emission The signal's name.
3090 * @param source The signal's source.
3091 * @param func The callback function to be executed when the signal is
3093 * @return The data pointer
3096 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);
3099 * Add a callback for input events (key up, key down, mouse wheel)
3100 * on a given Elementary widget
3102 * @param obj The widget to add an event callback on
3103 * @param func The callback function to be executed when the event
3105 * @param data Data to pass in to @p func
3107 * Every widget in an Elementary interface set to receive focus,
3108 * with elm_object_focus_allow_set(), will propagate @b all of its
3109 * key up, key down and mouse wheel input events up to its parent
3110 * object, and so on. All of the focusable ones in this chain which
3111 * had an event callback set, with this call, will be able to treat
3112 * those events. There are two ways of making the propagation of
3113 * these event upwards in the tree of widgets to @b cease:
3114 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3115 * the event was @b not processed, so the propagation will go on.
3116 * - The @c event_info pointer passed to @p func will contain the
3117 * event's structure and, if you OR its @c event_flags inner
3118 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3119 * one has already handled it, thus killing the event's
3122 * @note Your event callback will be issued on those events taking
3123 * place only if no other child widget of @obj has consumed the
3126 * @note Not to be confused with @c
3127 * evas_object_event_callback_add(), which will add event callbacks
3128 * per type on general Evas objects (no event propagation
3129 * infrastructure taken in account).
3131 * @note Not to be confused with @c
3132 * elm_object_signal_callback_add(), which will add callbacks to @b
3133 * signals coming from a widget's theme, not input events.
3135 * @note Not to be confused with @c
3136 * edje_object_signal_callback_add(), which does the same as
3137 * elm_object_signal_callback_add(), but directly on an Edje
3140 * @note Not to be confused with @c
3141 * evas_object_smart_callback_add(), which adds callbacks to smart
3142 * objects' <b>smart events</b>, and not input events.
3144 * @see elm_object_event_callback_del()
3148 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3151 * Remove an event callback from a widget.
3153 * This function removes a callback, previoulsy attached to event emission
3155 * The parameters func and data must match exactly those passed to
3156 * a previous call to elm_object_event_callback_add(). The data pointer that
3157 * was passed to this call will be returned.
3159 * @param obj The object
3160 * @param func The callback function to be executed when the event is
3162 * @param data Data to pass in to the callback function.
3163 * @return The data pointer
3166 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3169 * Adjust size of an element for finger usage.
3171 * @param times_w How many fingers should fit horizontally
3172 * @param w Pointer to the width size to adjust
3173 * @param times_h How many fingers should fit vertically
3174 * @param h Pointer to the height size to adjust
3176 * This takes width and height sizes (in pixels) as input and a
3177 * size multiple (which is how many fingers you want to place
3178 * within the area, being "finger" the size set by
3179 * elm_finger_size_set()), and adjusts the size to be large enough
3180 * to accommodate the resulting size -- if it doesn't already
3181 * accommodate it. On return the @p w and @p h sizes pointed to by
3182 * these parameters will be modified, on those conditions.
3184 * @note This is kind of a low level Elementary call, most useful
3185 * on size evaluation times for widgets. An external user wouldn't
3186 * be calling, most of the time.
3190 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3193 * Get the duration for occuring long press event.
3195 * @return Timeout for long press event
3196 * @ingroup Longpress
3198 EAPI double elm_longpress_timeout_get(void);
3201 * Set the duration for occuring long press event.
3203 * @param lonpress_timeout Timeout for long press event
3204 * @ingroup Longpress
3206 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3209 * @defgroup Debug Debug
3210 * don't use it unless you are sure
3216 * Print Tree object hierarchy in stdout
3218 * @param obj The root object
3221 EAPI void elm_object_tree_dump(const Evas_Object *top);
3222 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3224 EAPI void elm_autocapitalization_allow_all_set(Eina_Bool autocap);
3225 EAPI void elm_autoperiod_allow_all_set(Eina_Bool autoperiod);
3227 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3229 * @param obj The root object
3230 * @param file The path of output file
3233 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3240 * @defgroup Theme Theme
3242 * Elementary uses Edje to theme its widgets, naturally. But for the most
3243 * part this is hidden behind a simpler interface that lets the user set
3244 * extensions and choose the style of widgets in a much easier way.
3246 * Instead of thinking in terms of paths to Edje files and their groups
3247 * each time you want to change the appearance of a widget, Elementary
3248 * works so you can add any theme file with extensions or replace the
3249 * main theme at one point in the application, and then just set the style
3250 * of widgets with elm_object_style_set() and related functions. Elementary
3251 * will then look in its list of themes for a matching group and apply it,
3252 * and when the theme changes midway through the application, all widgets
3253 * will be updated accordingly.
3255 * There are three concepts you need to know to understand how Elementary
3256 * theming works: default theme, extensions and overlays.
3258 * Default theme, obviously enough, is the one that provides the default
3259 * look of all widgets. End users can change the theme used by Elementary
3260 * by setting the @c ELM_THEME environment variable before running an
3261 * application, or globally for all programs using the @c elementary_config
3262 * utility. Applications can change the default theme using elm_theme_set(),
3263 * but this can go against the user wishes, so it's not an adviced practice.
3265 * Ideally, applications should find everything they need in the already
3266 * provided theme, but there may be occasions when that's not enough and
3267 * custom styles are required to correctly express the idea. For this
3268 * cases, Elementary has extensions.
3270 * Extensions allow the application developer to write styles of its own
3271 * to apply to some widgets. This requires knowledge of how each widget
3272 * is themed, as extensions will always replace the entire group used by
3273 * the widget, so important signals and parts need to be there for the
3274 * object to behave properly (see documentation of Edje for details).
3275 * Once the theme for the extension is done, the application needs to add
3276 * it to the list of themes Elementary will look into, using
3277 * elm_theme_extension_add(), and set the style of the desired widgets as
3278 * he would normally with elm_object_style_set().
3280 * Overlays, on the other hand, can replace the look of all widgets by
3281 * overriding the default style. Like extensions, it's up to the application
3282 * developer to write the theme for the widgets it wants, the difference
3283 * being that when looking for the theme, Elementary will check first the
3284 * list of overlays, then the set theme and lastly the list of extensions,
3285 * so with overlays it's possible to replace the default view and every
3286 * widget will be affected. This is very much alike to setting the whole
3287 * theme for the application and will probably clash with the end user
3288 * options, not to mention the risk of ending up with not matching styles
3289 * across the program. Unless there's a very special reason to use them,
3290 * overlays should be avoided for the resons exposed before.
3292 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3293 * keeps one default internally and every function that receives one of
3294 * these can be called with NULL to refer to this default (except for
3295 * elm_theme_free()). It's possible to create a new instance of a
3296 * ::Elm_Theme to set other theme for a specific widget (and all of its
3297 * children), but this is as discouraged, if not even more so, than using
3298 * overlays. Don't use this unless you really know what you are doing.
3300 * But to be less negative about things, you can look at the following
3302 * @li @ref theme_example_01 "Using extensions"
3303 * @li @ref theme_example_02 "Using overlays"
3308 * @typedef Elm_Theme
3310 * Opaque handler for the list of themes Elementary looks for when
3311 * rendering widgets.
3313 * Stay out of this unless you really know what you are doing. For most
3314 * cases, sticking to the default is all a developer needs.
3316 typedef struct _Elm_Theme Elm_Theme;
3319 * Create a new specific theme
3321 * This creates an empty specific theme that only uses the default theme. A
3322 * specific theme has its own private set of extensions and overlays too
3323 * (which are empty by default). Specific themes do not fall back to themes
3324 * of parent objects. They are not intended for this use. Use styles, overlays
3325 * and extensions when needed, but avoid specific themes unless there is no
3326 * other way (example: you want to have a preview of a new theme you are
3327 * selecting in a "theme selector" window. The preview is inside a scroller
3328 * and should display what the theme you selected will look like, but not
3329 * actually apply it yet. The child of the scroller will have a specific
3330 * theme set to show this preview before the user decides to apply it to all
3333 EAPI Elm_Theme *elm_theme_new(void);
3335 * Free a specific theme
3337 * @param th The theme to free
3339 * This frees a theme created with elm_theme_new().
3341 EAPI void elm_theme_free(Elm_Theme *th);
3343 * Copy the theme fom the source to the destination theme
3345 * @param th The source theme to copy from
3346 * @param thdst The destination theme to copy data to
3348 * This makes a one-time static copy of all the theme config, extensions
3349 * and overlays from @p th to @p thdst. If @p th references a theme, then
3350 * @p thdst is also set to reference it, with all the theme settings,
3351 * overlays and extensions that @p th had.
3353 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3355 * Tell the source theme to reference the ref theme
3357 * @param th The theme that will do the referencing
3358 * @param thref The theme that is the reference source
3360 * This clears @p th to be empty and then sets it to refer to @p thref
3361 * so @p th acts as an override to @p thref, but where its overrides
3362 * don't apply, it will fall through to @p thref for configuration.
3364 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3366 * Return the theme referred to
3368 * @param th The theme to get the reference from
3369 * @return The referenced theme handle
3371 * This gets the theme set as the reference theme by elm_theme_ref_set().
3372 * If no theme is set as a reference, NULL is returned.
3374 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3376 * Return the default theme
3378 * @return The default theme handle
3380 * This returns the internal default theme setup handle that all widgets
3381 * use implicitly unless a specific theme is set. This is also often use
3382 * as a shorthand of NULL.
3384 EAPI Elm_Theme *elm_theme_default_get(void);
3386 * Prepends a theme overlay to the list of overlays
3388 * @param th The theme to add to, or if NULL, the default theme
3389 * @param item The Edje file path to be used
3391 * Use this if your application needs to provide some custom overlay theme
3392 * (An Edje file that replaces some default styles of widgets) where adding
3393 * new styles, or changing system theme configuration is not possible. Do
3394 * NOT use this instead of a proper system theme configuration. Use proper
3395 * configuration files, profiles, environment variables etc. to set a theme
3396 * so that the theme can be altered by simple confiugration by a user. Using
3397 * this call to achieve that effect is abusing the API and will create lots
3400 * @see elm_theme_extension_add()
3402 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3404 * Delete a theme overlay from the list of overlays
3406 * @param th The theme to delete from, or if NULL, the default theme
3407 * @param item The name of the theme overlay
3409 * @see elm_theme_overlay_add()
3411 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3413 * Appends a theme extension to the list of extensions.
3415 * @param th The theme to add to, or if NULL, the default theme
3416 * @param item The Edje file path to be used
3418 * This is intended when an application needs more styles of widgets or new
3419 * widget themes that the default does not provide (or may not provide). The
3420 * application has "extended" usage by coming up with new custom style names
3421 * for widgets for specific uses, but as these are not "standard", they are
3422 * not guaranteed to be provided by a default theme. This means the
3423 * application is required to provide these extra elements itself in specific
3424 * Edje files. This call adds one of those Edje files to the theme search
3425 * path to be search after the default theme. The use of this call is
3426 * encouraged when default styles do not meet the needs of the application.
3427 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3429 * @see elm_object_style_set()
3431 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3433 * Deletes a theme extension from the list of extensions.
3435 * @param th The theme to delete from, or if NULL, the default theme
3436 * @param item The name of the theme extension
3438 * @see elm_theme_extension_add()
3440 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3442 * Set the theme search order for the given theme
3444 * @param th The theme to set the search order, or if NULL, the default theme
3445 * @param theme Theme search string
3447 * This sets the search string for the theme in path-notation from first
3448 * theme to search, to last, delimited by the : character. Example:
3450 * "shiny:/path/to/file.edj:default"
3452 * See the ELM_THEME environment variable for more information.
3454 * @see elm_theme_get()
3455 * @see elm_theme_list_get()
3457 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3459 * Return the theme search order
3461 * @param th The theme to get the search order, or if NULL, the default theme
3462 * @return The internal search order path
3464 * This function returns a colon separated string of theme elements as
3465 * returned by elm_theme_list_get().
3467 * @see elm_theme_set()
3468 * @see elm_theme_list_get()
3470 EAPI const char *elm_theme_get(Elm_Theme *th);
3472 * Return a list of theme elements to be used in a theme.
3474 * @param th Theme to get the list of theme elements from.
3475 * @return The internal list of theme elements
3477 * This returns the internal list of theme elements (will only be valid as
3478 * long as the theme is not modified by elm_theme_set() or theme is not
3479 * freed by elm_theme_free(). This is a list of strings which must not be
3480 * altered as they are also internal. If @p th is NULL, then the default
3481 * theme element list is returned.
3483 * A theme element can consist of a full or relative path to a .edj file,
3484 * or a name, without extension, for a theme to be searched in the known
3485 * theme paths for Elemementary.
3487 * @see elm_theme_set()
3488 * @see elm_theme_get()
3490 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3492 * Return the full patrh for a theme element
3494 * @param f The theme element name
3495 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3496 * @return The full path to the file found.
3498 * This returns a string you should free with free() on success, NULL on
3499 * failure. This will search for the given theme element, and if it is a
3500 * full or relative path element or a simple searchable name. The returned
3501 * path is the full path to the file, if searched, and the file exists, or it
3502 * is simply the full path given in the element or a resolved path if
3503 * relative to home. The @p in_search_path boolean pointed to is set to
3504 * EINA_TRUE if the file was a searchable file andis in the search path,
3505 * and EINA_FALSE otherwise.
3507 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3509 * Flush the current theme.
3511 * @param th Theme to flush
3513 * This flushes caches that let elementary know where to find theme elements
3514 * in the given theme. If @p th is NULL, then the default theme is flushed.
3515 * Call this function if source theme data has changed in such a way as to
3516 * make any caches Elementary kept invalid.
3518 EAPI void elm_theme_flush(Elm_Theme *th);
3520 * This flushes all themes (default and specific ones).
3522 * This will flush all themes in the current application context, by calling
3523 * elm_theme_flush() on each of them.
3525 EAPI void elm_theme_full_flush(void);
3527 * Set the theme for all elementary using applications on the current display
3529 * @param theme The name of the theme to use. Format same as the ELM_THEME
3530 * environment variable.
3532 EAPI void elm_theme_all_set(const char *theme);
3534 * Return a list of theme elements in the theme search path
3536 * @return A list of strings that are the theme element names.
3538 * This lists all available theme files in the standard Elementary search path
3539 * for theme elements, and returns them in alphabetical order as theme
3540 * element names in a list of strings. Free this with
3541 * elm_theme_name_available_list_free() when you are done with the list.
3543 EAPI Eina_List *elm_theme_name_available_list_new(void);
3545 * Free the list returned by elm_theme_name_available_list_new()
3547 * This frees the list of themes returned by
3548 * elm_theme_name_available_list_new(). Once freed the list should no longer
3549 * be used. a new list mys be created.
3551 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3553 * Set a specific theme to be used for this object and its children
3555 * @param obj The object to set the theme on
3556 * @param th The theme to set
3558 * This sets a specific theme that will be used for the given object and any
3559 * child objects it has. If @p th is NULL then the theme to be used is
3560 * cleared and the object will inherit its theme from its parent (which
3561 * ultimately will use the default theme if no specific themes are set).
3563 * Use special themes with great care as this will annoy users and make
3564 * configuration difficult. Avoid any custom themes at all if it can be
3567 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3569 * Get the specific theme to be used
3571 * @param obj The object to get the specific theme from
3572 * @return The specifc theme set.
3574 * This will return a specific theme set, or NULL if no specific theme is
3575 * set on that object. It will not return inherited themes from parents, only
3576 * the specific theme set for that specific object. See elm_object_theme_set()
3577 * for more information.
3579 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3582 * Get a data item from a theme
3584 * @param th The theme, or NULL for default theme
3585 * @param key The data key to search with
3586 * @return The data value, or NULL on failure
3588 * This function is used to return data items from edc in @p th, an overlay, or an extension.
3589 * It works the same way as edje_file_data_get() except that the return is stringshared.
3591 EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3597 /** @defgroup Win Win
3599 * @image html img/widget/win/preview-00.png
3600 * @image latex img/widget/win/preview-00.eps
3602 * The window class of Elementary. Contains functions to manipulate
3603 * windows. The Evas engine used to render the window contents is specified
3604 * in the system or user elementary config files (whichever is found last),
3605 * and can be overridden with the ELM_ENGINE environment variable for
3606 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3607 * compilation setup and modules actually installed at runtime) are (listed
3608 * in order of best supported and most likely to be complete and work to
3611 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3612 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3614 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3616 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3618 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3620 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3621 * rendering using SDL as the buffer)
3622 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3623 * GDI with software)
3624 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3625 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3626 * grayscale using dedicated 8bit software engine in X11)
3627 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3628 * X11 using 16bit software engine)
3629 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3630 * (Windows CE rendering via GDI with 16bit software renderer)
3631 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3632 * buffer with 16bit software renderer)
3633 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3634 * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3635 * @li "psl1ght" (PS3 rendering using PSL1GHT)
3637 * All engines use a simple string to select the engine to render, EXCEPT
3638 * the "shot" engine. This actually encodes the output of the virtual
3639 * screenshot and how long to delay in the engine string. The engine string
3640 * is encoded in the following way:
3642 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3644 * Where options are separated by a ":" char if more than one option is
3645 * given, with delay, if provided being the first option and file the last
3646 * (order is important). The delay specifies how long to wait after the
3647 * window is shown before doing the virtual "in memory" rendering and then
3648 * save the output to the file specified by the file option (and then exit).
3649 * If no delay is given, the default is 0.5 seconds. If no file is given the
3650 * default output file is "out.png". Repeat option is for continous
3651 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3652 * fixed to "out001.png" Some examples of using the shot engine:
3654 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3655 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3656 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3657 * ELM_ENGINE="shot:delay=2.0" elementary_test
3658 * ELM_ENGINE="shot:" elementary_test
3660 * Signals that you can add callbacks for are:
3662 * @li "delete,request": the user requested to close the window. See
3663 * elm_win_autodel_set().
3664 * @li "focus,in": window got focus
3665 * @li "focus,out": window lost focus
3666 * @li "moved": window that holds the canvas was moved
3669 * @li @ref win_example_01
3674 * Defines the types of window that can be created
3676 * These are hints set on the window so that a running Window Manager knows
3677 * how the window should be handled and/or what kind of decorations it
3680 * Currently, only the X11 backed engines use them.
3682 typedef enum _Elm_Win_Type
3684 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3685 window. Almost every window will be created with this
3687 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3688 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3689 window holding desktop icons. */
3690 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3691 be kept on top of any other window by the Window
3693 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3695 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3696 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3698 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3699 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3700 entry in a menubar is clicked. Typically used
3701 with elm_win_override_set(). This hint exists
3702 for completion only, as the EFL way of
3703 implementing a menu would not normally use a
3704 separate window for its contents. */
3705 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3706 triggered by right-clicking an object. */
3707 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3708 explanatory text that typically appear after the
3709 mouse cursor hovers over an object for a while.
3710 Typically used with elm_win_override_set() and also
3711 not very commonly used in the EFL. */
3712 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3713 battery life or a new E-Mail received. */
3714 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3715 usually used in the EFL. */
3716 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3717 object being dragged across different windows, or even
3718 applications. Typically used with
3719 elm_win_override_set(). */
3720 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3721 buffer. No actual window is created for this
3722 type, instead the window and all of its
3723 contents will be rendered to an image buffer.
3724 This allows to have children window inside a
3725 parent one just like any other object would
3726 be, and do other things like applying @c
3727 Evas_Map effects to it. This is the only type
3728 of window that requires the @c parent
3729 parameter of elm_win_add() to be a valid @c
3734 * The differents layouts that can be requested for the virtual keyboard.
3736 * When the application window is being managed by Illume, it may request
3737 * any of the following layouts for the virtual keyboard.
3739 typedef enum _Elm_Win_Keyboard_Mode
3741 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3742 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3743 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3744 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3745 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3746 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3747 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3748 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3749 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3750 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3751 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3752 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3753 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3754 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3755 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3756 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3757 } Elm_Win_Keyboard_Mode;
3760 * Available commands that can be sent to the Illume manager.
3762 * When running under an Illume session, a window may send commands to the
3763 * Illume manager to perform different actions.
3765 typedef enum _Elm_Illume_Command
3767 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3769 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3771 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3773 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3774 } Elm_Illume_Command;
3777 * Adds a window object. If this is the first window created, pass NULL as
3780 * @param parent Parent object to add the window to, or NULL
3781 * @param name The name of the window
3782 * @param type The window type, one of #Elm_Win_Type.
3784 * The @p parent paramter can be @c NULL for every window @p type except
3785 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3786 * which the image object will be created.
3788 * @return The created object, or NULL on failure
3790 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3792 * Adds a window object with standard setup
3794 * @param name The name of the window
3795 * @param title The title for the window
3797 * This creates a window like elm_win_add() but also puts in a standard
3798 * background with elm_bg_add(), as well as setting the window title to
3799 * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
3800 * as the parent widget.
3802 * @return The created object, or NULL on failure
3804 * @see elm_win_add()
3806 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
3808 * Add @p subobj as a resize object of window @p obj.
3811 * Setting an object as a resize object of the window means that the
3812 * @p subobj child's size and position will be controlled by the window
3813 * directly. That is, the object will be resized to match the window size
3814 * and should never be moved or resized manually by the developer.
3816 * In addition, resize objects of the window control what the minimum size
3817 * of it will be, as well as whether it can or not be resized by the user.
3819 * For the end user to be able to resize a window by dragging the handles
3820 * or borders provided by the Window Manager, or using any other similar
3821 * mechanism, all of the resize objects in the window should have their
3822 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3824 * @param obj The window object
3825 * @param subobj The resize object to add
3827 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3829 * Delete @p subobj as a resize object of window @p obj.
3831 * This function removes the object @p subobj from the resize objects of
3832 * the window @p obj. It will not delete the object itself, which will be
3833 * left unmanaged and should be deleted by the developer, manually handled
3834 * or set as child of some other container.
3836 * @param obj The window object
3837 * @param subobj The resize object to add
3839 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3841 * Set the title of the window
3843 * @param obj The window object
3844 * @param title The title to set
3846 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3848 * Get the title of the window
3850 * The returned string is an internal one and should not be freed or
3851 * modified. It will also be rendered invalid if a new title is set or if
3852 * the window is destroyed.
3854 * @param obj The window object
3857 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3859 * Set the window's autodel state.
3861 * When closing the window in any way outside of the program control, like
3862 * pressing the X button in the titlebar or using a command from the
3863 * Window Manager, a "delete,request" signal is emitted to indicate that
3864 * this event occurred and the developer can take any action, which may
3865 * include, or not, destroying the window object.
3867 * When the @p autodel parameter is set, the window will be automatically
3868 * destroyed when this event occurs, after the signal is emitted.
3869 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3870 * and is up to the program to do so when it's required.
3872 * @param obj The window object
3873 * @param autodel If true, the window will automatically delete itself when
3876 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3878 * Get the window's autodel state.
3880 * @param obj The window object
3881 * @return If the window will automatically delete itself when closed
3883 * @see elm_win_autodel_set()
3885 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3887 * Activate a window object.
3889 * This function sends a request to the Window Manager to activate the
3890 * window pointed by @p obj. If honored by the WM, the window will receive
3891 * the keyboard focus.
3893 * @note This is just a request that a Window Manager may ignore, so calling
3894 * this function does not ensure in any way that the window will be the
3895 * active one after it.
3897 * @param obj The window object
3899 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3901 * Lower a window object.
3903 * Places the window pointed by @p obj at the bottom of the stack, so that
3904 * no other window is covered by it.
3906 * If elm_win_override_set() is not set, the Window Manager may ignore this
3909 * @param obj The window object
3911 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3913 * Raise a window object.
3915 * Places the window pointed by @p obj at the top of the stack, so that it's
3916 * not covered by any other window.
3918 * If elm_win_override_set() is not set, the Window Manager may ignore this
3921 * @param obj The window object
3923 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3925 * Set the borderless state of a window.
3927 * This function requests the Window Manager to not draw any decoration
3928 * around the window.
3930 * @param obj The window object
3931 * @param borderless If true, the window is borderless
3933 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3935 * Get the borderless state of a window.
3937 * @param obj The window object
3938 * @return If true, the window is borderless
3940 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3942 * Set the shaped state of a window.
3944 * Shaped windows, when supported, will render the parts of the window that
3945 * has no content, transparent.
3947 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3948 * background object or cover the entire window in any other way, or the
3949 * parts of the canvas that have no data will show framebuffer artifacts.
3951 * @param obj The window object
3952 * @param shaped If true, the window is shaped
3954 * @see elm_win_alpha_set()
3956 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3958 * Get the shaped state of a window.
3960 * @param obj The window object
3961 * @return If true, the window is shaped
3963 * @see elm_win_shaped_set()
3965 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3967 * Set the alpha channel state of a window.
3969 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3970 * possibly making parts of the window completely or partially transparent.
3971 * This is also subject to the underlying system supporting it, like for
3972 * example, running under a compositing manager. If no compositing is
3973 * available, enabling this option will instead fallback to using shaped
3974 * windows, with elm_win_shaped_set().
3976 * @param obj The window object
3977 * @param alpha If true, the window has an alpha channel
3979 * @see elm_win_alpha_set()
3981 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3983 * Get the transparency state of a window.
3985 * @param obj The window object
3986 * @return If true, the window is transparent
3988 * @see elm_win_transparent_set()
3990 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3992 * Set the transparency state of a window.
3994 * Use elm_win_alpha_set() instead.
3996 * @param obj The window object
3997 * @param transparent If true, the window is transparent
3999 * @see elm_win_alpha_set()
4001 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4003 * Get the alpha channel state of a window.
4005 * @param obj The window object
4006 * @return If true, the window has an alpha channel
4008 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4010 * Set the override state of a window.
4012 * A window with @p override set to EINA_TRUE will not be managed by the
4013 * Window Manager. This means that no decorations of any kind will be shown
4014 * for it, moving and resizing must be handled by the application, as well
4015 * as the window visibility.
4017 * This should not be used for normal windows, and even for not so normal
4018 * ones, it should only be used when there's a good reason and with a lot
4019 * of care. Mishandling override windows may result situations that
4020 * disrupt the normal workflow of the end user.
4022 * @param obj The window object
4023 * @param override If true, the window is overridden
4025 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4027 * Get the override state of a window.
4029 * @param obj The window object
4030 * @return If true, the window is overridden
4032 * @see elm_win_override_set()
4034 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4036 * Set the fullscreen state of a window.
4038 * @param obj The window object
4039 * @param fullscreen If true, the window is fullscreen
4041 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4043 * Get the fullscreen state of a window.
4045 * @param obj The window object
4046 * @return If true, the window is fullscreen
4048 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4050 * Set the maximized state of a window.
4052 * @param obj The window object
4053 * @param maximized If true, the window is maximized
4055 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4057 * Get the maximized state of a window.
4059 * @param obj The window object
4060 * @return If true, the window is maximized
4062 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4064 * Set the iconified state of a window.
4066 * @param obj The window object
4067 * @param iconified If true, the window is iconified
4069 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4071 * Get the iconified state of a window.
4073 * @param obj The window object
4074 * @return If true, the window is iconified
4076 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4078 * Set the layer of the window.
4080 * What this means exactly will depend on the underlying engine used.
4082 * In the case of X11 backed engines, the value in @p layer has the
4083 * following meanings:
4084 * @li < 3: The window will be placed below all others.
4085 * @li > 5: The window will be placed above all others.
4086 * @li other: The window will be placed in the default layer.
4088 * @param obj The window object
4089 * @param layer The layer of the window
4091 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4093 * Get the layer of the window.
4095 * @param obj The window object
4096 * @return The layer of the window
4098 * @see elm_win_layer_set()
4100 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4102 * Set the rotation of the window.
4104 * Most engines only work with multiples of 90.
4106 * This function is used to set the orientation of the window @p obj to
4107 * match that of the screen. The window itself will be resized to adjust
4108 * to the new geometry of its contents. If you want to keep the window size,
4109 * see elm_win_rotation_with_resize_set().
4111 * @param obj The window object
4112 * @param rotation The rotation of the window, in degrees (0-360),
4113 * counter-clockwise.
4115 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4117 * Rotates the window and resizes it.
4119 * Like elm_win_rotation_set(), but it also resizes the window's contents so
4120 * that they fit inside the current window geometry.
4122 * @param obj The window object
4123 * @param layer The rotation of the window in degrees (0-360),
4124 * counter-clockwise.
4126 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4128 * Get the rotation of the window.
4130 * @param obj The window object
4131 * @return The rotation of the window in degrees (0-360)
4133 * @see elm_win_rotation_set()
4134 * @see elm_win_rotation_with_resize_set()
4136 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4138 * Set the sticky state of the window.
4140 * Hints the Window Manager that the window in @p obj should be left fixed
4141 * at its position even when the virtual desktop it's on moves or changes.
4143 * @param obj The window object
4144 * @param sticky If true, the window's sticky state is enabled
4146 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4148 * Get the sticky state of the window.
4150 * @param obj The window object
4151 * @return If true, the window's sticky state is enabled
4153 * @see elm_win_sticky_set()
4155 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4157 * Set if this window is an illume conformant window
4159 * @param obj The window object
4160 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4162 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4164 * Get if this window is an illume conformant window
4166 * @param obj The window object
4167 * @return A boolean if this window is illume conformant or not
4169 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4171 * Set a window to be an illume quickpanel window
4173 * By default window objects are not quickpanel windows.
4175 * @param obj The window object
4176 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4178 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4180 * Get if this window is a quickpanel or not
4182 * @param obj The window object
4183 * @return A boolean if this window is a quickpanel or not
4185 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4187 * Set the major priority of a quickpanel window
4189 * @param obj The window object
4190 * @param priority The major priority for this quickpanel
4192 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4194 * Get the major priority of a quickpanel window
4196 * @param obj The window object
4197 * @return The major priority of this quickpanel
4199 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4201 * Set the minor priority of a quickpanel window
4203 * @param obj The window object
4204 * @param priority The minor priority for this quickpanel
4206 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4208 * Get the minor priority of a quickpanel window
4210 * @param obj The window object
4211 * @return The minor priority of this quickpanel
4213 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4215 * Set which zone this quickpanel should appear in
4217 * @param obj The window object
4218 * @param zone The requested zone for this quickpanel
4220 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4222 * Get which zone this quickpanel should appear in
4224 * @param obj The window object
4225 * @return The requested zone for this quickpanel
4227 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4229 * Set the window to be skipped by keyboard focus
4231 * This sets the window to be skipped by normal keyboard input. This means
4232 * a window manager will be asked to not focus this window as well as omit
4233 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4235 * Call this and enable it on a window BEFORE you show it for the first time,
4236 * otherwise it may have no effect.
4238 * Use this for windows that have only output information or might only be
4239 * interacted with by the mouse or fingers, and never for typing input.
4240 * Be careful that this may have side-effects like making the window
4241 * non-accessible in some cases unless the window is specially handled. Use
4244 * @param obj The window object
4245 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4247 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4249 * Send a command to the windowing environment
4251 * This is intended to work in touchscreen or small screen device
4252 * environments where there is a more simplistic window management policy in
4253 * place. This uses the window object indicated to select which part of the
4254 * environment to control (the part that this window lives in), and provides
4255 * a command and an optional parameter structure (use NULL for this if not
4258 * @param obj The window object that lives in the environment to control
4259 * @param command The command to send
4260 * @param params Optional parameters for the command
4262 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4264 * Get the inlined image object handle
4266 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4267 * then the window is in fact an evas image object inlined in the parent
4268 * canvas. You can get this object (be careful to not manipulate it as it
4269 * is under control of elementary), and use it to do things like get pixel
4270 * data, save the image to a file, etc.
4272 * @param obj The window object to get the inlined image from
4273 * @return The inlined image object, or NULL if none exists
4275 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4277 * Set the enabled status for the focus highlight in a window
4279 * This function will enable or disable the focus highlight only for the
4280 * given window, regardless of the global setting for it
4282 * @param obj The window where to enable the highlight
4283 * @param enabled The enabled value for the highlight
4285 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4287 * Get the enabled value of the focus highlight for this window
4289 * @param obj The window in which to check if the focus highlight is enabled
4291 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4293 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4295 * Set the style for the focus highlight on this window
4297 * Sets the style to use for theming the highlight of focused objects on
4298 * the given window. If @p style is NULL, the default will be used.
4300 * @param obj The window where to set the style
4301 * @param style The style to set
4303 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4305 * Get the style set for the focus highlight object
4307 * Gets the style set for this windows highilght object, or NULL if none
4310 * @param obj The window to retrieve the highlights style from
4312 * @return The style set or NULL if none was. Default is used in that case.
4314 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4315 EAPI void elm_win_indicator_state_set(Evas_Object *obj, int show_state);
4316 EAPI int elm_win_indicator_state_get(Evas_Object *obj);
4318 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4319 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4320 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4321 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4322 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4323 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4324 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4326 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4327 * (blank mouse, private mouse obj, defaultmouse)
4331 * Sets the keyboard mode of the window.
4333 * @param obj The window object
4334 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4336 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4338 * Gets the keyboard mode of the window.
4340 * @param obj The window object
4341 * @return The mode, one of #Elm_Win_Keyboard_Mode
4343 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4345 * Sets whether the window is a keyboard.
4347 * @param obj The window object
4348 * @param is_keyboard If true, the window is a virtual keyboard
4350 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4352 * Gets whether the window is a keyboard.
4354 * @param obj The window object
4355 * @return If the window is a virtual keyboard
4357 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4360 * Get the screen position of a window.
4362 * @param obj The window object
4363 * @param x The int to store the x coordinate to
4364 * @param y The int to store the y coordinate to
4366 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4372 * @defgroup Inwin Inwin
4374 * @image html img/widget/inwin/preview-00.png
4375 * @image latex img/widget/inwin/preview-00.eps
4376 * @image html img/widget/inwin/preview-01.png
4377 * @image latex img/widget/inwin/preview-01.eps
4378 * @image html img/widget/inwin/preview-02.png
4379 * @image latex img/widget/inwin/preview-02.eps
4381 * An inwin is a window inside a window that is useful for a quick popup.
4382 * It does not hover.
4384 * It works by creating an object that will occupy the entire window, so it
4385 * must be created using an @ref Win "elm_win" as parent only. The inwin
4386 * object can be hidden or restacked below every other object if it's
4387 * needed to show what's behind it without destroying it. If this is done,
4388 * the elm_win_inwin_activate() function can be used to bring it back to
4389 * full visibility again.
4391 * There are three styles available in the default theme. These are:
4392 * @li default: The inwin is sized to take over most of the window it's
4394 * @li minimal: The size of the inwin will be the minimum necessary to show
4396 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4397 * possible, but it's sized vertically the most it needs to fit its\
4400 * Some examples of Inwin can be found in the following:
4401 * @li @ref inwin_example_01
4406 * Adds an inwin to the current window
4408 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4409 * Never call this function with anything other than the top-most window
4410 * as its parameter, unless you are fond of undefined behavior.
4412 * After creating the object, the widget will set itself as resize object
4413 * for the window with elm_win_resize_object_add(), so when shown it will
4414 * appear to cover almost the entire window (how much of it depends on its
4415 * content and the style used). It must not be added into other container
4416 * objects and it needs not be moved or resized manually.
4418 * @param parent The parent object
4419 * @return The new object or NULL if it cannot be created
4421 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4423 * Activates an inwin object, ensuring its visibility
4425 * This function will make sure that the inwin @p obj is completely visible
4426 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4427 * to the front. It also sets the keyboard focus to it, which will be passed
4430 * The object's theme will also receive the signal "elm,action,show" with
4433 * @param obj The inwin to activate
4435 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4437 * Set the content of an inwin object.
4439 * Once the content object is set, a previously set one will be deleted.
4440 * If you want to keep that old content object, use the
4441 * elm_win_inwin_content_unset() function.
4443 * @param obj The inwin object
4444 * @param content The object to set as content
4446 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4448 * Get the content of an inwin object.
4450 * Return the content object which is set for this widget.
4452 * The returned object is valid as long as the inwin is still alive and no
4453 * other content is set on it. Deleting the object will notify the inwin
4454 * about it and this one will be left empty.
4456 * If you need to remove an inwin's content to be reused somewhere else,
4457 * see elm_win_inwin_content_unset().
4459 * @param obj The inwin object
4460 * @return The content that is being used
4462 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4464 * Unset the content of an inwin object.
4466 * Unparent and return the content object which was set for this widget.
4468 * @param obj The inwin object
4469 * @return The content that was being used
4471 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4475 /* X specific calls - won't work on non-x engines (return 0) */
4478 * Get the Ecore_X_Window of an Evas_Object
4480 * @param obj The object
4482 * @return The Ecore_X_Window of @p obj
4486 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4488 /* smart callbacks called:
4489 * "delete,request" - the user requested to delete the window
4490 * "focus,in" - window got focus
4491 * "focus,out" - window lost focus
4492 * "moved" - window that holds the canvas was moved
4498 * @image html img/widget/bg/preview-00.png
4499 * @image latex img/widget/bg/preview-00.eps
4501 * @brief Background object, used for setting a solid color, image or Edje
4502 * group as background to a window or any container object.
4504 * The bg object is used for setting a solid background to a window or
4505 * packing into any container object. It works just like an image, but has
4506 * some properties useful to a background, like setting it to tiled,
4507 * centered, scaled or stretched.
4509 * Default contents parts of the bg widget that you can use for are:
4510 * @li "elm.swallow.content" - overlay of the bg
4512 * Here is some sample code using it:
4513 * @li @ref bg_01_example_page
4514 * @li @ref bg_02_example_page
4515 * @li @ref bg_03_example_page
4519 typedef enum _Elm_Bg_Option
4521 ELM_BG_OPTION_CENTER, /**< center the background */
4522 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4523 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4524 ELM_BG_OPTION_TILE /**< tile background at its original size */
4528 * Add a new background to the parent
4530 * @param parent The parent object
4531 * @return The new object or NULL if it cannot be created
4535 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4538 * Set the file (image or edje) used for the background
4540 * @param obj The bg object
4541 * @param file The file path
4542 * @param group Optional key (group in Edje) within the file
4544 * This sets the image file used in the background object. The image (or edje)
4545 * will be stretched (retaining aspect if its an image file) to completely fill
4546 * the bg object. This may mean some parts are not visible.
4548 * @note Once the image of @p obj is set, a previously set one will be deleted,
4549 * even if @p file is NULL.
4553 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4556 * Get the file (image or edje) used for the background
4558 * @param obj The bg object
4559 * @param file The file path
4560 * @param group Optional key (group in Edje) within the file
4564 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4567 * Set the option used for the background image
4569 * @param obj The bg object
4570 * @param option The desired background option (TILE, SCALE)
4572 * This sets the option used for manipulating the display of the background
4573 * image. The image can be tiled or scaled.
4577 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4580 * Get the option used for the background image
4582 * @param obj The bg object
4583 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4587 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4589 * Set the option used for the background color
4591 * @param obj The bg object
4596 * This sets the color used for the background rectangle. Its range goes
4601 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4603 * Get the option used for the background color
4605 * @param obj The bg object
4612 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4615 * Set the overlay object used for the background object.
4617 * @param obj The bg object
4618 * @param overlay The overlay object
4620 * This provides a way for elm_bg to have an 'overlay' that will be on top
4621 * of the bg. Once the over object is set, a previously set one will be
4622 * deleted, even if you set the new one to NULL. If you want to keep that
4623 * old content object, use the elm_bg_overlay_unset() function.
4625 * @deprecated use elm_object_content_set() instead
4630 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4633 * Get the overlay object used for the background object.
4635 * @param obj The bg object
4636 * @return The content that is being used
4638 * Return the content object which is set for this widget
4640 * @deprecated use elm_object_content_get() instead
4644 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4647 * Get the overlay object used for the background object.
4649 * @param obj The bg object
4650 * @return The content that was being used
4652 * Unparent and return the overlay object which was set for this widget
4654 * @deprecated use elm_object_content_unset() instead
4658 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4661 * Set the size of the pixmap representation of the image.
4663 * This option just makes sense if an image is going to be set in the bg.
4665 * @param obj The bg object
4666 * @param w The new width of the image pixmap representation.
4667 * @param h The new height of the image pixmap representation.
4669 * This function sets a new size for pixmap representation of the given bg
4670 * image. It allows the image to be loaded already in the specified size,
4671 * reducing the memory usage and load time when loading a big image with load
4672 * size set to a smaller size.
4674 * NOTE: this is just a hint, the real size of the pixmap may differ
4675 * depending on the type of image being loaded, being bigger than requested.
4679 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4680 /* smart callbacks called:
4684 * @defgroup Icon Icon
4686 * @image html img/widget/icon/preview-00.png
4687 * @image latex img/widget/icon/preview-00.eps
4689 * An object that provides standard icon images (delete, edit, arrows, etc.)
4690 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4692 * The icon image requested can be in the elementary theme, or in the
4693 * freedesktop.org paths. It's possible to set the order of preference from
4694 * where the image will be used.
4696 * This API is very similar to @ref Image, but with ready to use images.
4698 * Default images provided by the theme are described below.
4700 * The first list contains icons that were first intended to be used in
4701 * toolbars, but can be used in many other places too:
4717 * Now some icons that were designed to be used in menus (but again, you can
4718 * use them anywhere else):
4723 * @li menu/arrow_down
4724 * @li menu/arrow_left
4725 * @li menu/arrow_right
4734 * And here we have some media player specific icons:
4735 * @li media_player/forward
4736 * @li media_player/info
4737 * @li media_player/next
4738 * @li media_player/pause
4739 * @li media_player/play
4740 * @li media_player/prev
4741 * @li media_player/rewind
4742 * @li media_player/stop
4744 * Signals that you can add callbacks for are:
4746 * "clicked" - This is called when a user has clicked the icon
4748 * An example of usage for this API follows:
4749 * @li @ref tutorial_icon
4757 typedef enum _Elm_Icon_Type
4764 * @enum _Elm_Icon_Lookup_Order
4765 * @typedef Elm_Icon_Lookup_Order
4767 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4768 * theme, FDO paths, or both?
4772 typedef enum _Elm_Icon_Lookup_Order
4774 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4775 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4776 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4777 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4778 } Elm_Icon_Lookup_Order;
4781 * Add a new icon object to the parent.
4783 * @param parent The parent object
4784 * @return The new object or NULL if it cannot be created
4786 * @see elm_icon_file_set()
4790 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4792 * Set the file that will be used as icon.
4794 * @param obj The icon object
4795 * @param file The path to file that will be used as icon image
4796 * @param group The group that the icon belongs to an edje file
4798 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4800 * @note The icon image set by this function can be changed by
4801 * elm_icon_standard_set().
4803 * @see elm_icon_file_get()
4807 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4809 * Set a location in memory to be used as an icon
4811 * @param obj The icon object
4812 * @param img The binary data that will be used as an image
4813 * @param size The size of binary data @p img
4814 * @param format Optional format of @p img to pass to the image loader
4815 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4817 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4819 * @note The icon image set by this function can be changed by
4820 * elm_icon_standard_set().
4824 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);
4826 * Get the file that will be used as icon.
4828 * @param obj The icon object
4829 * @param file The path to file that will be used as the icon image
4830 * @param group The group that the icon belongs to, in edje file
4832 * @see elm_icon_file_set()
4836 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4837 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4839 * Set the icon by icon standards names.
4841 * @param obj The icon object
4842 * @param name The icon name
4844 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4846 * For example, freedesktop.org defines standard icon names such as "home",
4847 * "network", etc. There can be different icon sets to match those icon
4848 * keys. The @p name given as parameter is one of these "keys", and will be
4849 * used to look in the freedesktop.org paths and elementary theme. One can
4850 * change the lookup order with elm_icon_order_lookup_set().
4852 * If name is not found in any of the expected locations and it is the
4853 * absolute path of an image file, this image will be used.
4855 * @note The icon image set by this function can be changed by
4856 * elm_icon_file_set().
4858 * @see elm_icon_standard_get()
4859 * @see elm_icon_file_set()
4863 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4865 * Get the icon name set by icon standard names.
4867 * @param obj The icon object
4868 * @return The icon name
4870 * If the icon image was set using elm_icon_file_set() instead of
4871 * elm_icon_standard_set(), then this function will return @c NULL.
4873 * @see elm_icon_standard_set()
4877 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4879 * Set the smooth scaling for an icon object.
4881 * @param obj The icon object
4882 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4883 * otherwise. Default is @c EINA_TRUE.
4885 * Set the scaling algorithm to be used when scaling the icon image. Smooth
4886 * scaling provides a better resulting image, but is slower.
4888 * The smooth scaling should be disabled when making animations that change
4889 * the icon size, since they will be faster. Animations that don't require
4890 * resizing of the icon can keep the smooth scaling enabled (even if the icon
4891 * is already scaled, since the scaled icon image will be cached).
4893 * @see elm_icon_smooth_get()
4897 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4899 * Get whether smooth scaling is enabled for an icon object.
4901 * @param obj The icon object
4902 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4904 * @see elm_icon_smooth_set()
4908 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4910 * Disable scaling of this object.
4912 * @param obj The icon object.
4913 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4914 * otherwise. Default is @c EINA_FALSE.
4916 * This function disables scaling of the icon object through the function
4917 * elm_object_scale_set(). However, this does not affect the object
4918 * size/resize in any way. For that effect, take a look at
4919 * elm_icon_scale_set().
4921 * @see elm_icon_no_scale_get()
4922 * @see elm_icon_scale_set()
4923 * @see elm_object_scale_set()
4927 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4929 * Get whether scaling is disabled on the object.
4931 * @param obj The icon object
4932 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4934 * @see elm_icon_no_scale_set()
4938 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4940 * Set if the object is (up/down) resizable.
4942 * @param obj The icon object
4943 * @param scale_up A bool to set if the object is resizable up. Default is
4945 * @param scale_down A bool to set if the object is resizable down. Default
4948 * This function limits the icon object resize ability. If @p scale_up is set to
4949 * @c EINA_FALSE, the object can't have its height or width resized to a value
4950 * higher than the original icon size. Same is valid for @p scale_down.
4952 * @see elm_icon_scale_get()
4956 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4958 * Get if the object is (up/down) resizable.
4960 * @param obj The icon object
4961 * @param scale_up A bool to set if the object is resizable up
4962 * @param scale_down A bool to set if the object is resizable down
4964 * @see elm_icon_scale_set()
4968 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4970 * Get the object's image size
4972 * @param obj The icon object
4973 * @param w A pointer to store the width in
4974 * @param h A pointer to store the height in
4978 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4980 * Set if the icon fill the entire object area.
4982 * @param obj The icon object
4983 * @param fill_outside @c EINA_TRUE if the object is filled outside,
4984 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4986 * When the icon object is resized to a different aspect ratio from the
4987 * original icon image, the icon image will still keep its aspect. This flag
4988 * tells how the image should fill the object's area. They are: keep the
4989 * entire icon inside the limits of height and width of the object (@p
4990 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4991 * of the object, and the icon will fill the entire object (@p fill_outside
4994 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4995 * retain property to false. Thus, the icon image will always keep its
4996 * original aspect ratio.
4998 * @see elm_icon_fill_outside_get()
4999 * @see elm_image_fill_outside_set()
5003 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5005 * Get if the object is filled outside.
5007 * @param obj The icon object
5008 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5010 * @see elm_icon_fill_outside_set()
5014 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5016 * Set the prescale size for the icon.
5018 * @param obj The icon object
5019 * @param size The prescale size. This value is used for both width and
5022 * This function sets a new size for pixmap representation of the given
5023 * icon. It allows the icon to be loaded already in the specified size,
5024 * reducing the memory usage and load time when loading a big icon with load
5025 * size set to a smaller size.
5027 * It's equivalent to the elm_bg_load_size_set() function for bg.
5029 * @note this is just a hint, the real size of the pixmap may differ
5030 * depending on the type of icon being loaded, being bigger than requested.
5032 * @see elm_icon_prescale_get()
5033 * @see elm_bg_load_size_set()
5037 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5039 * Get the prescale size for the icon.
5041 * @param obj The icon object
5042 * @return The prescale size
5044 * @see elm_icon_prescale_set()
5048 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5050 * Gets the image object of the icon. DO NOT MODIFY THIS.
5052 * @param obj The icon object
5053 * @return The internal icon object
5057 EAPI Evas_Object *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5059 * Sets the icon lookup order used by elm_icon_standard_set().
5061 * @param obj The icon object
5062 * @param order The icon lookup order (can be one of
5063 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5064 * or ELM_ICON_LOOKUP_THEME)
5066 * @see elm_icon_order_lookup_get()
5067 * @see Elm_Icon_Lookup_Order
5071 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5073 * Gets the icon lookup order.
5075 * @param obj The icon object
5076 * @return The icon lookup order
5078 * @see elm_icon_order_lookup_set()
5079 * @see Elm_Icon_Lookup_Order
5083 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5085 * Enable or disable preloading of the icon
5087 * @param obj The icon object
5088 * @param disable If EINA_TRUE, preloading will be disabled
5091 EAPI void elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5093 * Get if the icon supports animation or not.
5095 * @param obj The icon object
5096 * @return @c EINA_TRUE if the icon supports animation,
5097 * @c EINA_FALSE otherwise.
5099 * Return if this elm icon's image can be animated. Currently Evas only
5100 * supports gif animation. If the return value is EINA_FALSE, other
5101 * elm_icon_animated_XXX APIs won't work.
5104 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5106 * Set animation mode of the icon.
5108 * @param obj The icon object
5109 * @param anim @c EINA_TRUE if the object do animation job,
5110 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5112 * Since the default animation mode is set to EINA_FALSE,
5113 * the icon is shown without animation.
5114 * This might be desirable when the application developer wants to show
5115 * a snapshot of the animated icon.
5116 * Set it to EINA_TRUE when the icon needs to be animated.
5119 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5121 * Get animation mode of the icon.
5123 * @param obj The icon object
5124 * @return The animation mode of the icon object
5125 * @see elm_icon_animated_set
5128 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5130 * Set animation play mode of the icon.
5132 * @param obj The icon object
5133 * @param play @c EINA_TRUE the object play animation images,
5134 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5136 * To play elm icon's animation, set play to EINA_TURE.
5137 * For example, you make gif player using this set/get API and click event.
5139 * 1. Click event occurs
5140 * 2. Check play flag using elm_icon_animaged_play_get
5141 * 3. If elm icon was playing, set play to EINA_FALSE.
5142 * Then animation will be stopped and vice versa
5145 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5147 * Get animation play mode of the icon.
5149 * @param obj The icon object
5150 * @return The play mode of the icon object
5152 * @see elm_icon_animated_play_get
5155 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5157 /* compatibility code to avoid API and ABI breaks */
5158 EINA_DEPRECATED EAPI extern inline void elm_icon_anim_set(Evas_Object *obj, Eina_Bool animated)
5160 elm_icon_animated_set(obj, animated);
5163 EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_get(const Evas_Object *obj)
5165 return elm_icon_animated_get(obj);
5168 EINA_DEPRECATED EAPI extern inline void elm_icon_anim_play_set(Evas_Object *obj, Eina_Bool play)
5170 elm_icon_animated_play_set(obj, play);
5173 EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_play_get(const Evas_Object *obj)
5175 return elm_icon_animated_play_get(obj);
5183 * @defgroup Image Image
5185 * @image html img/widget/image/preview-00.png
5186 * @image latex img/widget/image/preview-00.eps
5189 * An object that allows one to load an image file to it. It can be used
5190 * anywhere like any other elementary widget.
5192 * This widget provides most of the functionality provided from @ref Bg or @ref
5193 * Icon, but with a slightly different API (use the one that fits better your
5196 * The features not provided by those two other image widgets are:
5197 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5198 * @li change the object orientation with elm_image_orient_set();
5199 * @li and turning the image editable with elm_image_editable_set().
5201 * Signals that you can add callbacks for are:
5203 * @li @c "clicked" - This is called when a user has clicked the image
5205 * An example of usage for this API follows:
5206 * @li @ref tutorial_image
5215 * @enum _Elm_Image_Orient
5216 * @typedef Elm_Image_Orient
5218 * Possible orientation options for elm_image_orient_set().
5220 * @image html elm_image_orient_set.png
5221 * @image latex elm_image_orient_set.eps width=\textwidth
5225 typedef enum _Elm_Image_Orient
5227 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5228 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5229 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5230 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5231 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5232 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5233 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5234 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5238 * Add a new image to the parent.
5240 * @param parent The parent object
5241 * @return The new object or NULL if it cannot be created
5243 * @see elm_image_file_set()
5247 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5249 * Set the file that will be used as image.
5251 * @param obj The image object
5252 * @param file The path to file that will be used as image
5253 * @param group The group that the image belongs in edje file (if it's an
5256 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5258 * @see elm_image_file_get()
5262 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5264 * Get the file that will be used as image.
5266 * @param obj The image object
5267 * @param file The path to file
5268 * @param group The group that the image belongs in edje file
5270 * @see elm_image_file_set()
5274 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5276 * Set the smooth effect for an image.
5278 * @param obj The image object
5279 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5280 * otherwise. Default is @c EINA_TRUE.
5282 * Set the scaling algorithm to be used when scaling the image. Smooth
5283 * scaling provides a better resulting image, but is slower.
5285 * The smooth scaling should be disabled when making animations that change
5286 * the image size, since it will be faster. Animations that don't require
5287 * resizing of the image can keep the smooth scaling enabled (even if the
5288 * image is already scaled, since the scaled image will be cached).
5290 * @see elm_image_smooth_get()
5294 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5296 * Get the smooth effect for an image.
5298 * @param obj The image object
5299 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5301 * @see elm_image_smooth_get()
5305 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5308 * Gets the current size of the image.
5310 * @param obj The image object.
5311 * @param w Pointer to store width, or NULL.
5312 * @param h Pointer to store height, or NULL.
5314 * This is the real size of the image, not the size of the object.
5316 * On error, neither w or h will be written.
5320 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5322 * Disable scaling of this object.
5324 * @param obj The image object.
5325 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5326 * otherwise. Default is @c EINA_FALSE.
5328 * This function disables scaling of the elm_image widget through the
5329 * function elm_object_scale_set(). However, this does not affect the widget
5330 * size/resize in any way. For that effect, take a look at
5331 * elm_image_scale_set().
5333 * @see elm_image_no_scale_get()
5334 * @see elm_image_scale_set()
5335 * @see elm_object_scale_set()
5339 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5341 * Get whether scaling is disabled on the object.
5343 * @param obj The image object
5344 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5346 * @see elm_image_no_scale_set()
5350 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5352 * Set if the object is (up/down) resizable.
5354 * @param obj The image object
5355 * @param scale_up A bool to set if the object is resizable up. Default is
5357 * @param scale_down A bool to set if the object is resizable down. Default
5360 * This function limits the image resize ability. If @p scale_up is set to
5361 * @c EINA_FALSE, the object can't have its height or width resized to a value
5362 * higher than the original image size. Same is valid for @p scale_down.
5364 * @see elm_image_scale_get()
5368 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5370 * Get if the object is (up/down) resizable.
5372 * @param obj The image object
5373 * @param scale_up A bool to set if the object is resizable up
5374 * @param scale_down A bool to set if the object is resizable down
5376 * @see elm_image_scale_set()
5380 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5382 * Set if the image fills the entire object area, when keeping the aspect ratio.
5384 * @param obj The image object
5385 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5386 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5388 * When the image should keep its aspect ratio even if resized to another
5389 * aspect ratio, there are two possibilities to resize it: keep the entire
5390 * image inside the limits of height and width of the object (@p fill_outside
5391 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5392 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5394 * @note This option will have no effect if
5395 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5397 * @see elm_image_fill_outside_get()
5398 * @see elm_image_aspect_ratio_retained_set()
5402 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5404 * Get if the object is filled outside
5406 * @param obj The image object
5407 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5409 * @see elm_image_fill_outside_set()
5413 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5415 * Set the prescale size for the image
5417 * @param obj The image object
5418 * @param size The prescale size. This value is used for both width and
5421 * This function sets a new size for pixmap representation of the given
5422 * image. It allows the image to be loaded already in the specified size,
5423 * reducing the memory usage and load time when loading a big image with load
5424 * size set to a smaller size.
5426 * It's equivalent to the elm_bg_load_size_set() function for bg.
5428 * @note this is just a hint, the real size of the pixmap may differ
5429 * depending on the type of image being loaded, being bigger than requested.
5431 * @see elm_image_prescale_get()
5432 * @see elm_bg_load_size_set()
5436 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5438 * Get the prescale size for the image
5440 * @param obj The image object
5441 * @return The prescale size
5443 * @see elm_image_prescale_set()
5447 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5449 * Set the image orientation.
5451 * @param obj The image object
5452 * @param orient The image orientation @ref Elm_Image_Orient
5453 * Default is #ELM_IMAGE_ORIENT_NONE.
5455 * This function allows to rotate or flip the given image.
5457 * @see elm_image_orient_get()
5458 * @see @ref Elm_Image_Orient
5462 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5464 * Get the image orientation.
5466 * @param obj The image object
5467 * @return The image orientation @ref Elm_Image_Orient
5469 * @see elm_image_orient_set()
5470 * @see @ref Elm_Image_Orient
5474 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5476 * Make the image 'editable'.
5478 * @param obj Image object.
5479 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5481 * This means the image is a valid drag target for drag and drop, and can be
5482 * cut or pasted too.
5486 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5488 * Check if the image 'editable'.
5490 * @param obj Image object.
5491 * @return Editability.
5493 * A return value of EINA_TRUE means the image is a valid drag target
5494 * for drag and drop, and can be cut or pasted too.
5498 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5500 * Get the basic Evas_Image object from this object (widget).
5502 * @param obj The image object to get the inlined image from
5503 * @return The inlined image object, or NULL if none exists
5505 * This function allows one to get the underlying @c Evas_Object of type
5506 * Image from this elementary widget. It can be useful to do things like get
5507 * the pixel data, save the image to a file, etc.
5509 * @note Be careful to not manipulate it, as it is under control of
5514 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5516 * Set whether the original aspect ratio of the image should be kept on resize.
5518 * @param obj The image object.
5519 * @param retained @c EINA_TRUE if the image should retain the aspect,
5520 * @c EINA_FALSE otherwise.
5522 * The original aspect ratio (width / height) of the image is usually
5523 * distorted to match the object's size. Enabling this option will retain
5524 * this original aspect, and the way that the image is fit into the object's
5525 * area depends on the option set by elm_image_fill_outside_set().
5527 * @see elm_image_aspect_ratio_retained_get()
5528 * @see elm_image_fill_outside_set()
5532 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5534 * Get if the object retains the original aspect ratio.
5536 * @param obj The image object.
5537 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5542 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5549 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5551 /* old API compatibility */
5552 typedef Elm_GLView_Func_Cb Elm_GLView_Func;
5554 typedef enum _Elm_GLView_Mode
5556 ELM_GLVIEW_ALPHA = 1,
5557 ELM_GLVIEW_DEPTH = 2,
5558 ELM_GLVIEW_STENCIL = 4
5562 * Defines a policy for the glview resizing.
5564 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5566 typedef enum _Elm_GLView_Resize_Policy
5568 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5569 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5570 } Elm_GLView_Resize_Policy;
5572 typedef enum _Elm_GLView_Render_Policy
5574 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5575 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5576 } Elm_GLView_Render_Policy;
5581 * A simple GLView widget that allows GL rendering.
5583 * Signals that you can add callbacks for are:
5589 * Add a new glview to the parent
5591 * @param parent The parent object
5592 * @return The new object or NULL if it cannot be created
5596 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5599 * Sets the size of the glview
5601 * @param obj The glview object
5602 * @param width width of the glview object
5603 * @param height height of the glview object
5607 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5610 * Gets the size of the glview.
5612 * @param obj The glview object
5613 * @param width width of the glview object
5614 * @param height height of the glview object
5616 * Note that this function returns the actual image size of the
5617 * glview. This means that when the scale policy is set to
5618 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5623 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5626 * Gets the gl api struct for gl rendering
5628 * @param obj The glview object
5629 * @return The api object or NULL if it cannot be created
5633 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5636 * Set the mode of the GLView. Supports Three simple modes.
5638 * @param obj The glview object
5639 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5640 * @return True if set properly.
5644 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5647 * Set the resize policy for the glview object.
5649 * @param obj The glview object.
5650 * @param policy The scaling policy.
5652 * By default, the resize policy is set to
5653 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5654 * destroys the previous surface and recreates the newly specified
5655 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5656 * however, glview only scales the image object and not the underlying
5661 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5664 * Set the render policy for the glview object.
5666 * @param obj The glview object.
5667 * @param policy The render policy.
5669 * By default, the render policy is set to
5670 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5671 * that during the render loop, glview is only redrawn if it needs
5672 * to be redrawn. (i.e. When it is visible) If the policy is set to
5673 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5674 * whether it is visible/need redrawing or not.
5678 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5681 * Set the init function that runs once in the main loop.
5683 * @param obj The glview object.
5684 * @param func The init function to be registered.
5686 * The registered init function gets called once during the render loop.
5690 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5693 * Set the render function that runs in the main loop.
5695 * @param obj The glview object.
5696 * @param func The delete function to be registered.
5698 * The registered del function gets called when GLView object is deleted.
5702 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5705 * Set the resize function that gets called when resize happens.
5707 * @param obj The glview object.
5708 * @param func The resize function to be registered.
5712 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5715 * Set the render function that runs in the main loop.
5717 * @param obj The glview object.
5718 * @param func The render function to be registered.
5722 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5725 * Notifies that there has been changes in the GLView.
5727 * @param obj The glview object.
5731 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5741 * @image html img/widget/box/preview-00.png
5742 * @image latex img/widget/box/preview-00.eps width=\textwidth
5744 * @image html img/box.png
5745 * @image latex img/box.eps width=\textwidth
5747 * A box arranges objects in a linear fashion, governed by a layout function
5748 * that defines the details of this arrangement.
5750 * By default, the box will use an internal function to set the layout to
5751 * a single row, either vertical or horizontal. This layout is affected
5752 * by a number of parameters, such as the homogeneous flag set by
5753 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5754 * elm_box_align_set() and the hints set to each object in the box.
5756 * For this default layout, it's possible to change the orientation with
5757 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5758 * placing its elements ordered from top to bottom. When horizontal is set,
5759 * the order will go from left to right. If the box is set to be
5760 * homogeneous, every object in it will be assigned the same space, that
5761 * of the largest object. Padding can be used to set some spacing between
5762 * the cell given to each object. The alignment of the box, set with
5763 * elm_box_align_set(), determines how the bounding box of all the elements
5764 * will be placed within the space given to the box widget itself.
5766 * The size hints of each object also affect how they are placed and sized
5767 * within the box. evas_object_size_hint_min_set() will give the minimum
5768 * size the object can have, and the box will use it as the basis for all
5769 * latter calculations. Elementary widgets set their own minimum size as
5770 * needed, so there's rarely any need to use it manually.
5772 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5773 * used to tell whether the object will be allocated the minimum size it
5774 * needs or if the space given to it should be expanded. It's important
5775 * to realize that expanding the size given to the object is not the same
5776 * thing as resizing the object. It could very well end being a small
5777 * widget floating in a much larger empty space. If not set, the weight
5778 * for objects will normally be 0.0 for both axis, meaning the widget will
5779 * not be expanded. To take as much space possible, set the weight to
5780 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5782 * Besides how much space each object is allocated, it's possible to control
5783 * how the widget will be placed within that space using
5784 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5785 * for both axis, meaning the object will be centered, but any value from
5786 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5787 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5788 * is -1.0, means the object will be resized to fill the entire space it
5791 * In addition, customized functions to define the layout can be set, which
5792 * allow the application developer to organize the objects within the box
5793 * in any number of ways.
5795 * The special elm_box_layout_transition() function can be used
5796 * to switch from one layout to another, animating the motion of the
5797 * children of the box.
5799 * @note Objects should not be added to box objects using _add() calls.
5801 * Some examples on how to use boxes follow:
5802 * @li @ref box_example_01
5803 * @li @ref box_example_02
5808 * @typedef Elm_Box_Transition
5810 * Opaque handler containing the parameters to perform an animated
5811 * transition of the layout the box uses.
5813 * @see elm_box_transition_new()
5814 * @see elm_box_layout_set()
5815 * @see elm_box_layout_transition()
5817 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5820 * Add a new box to the parent
5822 * By default, the box will be in vertical mode and non-homogeneous.
5824 * @param parent The parent object
5825 * @return The new object or NULL if it cannot be created
5827 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5829 * Set the horizontal orientation
5831 * By default, box object arranges their contents vertically from top to
5833 * By calling this function with @p horizontal as EINA_TRUE, the box will
5834 * become horizontal, arranging contents from left to right.
5836 * @note This flag is ignored if a custom layout function is set.
5838 * @param obj The box object
5839 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5840 * EINA_FALSE = vertical)
5842 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5844 * Get the horizontal orientation
5846 * @param obj The box object
5847 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5849 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5851 * Set the box to arrange its children homogeneously
5853 * If enabled, homogeneous layout makes all items the same size, according
5854 * to the size of the largest of its children.
5856 * @note This flag is ignored if a custom layout function is set.
5858 * @param obj The box object
5859 * @param homogeneous The homogeneous flag
5861 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5863 * Get whether the box is using homogeneous mode or not
5865 * @param obj The box object
5866 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5868 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5869 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5870 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5872 * Add an object to the beginning of the pack list
5874 * Pack @p subobj into the box @p obj, placing it first in the list of
5875 * children objects. The actual position the object will get on screen
5876 * depends on the layout used. If no custom layout is set, it will be at
5877 * the top or left, depending if the box is vertical or horizontal,
5880 * @param obj The box object
5881 * @param subobj The object to add to the box
5883 * @see elm_box_pack_end()
5884 * @see elm_box_pack_before()
5885 * @see elm_box_pack_after()
5886 * @see elm_box_unpack()
5887 * @see elm_box_unpack_all()
5888 * @see elm_box_clear()
5890 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5892 * Add an object at the end of the pack list
5894 * Pack @p subobj into the box @p obj, placing it last in the list of
5895 * children objects. The actual position the object will get on screen
5896 * depends on the layout used. If no custom layout is set, it will be at
5897 * the bottom or right, depending if the box is vertical or horizontal,
5900 * @param obj The box object
5901 * @param subobj The object to add to the box
5903 * @see elm_box_pack_start()
5904 * @see elm_box_pack_before()
5905 * @see elm_box_pack_after()
5906 * @see elm_box_unpack()
5907 * @see elm_box_unpack_all()
5908 * @see elm_box_clear()
5910 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5912 * Adds an object to the box before the indicated object
5914 * This will add the @p subobj to the box indicated before the object
5915 * indicated with @p before. If @p before is not already in the box, results
5916 * are undefined. Before means either to the left of the indicated object or
5917 * above it depending on orientation.
5919 * @param obj The box object
5920 * @param subobj The object to add to the box
5921 * @param before The object before which to add it
5923 * @see elm_box_pack_start()
5924 * @see elm_box_pack_end()
5925 * @see elm_box_pack_after()
5926 * @see elm_box_unpack()
5927 * @see elm_box_unpack_all()
5928 * @see elm_box_clear()
5930 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5932 * Adds an object to the box after the indicated object
5934 * This will add the @p subobj to the box indicated after the object
5935 * indicated with @p after. If @p after is not already in the box, results
5936 * are undefined. After means either to the right of the indicated object or
5937 * below it depending on orientation.
5939 * @param obj The box object
5940 * @param subobj The object to add to the box
5941 * @param after The object after which to add it
5943 * @see elm_box_pack_start()
5944 * @see elm_box_pack_end()
5945 * @see elm_box_pack_before()
5946 * @see elm_box_unpack()
5947 * @see elm_box_unpack_all()
5948 * @see elm_box_clear()
5950 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5952 * Clear the box of all children
5954 * Remove all the elements contained by the box, deleting the respective
5957 * @param obj The box object
5959 * @see elm_box_unpack()
5960 * @see elm_box_unpack_all()
5962 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5966 * Remove the object given by @p subobj from the box @p obj without
5969 * @param obj The box object
5971 * @see elm_box_unpack_all()
5972 * @see elm_box_clear()
5974 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5976 * Remove all items from the box, without deleting them
5978 * Clear the box from all children, but don't delete the respective objects.
5979 * If no other references of the box children exist, the objects will never
5980 * be deleted, and thus the application will leak the memory. Make sure
5981 * when using this function that you hold a reference to all the objects
5982 * in the box @p obj.
5984 * @param obj The box object
5986 * @see elm_box_clear()
5987 * @see elm_box_unpack()
5989 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5991 * Retrieve a list of the objects packed into the box
5993 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5994 * The order of the list corresponds to the packing order the box uses.
5996 * You must free this list with eina_list_free() once you are done with it.
5998 * @param obj The box object
6000 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6002 * Set the space (padding) between the box's elements.
6004 * Extra space in pixels that will be added between a box child and its
6005 * neighbors after its containing cell has been calculated. This padding
6006 * is set for all elements in the box, besides any possible padding that
6007 * individual elements may have through their size hints.
6009 * @param obj The box object
6010 * @param horizontal The horizontal space between elements
6011 * @param vertical The vertical space between elements
6013 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
6015 * Get the space (padding) between the box's elements.
6017 * @param obj The box object
6018 * @param horizontal The horizontal space between elements
6019 * @param vertical The vertical space between elements
6021 * @see elm_box_padding_set()
6023 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
6025 * Set the alignment of the whole bouding box of contents.
6027 * Sets how the bounding box containing all the elements of the box, after
6028 * their sizes and position has been calculated, will be aligned within
6029 * the space given for the whole box widget.
6031 * @param obj The box object
6032 * @param horizontal The horizontal alignment of elements
6033 * @param vertical The vertical alignment of elements
6035 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6037 * Get the alignment of the whole bouding box of contents.
6039 * @param obj The box object
6040 * @param horizontal The horizontal alignment of elements
6041 * @param vertical The vertical alignment of elements
6043 * @see elm_box_align_set()
6045 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6048 * Force the box to recalculate its children packing.
6050 * If any children was added or removed, box will not calculate the
6051 * values immediately rather leaving it to the next main loop
6052 * iteration. While this is great as it would save lots of
6053 * recalculation, whenever you need to get the position of a just
6054 * added item you must force recalculate before doing so.
6056 * @param obj The box object.
6058 EAPI void elm_box_recalculate(Evas_Object *obj);
6061 * Set the layout defining function to be used by the box
6063 * Whenever anything changes that requires the box in @p obj to recalculate
6064 * the size and position of its elements, the function @p cb will be called
6065 * to determine what the layout of the children will be.
6067 * Once a custom function is set, everything about the children layout
6068 * is defined by it. The flags set by elm_box_horizontal_set() and
6069 * elm_box_homogeneous_set() no longer have any meaning, and the values
6070 * given by elm_box_padding_set() and elm_box_align_set() are up to this
6071 * layout function to decide if they are used and how. These last two
6072 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6073 * passed to @p cb. The @c Evas_Object the function receives is not the
6074 * Elementary widget, but the internal Evas Box it uses, so none of the
6075 * functions described here can be used on it.
6077 * Any of the layout functions in @c Evas can be used here, as well as the
6078 * special elm_box_layout_transition().
6080 * The final @p data argument received by @p cb is the same @p data passed
6081 * here, and the @p free_data function will be called to free it
6082 * whenever the box is destroyed or another layout function is set.
6084 * Setting @p cb to NULL will revert back to the default layout function.
6086 * @param obj The box object
6087 * @param cb The callback function used for layout
6088 * @param data Data that will be passed to layout function
6089 * @param free_data Function called to free @p data
6091 * @see elm_box_layout_transition()
6093 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);
6095 * Special layout function that animates the transition from one layout to another
6097 * Normally, when switching the layout function for a box, this will be
6098 * reflected immediately on screen on the next render, but it's also
6099 * possible to do this through an animated transition.
6101 * This is done by creating an ::Elm_Box_Transition and setting the box
6102 * layout to this function.
6106 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6107 * evas_object_box_layout_vertical, // start
6108 * NULL, // data for initial layout
6109 * NULL, // free function for initial data
6110 * evas_object_box_layout_horizontal, // end
6111 * NULL, // data for final layout
6112 * NULL, // free function for final data
6113 * anim_end, // will be called when animation ends
6114 * NULL); // data for anim_end function\
6115 * elm_box_layout_set(box, elm_box_layout_transition, t,
6116 * elm_box_transition_free);
6119 * @note This function can only be used with elm_box_layout_set(). Calling
6120 * it directly will not have the expected results.
6122 * @see elm_box_transition_new
6123 * @see elm_box_transition_free
6124 * @see elm_box_layout_set
6126 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6128 * Create a new ::Elm_Box_Transition to animate the switch of layouts
6130 * If you want to animate the change from one layout to another, you need
6131 * to set the layout function of the box to elm_box_layout_transition(),
6132 * passing as user data to it an instance of ::Elm_Box_Transition with the
6133 * necessary information to perform this animation. The free function to
6134 * set for the layout is elm_box_transition_free().
6136 * The parameters to create an ::Elm_Box_Transition sum up to how long
6137 * will it be, in seconds, a layout function to describe the initial point,
6138 * another for the final position of the children and one function to be
6139 * called when the whole animation ends. This last function is useful to
6140 * set the definitive layout for the box, usually the same as the end
6141 * layout for the animation, but could be used to start another transition.
6143 * @param start_layout The layout function that will be used to start the animation
6144 * @param start_layout_data The data to be passed the @p start_layout function
6145 * @param start_layout_free_data Function to free @p start_layout_data
6146 * @param end_layout The layout function that will be used to end the animation
6147 * @param end_layout_free_data The data to be passed the @p end_layout function
6148 * @param end_layout_free_data Function to free @p end_layout_data
6149 * @param transition_end_cb Callback function called when animation ends
6150 * @param transition_end_data Data to be passed to @p transition_end_cb
6151 * @return An instance of ::Elm_Box_Transition
6153 * @see elm_box_transition_new
6154 * @see elm_box_layout_transition
6156 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);
6158 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6160 * This function is mostly useful as the @c free_data parameter in
6161 * elm_box_layout_set() when elm_box_layout_transition().
6163 * @param data The Elm_Box_Transition instance to be freed.
6165 * @see elm_box_transition_new
6166 * @see elm_box_layout_transition
6168 EAPI void elm_box_transition_free(void *data);
6175 * @defgroup Button Button
6177 * @image html img/widget/button/preview-00.png
6178 * @image latex img/widget/button/preview-00.eps
6179 * @image html img/widget/button/preview-01.png
6180 * @image latex img/widget/button/preview-01.eps
6181 * @image html img/widget/button/preview-02.png
6182 * @image latex img/widget/button/preview-02.eps
6184 * This is a push-button. Press it and run some function. It can contain
6185 * a simple label and icon object and it also has an autorepeat feature.
6187 * This widgets emits the following signals:
6188 * @li "clicked": the user clicked the button (press/release).
6189 * @li "repeated": the user pressed the button without releasing it.
6190 * @li "pressed": button was pressed.
6191 * @li "unpressed": button was released after being pressed.
6192 * In all three cases, the @c event parameter of the callback will be
6195 * Also, defined in the default theme, the button has the following styles
6197 * @li default: a normal button.
6198 * @li anchor: Like default, but the button fades away when the mouse is not
6199 * over it, leaving only the text or icon.
6200 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6201 * continuous look across its options.
6202 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6204 * Default contents parts of the button widget that you can use for are:
6205 * @li "elm.swallow.content" - A icon of the button
6207 * Default text parts of the button widget that you can use for are:
6208 * @li "elm.text" - Label of the button
6210 * Follow through a complete example @ref button_example_01 "here".
6216 UIControlStateDefault,
6217 UIControlStateHighlighted,
6218 UIControlStateDisabled,
6219 UIControlStateFocused,
6220 UIControlStateReserved
6224 * Add a new button to the parent's canvas
6226 * @param parent The parent object
6227 * @return The new object or NULL if it cannot be created
6229 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6231 * Set the label used in the button
6233 * The passed @p label can be NULL to clean any existing text in it and
6234 * leave the button as an icon only object.
6236 * @param obj The button object
6237 * @param label The text will be written on the button
6238 * @deprecated use elm_object_text_set() instead.
6240 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6242 * Get the label set for the button
6244 * The string returned is an internal pointer and should not be freed or
6245 * altered. It will also become invalid when the button is destroyed.
6246 * The string returned, if not NULL, is a stringshare, so if you need to
6247 * keep it around even after the button is destroyed, you can use
6248 * eina_stringshare_ref().
6250 * @param obj The button object
6251 * @return The text set to the label, or NULL if nothing is set
6252 * @deprecated use elm_object_text_set() instead.
6254 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6256 * Set the label for each state of button
6258 * The passed @p label can be NULL to clean any existing text in it and
6259 * leave the button as an icon only object for the state.
6261 * @param obj The button object
6262 * @param label The text will be written on the button
6263 * @param state The state of button
6267 EINA_DEPRECATED EAPI void elm_button_label_set_for_state(Evas_Object *obj, const char *label, UIControlState state) EINA_ARG_NONNULL(1);
6269 * Get the label of button for each state
6271 * The string returned is an internal pointer and should not be freed or
6272 * altered. It will also become invalid when the button is destroyed.
6273 * The string returned, if not NULL, is a stringshare, so if you need to
6274 * keep it around even after the button is destroyed, you can use
6275 * eina_stringshare_ref().
6277 * @param obj The button object
6278 * @param state The state of button
6279 * @return The title of button for state
6283 EINA_DEPRECATED EAPI const char *elm_button_label_get_for_state(const Evas_Object *obj, UIControlState state) EINA_ARG_NONNULL(1);
6285 * Set the icon used for the button
6287 * Setting a new icon will delete any other that was previously set, making
6288 * any reference to them invalid. If you need to maintain the previous
6289 * object alive, unset it first with elm_button_icon_unset().
6291 * @param obj The button object
6292 * @param icon The icon object for the button
6293 * @deprecated use elm_object_content_set() instead.
6295 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6297 * Get the icon used for the button
6299 * Return the icon object which is set for this widget. If the button is
6300 * destroyed or another icon is set, the returned object will be deleted
6301 * and any reference to it will be invalid.
6303 * @param obj The button object
6304 * @return The icon object that is being used
6306 * @deprecated use elm_button_icon_unset() instead
6308 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6310 * Remove the icon set without deleting it and return the object
6312 * This function drops the reference the button holds of the icon object
6313 * and returns this last object. It is used in case you want to remove any
6314 * icon, or set another one, without deleting the actual object. The button
6315 * will be left without an icon set.
6317 * @param obj The button object
6318 * @return The icon object that was being used
6319 * @deprecated use elm_object_content_unset() instead.
6321 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6323 * Turn on/off the autorepeat event generated when the button is kept pressed
6325 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6326 * signal when they are clicked.
6328 * When on, keeping a button pressed will continuously emit a @c repeated
6329 * signal until the button is released. The time it takes until it starts
6330 * emitting the signal is given by
6331 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6332 * new emission by elm_button_autorepeat_gap_timeout_set().
6334 * @param obj The button object
6335 * @param on A bool to turn on/off the event
6337 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6339 * Get whether the autorepeat feature is enabled
6341 * @param obj The button object
6342 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6344 * @see elm_button_autorepeat_set()
6346 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6348 * Set the initial timeout before the autorepeat event is generated
6350 * Sets the timeout, in seconds, since the button is pressed until the
6351 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6352 * won't be any delay and the even will be fired the moment the button is
6355 * @param obj The button object
6356 * @param t Timeout in seconds
6358 * @see elm_button_autorepeat_set()
6359 * @see elm_button_autorepeat_gap_timeout_set()
6361 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6363 * Get the initial timeout before the autorepeat event is generated
6365 * @param obj The button object
6366 * @return Timeout in seconds
6368 * @see elm_button_autorepeat_initial_timeout_set()
6370 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6372 * Set the interval between each generated autorepeat event
6374 * After the first @c repeated event is fired, all subsequent ones will
6375 * follow after a delay of @p t seconds for each.
6377 * @param obj The button object
6378 * @param t Interval in seconds
6380 * @see elm_button_autorepeat_initial_timeout_set()
6382 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6384 * Get the interval between each generated autorepeat event
6386 * @param obj The button object
6387 * @return Interval in seconds
6389 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6395 * @defgroup File_Selector_Button File Selector Button
6397 * @image html img/widget/fileselector_button/preview-00.png
6398 * @image latex img/widget/fileselector_button/preview-00.eps
6399 * @image html img/widget/fileselector_button/preview-01.png
6400 * @image latex img/widget/fileselector_button/preview-01.eps
6401 * @image html img/widget/fileselector_button/preview-02.png
6402 * @image latex img/widget/fileselector_button/preview-02.eps
6404 * This is a button that, when clicked, creates an Elementary
6405 * window (or inner window) <b> with a @ref Fileselector "file
6406 * selector widget" within</b>. When a file is chosen, the (inner)
6407 * window is closed and the button emits a signal having the
6408 * selected file as it's @c event_info.
6410 * This widget encapsulates operations on its internal file
6411 * selector on its own API. There is less control over its file
6412 * selector than that one would have instatiating one directly.
6414 * The following styles are available for this button:
6417 * @li @c "hoversel_vertical"
6418 * @li @c "hoversel_vertical_entry"
6420 * Smart callbacks one can register to:
6421 * - @c "file,chosen" - the user has selected a path, whose string
6422 * pointer comes as the @c event_info data (a stringshared
6425 * Here is an example on its usage:
6426 * @li @ref fileselector_button_example
6428 * @see @ref File_Selector_Entry for a similar widget.
6433 * Add a new file selector button widget to the given parent
6434 * Elementary (container) object
6436 * @param parent The parent object
6437 * @return a new file selector button widget handle or @c NULL, on
6440 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6443 * Set the label for a given file selector button widget
6445 * @param obj The file selector button widget
6446 * @param label The text label to be displayed on @p obj
6448 * @deprecated use elm_object_text_set() instead.
6450 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6453 * Get the label set for a given file selector button widget
6455 * @param obj The file selector button widget
6456 * @return The button label
6458 * @deprecated use elm_object_text_set() instead.
6460 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6463 * Set the icon on a given file selector button widget
6465 * @param obj The file selector button widget
6466 * @param icon The icon object for the button
6468 * Once the icon object is set, a previously set one will be
6469 * deleted. If you want to keep the latter, use the
6470 * elm_fileselector_button_icon_unset() function.
6472 * @see elm_fileselector_button_icon_get()
6474 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6477 * Get the icon set for a given file selector button widget
6479 * @param obj The file selector button widget
6480 * @return The icon object currently set on @p obj or @c NULL, if
6483 * @see elm_fileselector_button_icon_set()
6485 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6488 * Unset the icon used in a given file selector button widget
6490 * @param obj The file selector button widget
6491 * @return The icon object that was being used on @p obj or @c
6494 * Unparent and return the icon object which was set for this
6497 * @see elm_fileselector_button_icon_set()
6499 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6502 * Set the title for a given file selector button widget's window
6504 * @param obj The file selector button widget
6505 * @param title The title string
6507 * This will change the window's title, when the file selector pops
6508 * out after a click on the button. Those windows have the default
6509 * (unlocalized) value of @c "Select a file" as titles.
6511 * @note It will only take any effect if the file selector
6512 * button widget is @b not under "inwin mode".
6514 * @see elm_fileselector_button_window_title_get()
6516 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6519 * Get the title set for a given file selector button widget's
6522 * @param obj The file selector button widget
6523 * @return Title of the file selector button's window
6525 * @see elm_fileselector_button_window_title_get() for more details
6527 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6530 * Set the size of a given file selector button widget's window,
6531 * holding the file selector itself.
6533 * @param obj The file selector button widget
6534 * @param width The window's width
6535 * @param height The window's height
6537 * @note it will only take any effect if the file selector button
6538 * widget is @b not under "inwin mode". The default size for the
6539 * window (when applicable) is 400x400 pixels.
6541 * @see elm_fileselector_button_window_size_get()
6543 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6546 * Get the size of a given file selector button widget's window,
6547 * holding the file selector itself.
6549 * @param obj The file selector button widget
6550 * @param width Pointer into which to store the width value
6551 * @param height Pointer into which to store the height value
6553 * @note Use @c NULL pointers on the size values you're not
6554 * interested in: they'll be ignored by the function.
6556 * @see elm_fileselector_button_window_size_set(), for more details
6558 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6561 * Set the initial file system path for a given file selector
6564 * @param obj The file selector button widget
6565 * @param path The path string
6567 * It must be a <b>directory</b> path, which will have the contents
6568 * displayed initially in the file selector's view, when invoked
6569 * from @p obj. The default initial path is the @c "HOME"
6570 * environment variable's value.
6572 * @see elm_fileselector_button_path_get()
6574 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6577 * Get the initial file system path set for a given file selector
6580 * @param obj The file selector button widget
6581 * @return path The path string
6583 * @see elm_fileselector_button_path_set() for more details
6585 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6588 * Enable/disable a tree view in the given file selector button
6589 * widget's internal file selector
6591 * @param obj The file selector button widget
6592 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6595 * This has the same effect as elm_fileselector_expandable_set(),
6596 * but now applied to a file selector button's internal file
6599 * @note There's no way to put a file selector button's internal
6600 * file selector in "grid mode", as one may do with "pure" file
6603 * @see elm_fileselector_expandable_get()
6605 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6608 * Get whether tree view is enabled for the given file selector
6609 * button widget's internal file selector
6611 * @param obj The file selector button widget
6612 * @return @c EINA_TRUE if @p obj widget's internal file selector
6613 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6615 * @see elm_fileselector_expandable_set() for more details
6617 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6620 * Set whether a given file selector button widget's internal file
6621 * selector is to display folders only or the directory contents,
6624 * @param obj The file selector button widget
6625 * @param only @c EINA_TRUE to make @p obj widget's internal file
6626 * selector only display directories, @c EINA_FALSE to make files
6627 * to be displayed in it too
6629 * This has the same effect as elm_fileselector_folder_only_set(),
6630 * but now applied to a file selector button's internal file
6633 * @see elm_fileselector_folder_only_get()
6635 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6638 * Get whether a given file selector button widget's internal file
6639 * selector is displaying folders only or the directory contents,
6642 * @param obj The file selector button widget
6643 * @return @c EINA_TRUE if @p obj widget's internal file
6644 * selector is only displaying directories, @c EINA_FALSE if files
6645 * are being displayed in it too (and on errors)
6647 * @see elm_fileselector_button_folder_only_set() for more details
6649 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6652 * Enable/disable the file name entry box where the user can type
6653 * in a name for a file, in a given file selector button widget's
6654 * internal file selector.
6656 * @param obj The file selector button widget
6657 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6658 * file selector a "saving dialog", @c EINA_FALSE otherwise
6660 * This has the same effect as elm_fileselector_is_save_set(),
6661 * but now applied to a file selector button's internal file
6664 * @see elm_fileselector_is_save_get()
6666 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6669 * Get whether the given file selector button widget's internal
6670 * file selector is in "saving dialog" mode
6672 * @param obj The file selector button widget
6673 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6674 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6677 * @see elm_fileselector_button_is_save_set() for more details
6679 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6682 * Set whether a given file selector button widget's internal file
6683 * selector will raise an Elementary "inner window", instead of a
6684 * dedicated Elementary window. By default, it won't.
6686 * @param obj The file selector button widget
6687 * @param value @c EINA_TRUE to make it use an inner window, @c
6688 * EINA_TRUE to make it use a dedicated window
6690 * @see elm_win_inwin_add() for more information on inner windows
6691 * @see elm_fileselector_button_inwin_mode_get()
6693 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6696 * Get whether a given file selector button widget's internal file
6697 * selector will raise an Elementary "inner window", instead of a
6698 * dedicated Elementary window.
6700 * @param obj The file selector button widget
6701 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6702 * if it will use a dedicated window
6704 * @see elm_fileselector_button_inwin_mode_set() for more details
6706 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6713 * @defgroup File_Selector_Entry File Selector Entry
6715 * @image html img/widget/fileselector_entry/preview-00.png
6716 * @image latex img/widget/fileselector_entry/preview-00.eps
6718 * This is an entry made to be filled with or display a <b>file
6719 * system path string</b>. Besides the entry itself, the widget has
6720 * a @ref File_Selector_Button "file selector button" on its side,
6721 * which will raise an internal @ref Fileselector "file selector widget",
6722 * when clicked, for path selection aided by file system
6725 * This file selector may appear in an Elementary window or in an
6726 * inner window. When a file is chosen from it, the (inner) window
6727 * is closed and the selected file's path string is exposed both as
6728 * an smart event and as the new text on the entry.
6730 * This widget encapsulates operations on its internal file
6731 * selector on its own API. There is less control over its file
6732 * selector than that one would have instatiating one directly.
6734 * Smart callbacks one can register to:
6735 * - @c "changed" - The text within the entry was changed
6736 * - @c "activated" - The entry has had editing finished and
6737 * changes are to be "committed"
6738 * - @c "press" - The entry has been clicked
6739 * - @c "longpressed" - The entry has been clicked (and held) for a
6741 * - @c "clicked" - The entry has been clicked
6742 * - @c "clicked,double" - The entry has been double clicked
6743 * - @c "focused" - The entry has received focus
6744 * - @c "unfocused" - The entry has lost focus
6745 * - @c "selection,paste" - A paste action has occurred on the
6747 * - @c "selection,copy" - A copy action has occurred on the entry
6748 * - @c "selection,cut" - A cut action has occurred on the entry
6749 * - @c "unpressed" - The file selector entry's button was released
6750 * after being pressed.
6751 * - @c "file,chosen" - The user has selected a path via the file
6752 * selector entry's internal file selector, whose string pointer
6753 * comes as the @c event_info data (a stringshared string)
6755 * Here is an example on its usage:
6756 * @li @ref fileselector_entry_example
6758 * @see @ref File_Selector_Button for a similar widget.
6763 * Add a new file selector entry widget to the given parent
6764 * Elementary (container) object
6766 * @param parent The parent object
6767 * @return a new file selector entry widget handle or @c NULL, on
6770 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6773 * Set the label for a given file selector entry widget's button
6775 * @param obj The file selector entry widget
6776 * @param label The text label to be displayed on @p obj widget's
6779 * @deprecated use elm_object_text_set() instead.
6781 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6784 * Get the label set for a given file selector entry widget's button
6786 * @param obj The file selector entry widget
6787 * @return The widget button's label
6789 * @deprecated use elm_object_text_set() instead.
6791 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6794 * Set the icon on a given file selector entry widget's button
6796 * @param obj The file selector entry widget
6797 * @param icon The icon object for the entry's button
6799 * Once the icon object is set, a previously set one will be
6800 * deleted. If you want to keep the latter, use the
6801 * elm_fileselector_entry_button_icon_unset() function.
6803 * @see elm_fileselector_entry_button_icon_get()
6805 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6808 * Get the icon set for a given file selector entry widget's button
6810 * @param obj The file selector entry widget
6811 * @return The icon object currently set on @p obj widget's button
6812 * or @c NULL, if none is
6814 * @see elm_fileselector_entry_button_icon_set()
6816 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6819 * Unset the icon used in a given file selector entry widget's
6822 * @param obj The file selector entry widget
6823 * @return The icon object that was being used on @p obj widget's
6824 * button or @c NULL, on errors
6826 * Unparent and return the icon object which was set for this
6829 * @see elm_fileselector_entry_button_icon_set()
6831 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6834 * Set the title for a given file selector entry widget's window
6836 * @param obj The file selector entry widget
6837 * @param title The title string
6839 * This will change the window's title, when the file selector pops
6840 * out after a click on the entry's button. Those windows have the
6841 * default (unlocalized) value of @c "Select a file" as titles.
6843 * @note It will only take any effect if the file selector
6844 * entry widget is @b not under "inwin mode".
6846 * @see elm_fileselector_entry_window_title_get()
6848 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6851 * Get the title set for a given file selector entry widget's
6854 * @param obj The file selector entry widget
6855 * @return Title of the file selector entry's window
6857 * @see elm_fileselector_entry_window_title_get() for more details
6859 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6862 * Set the size of a given file selector entry widget's window,
6863 * holding the file selector itself.
6865 * @param obj The file selector entry widget
6866 * @param width The window's width
6867 * @param height The window's height
6869 * @note it will only take any effect if the file selector entry
6870 * widget is @b not under "inwin mode". The default size for the
6871 * window (when applicable) is 400x400 pixels.
6873 * @see elm_fileselector_entry_window_size_get()
6875 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6878 * Get the size of a given file selector entry widget's window,
6879 * holding the file selector itself.
6881 * @param obj The file selector entry widget
6882 * @param width Pointer into which to store the width value
6883 * @param height Pointer into which to store the height value
6885 * @note Use @c NULL pointers on the size values you're not
6886 * interested in: they'll be ignored by the function.
6888 * @see elm_fileselector_entry_window_size_set(), for more details
6890 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6893 * Set the initial file system path and the entry's path string for
6894 * a given file selector entry widget
6896 * @param obj The file selector entry widget
6897 * @param path The path string
6899 * It must be a <b>directory</b> path, which will have the contents
6900 * displayed initially in the file selector's view, when invoked
6901 * from @p obj. The default initial path is the @c "HOME"
6902 * environment variable's value.
6904 * @see elm_fileselector_entry_path_get()
6906 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6909 * Get the entry's path string for a given file selector entry
6912 * @param obj The file selector entry widget
6913 * @return path The path string
6915 * @see elm_fileselector_entry_path_set() for more details
6917 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6920 * Enable/disable a tree view in the given file selector entry
6921 * widget's internal file selector
6923 * @param obj The file selector entry widget
6924 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6927 * This has the same effect as elm_fileselector_expandable_set(),
6928 * but now applied to a file selector entry's internal file
6931 * @note There's no way to put a file selector entry's internal
6932 * file selector in "grid mode", as one may do with "pure" file
6935 * @see elm_fileselector_expandable_get()
6937 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6940 * Get whether tree view is enabled for the given file selector
6941 * entry widget's internal file selector
6943 * @param obj The file selector entry widget
6944 * @return @c EINA_TRUE if @p obj widget's internal file selector
6945 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6947 * @see elm_fileselector_expandable_set() for more details
6949 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6952 * Set whether a given file selector entry widget's internal file
6953 * selector is to display folders only or the directory contents,
6956 * @param obj The file selector entry widget
6957 * @param only @c EINA_TRUE to make @p obj widget's internal file
6958 * selector only display directories, @c EINA_FALSE to make files
6959 * to be displayed in it too
6961 * This has the same effect as elm_fileselector_folder_only_set(),
6962 * but now applied to a file selector entry's internal file
6965 * @see elm_fileselector_folder_only_get()
6967 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6970 * Get whether a given file selector entry widget's internal file
6971 * selector is displaying folders only or the directory contents,
6974 * @param obj The file selector entry widget
6975 * @return @c EINA_TRUE if @p obj widget's internal file
6976 * selector is only displaying directories, @c EINA_FALSE if files
6977 * are being displayed in it too (and on errors)
6979 * @see elm_fileselector_entry_folder_only_set() for more details
6981 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6984 * Enable/disable the file name entry box where the user can type
6985 * in a name for a file, in a given file selector entry widget's
6986 * internal file selector.
6988 * @param obj The file selector entry widget
6989 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6990 * file selector a "saving dialog", @c EINA_FALSE otherwise
6992 * This has the same effect as elm_fileselector_is_save_set(),
6993 * but now applied to a file selector entry's internal file
6996 * @see elm_fileselector_is_save_get()
6998 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7001 * Get whether the given file selector entry widget's internal
7002 * file selector is in "saving dialog" mode
7004 * @param obj The file selector entry widget
7005 * @return @c EINA_TRUE, if @p obj widget's internal file selector
7006 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7009 * @see elm_fileselector_entry_is_save_set() for more details
7011 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7014 * Set whether a given file selector entry widget's internal file
7015 * selector will raise an Elementary "inner window", instead of a
7016 * dedicated Elementary window. By default, it won't.
7018 * @param obj The file selector entry widget
7019 * @param value @c EINA_TRUE to make it use an inner window, @c
7020 * EINA_TRUE to make it use a dedicated window
7022 * @see elm_win_inwin_add() for more information on inner windows
7023 * @see elm_fileselector_entry_inwin_mode_get()
7025 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7028 * Get whether a given file selector entry widget's internal file
7029 * selector will raise an Elementary "inner window", instead of a
7030 * dedicated Elementary window.
7032 * @param obj The file selector entry widget
7033 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7034 * if it will use a dedicated window
7036 * @see elm_fileselector_entry_inwin_mode_set() for more details
7038 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7041 * Set the initial file system path for a given file selector entry
7044 * @param obj The file selector entry widget
7045 * @param path The path string
7047 * It must be a <b>directory</b> path, which will have the contents
7048 * displayed initially in the file selector's view, when invoked
7049 * from @p obj. The default initial path is the @c "HOME"
7050 * environment variable's value.
7052 * @see elm_fileselector_entry_path_get()
7054 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7057 * Get the parent directory's path to the latest file selection on
7058 * a given filer selector entry widget
7060 * @param obj The file selector object
7061 * @return The (full) path of the directory of the last selection
7062 * on @p obj widget, a @b stringshared string
7064 * @see elm_fileselector_entry_path_set()
7066 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7073 * @defgroup Scroller Scroller
7075 * A scroller holds a single object and "scrolls it around". This means that
7076 * it allows the user to use a scrollbar (or a finger) to drag the viewable
7077 * region around, allowing to move through a much larger object that is
7078 * contained in the scroller. The scroller will always have a small minimum
7079 * size by default as it won't be limited by the contents of the scroller.
7081 * Signals that you can add callbacks for are:
7082 * @li "edge,left" - the left edge of the content has been reached
7083 * @li "edge,right" - the right edge of the content has been reached
7084 * @li "edge,top" - the top edge of the content has been reached
7085 * @li "edge,bottom" - the bottom edge of the content has been reached
7086 * @li "scroll" - the content has been scrolled (moved)
7087 * @li "scroll,anim,start" - scrolling animation has started
7088 * @li "scroll,anim,stop" - scrolling animation has stopped
7089 * @li "scroll,drag,start" - dragging the contents around has started
7090 * @li "scroll,drag,stop" - dragging the contents around has stopped
7091 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7094 * @note When Elemementary is in embedded mode the scrollbars will not be
7095 * dragable, they appear merely as indicators of how much has been scrolled.
7096 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7097 * fingerscroll) won't work.
7099 * To set/get/unset the content of the panel, you can use
7100 * elm_object_content_set/get/unset APIs.
7101 * Once the content object is set, a previously set one will be deleted.
7102 * If you want to keep that old content object, use the
7103 * elm_object_content_unset() function
7105 * In @ref tutorial_scroller you'll find an example of how to use most of
7110 * @brief Type that controls when scrollbars should appear.
7112 * @see elm_scroller_policy_set()
7114 typedef enum _Elm_Scroller_Policy
7116 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7117 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7118 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7119 ELM_SCROLLER_POLICY_LAST
7120 } Elm_Scroller_Policy;
7122 * @brief Add a new scroller to the parent
7124 * @param parent The parent object
7125 * @return The new object or NULL if it cannot be created
7127 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7129 * @brief Set the content of the scroller widget (the object to be scrolled around).
7131 * @param obj The scroller object
7132 * @param content The new content object
7134 * Once the content object is set, a previously set one will be deleted.
7135 * If you want to keep that old content object, use the
7136 * elm_scroller_content_unset() function.
7137 * @deprecated use elm_object_content_set() instead
7139 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7141 * @brief Get the content of the scroller widget
7143 * @param obj The slider object
7144 * @return The content that is being used
7146 * Return the content object which is set for this widget
7148 * @see elm_scroller_content_set()
7149 * @deprecated use elm_object_content_get() instead.
7151 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7153 * @brief Unset the content of the scroller widget
7155 * @param obj The slider object
7156 * @return The content that was being used
7158 * Unparent and return the content object which was set for this widget
7160 * @see elm_scroller_content_set()
7161 * @deprecated use elm_object_content_unset() instead.
7163 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7165 * @brief Set custom theme elements for the scroller
7167 * @param obj The scroller object
7168 * @param widget The widget name to use (default is "scroller")
7169 * @param base The base name to use (default is "base")
7171 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7173 * @brief Make the scroller minimum size limited to the minimum size of the content
7175 * @param obj The scroller object
7176 * @param w Enable limiting minimum size horizontally
7177 * @param h Enable limiting minimum size vertically
7179 * By default the scroller will be as small as its design allows,
7180 * irrespective of its content. This will make the scroller minimum size the
7181 * right size horizontally and/or vertically to perfectly fit its content in
7184 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7186 * @brief Show a specific virtual region within the scroller content object
7188 * @param obj The scroller object
7189 * @param x X coordinate of the region
7190 * @param y Y coordinate of the region
7191 * @param w Width of the region
7192 * @param h Height of the region
7194 * This will ensure all (or part if it does not fit) of the designated
7195 * region in the virtual content object (0, 0 starting at the top-left of the
7196 * virtual content object) is shown within the scroller.
7198 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);
7200 * @brief Set the scrollbar visibility policy
7202 * @param obj The scroller object
7203 * @param policy_h Horizontal scrollbar policy
7204 * @param policy_v Vertical scrollbar policy
7206 * This sets the scrollbar visibility policy for the given scroller.
7207 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7208 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7209 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7210 * respectively for the horizontal and vertical scrollbars.
7212 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7214 * @brief Gets scrollbar visibility policy
7216 * @param obj The scroller object
7217 * @param policy_h Horizontal scrollbar policy
7218 * @param policy_v Vertical scrollbar policy
7220 * @see elm_scroller_policy_set()
7222 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7224 * @brief Get the currently visible content region
7226 * @param obj The scroller object
7227 * @param x X coordinate of the region
7228 * @param y Y coordinate of the region
7229 * @param w Width of the region
7230 * @param h Height of the region
7232 * This gets the current region in the content object that is visible through
7233 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7234 * w, @p h values pointed to.
7236 * @note All coordinates are relative to the content.
7238 * @see elm_scroller_region_show()
7240 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);
7242 * @brief Get the size of the content object
7244 * @param obj The scroller object
7245 * @param w Width of the content object.
7246 * @param h Height of the content object.
7248 * This gets the size of the content object of the scroller.
7250 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7252 * @brief Set bouncing behavior
7254 * @param obj The scroller object
7255 * @param h_bounce Allow bounce horizontally
7256 * @param v_bounce Allow bounce vertically
7258 * When scrolling, the scroller may "bounce" when reaching an edge of the
7259 * content object. This is a visual way to indicate the end has been reached.
7260 * This is enabled by default for both axis. This API will set if it is enabled
7261 * for the given axis with the boolean parameters for each axis.
7263 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7265 * @brief Get the bounce behaviour
7267 * @param obj The Scroller object
7268 * @param h_bounce Will the scroller bounce horizontally or not
7269 * @param v_bounce Will the scroller bounce vertically or not
7271 * @see elm_scroller_bounce_set()
7273 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7275 * @brief Set scroll page size relative to viewport size.
7277 * @param obj The scroller object
7278 * @param h_pagerel The horizontal page relative size
7279 * @param v_pagerel The vertical page relative size
7281 * The scroller is capable of limiting scrolling by the user to "pages". That
7282 * is to jump by and only show a "whole page" at a time as if the continuous
7283 * area of the scroller content is split into page sized pieces. This sets
7284 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7285 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7286 * axis. This is mutually exclusive with page size
7287 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7288 * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7289 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7292 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7294 * @brief Set scroll page size.
7296 * @param obj The scroller object
7297 * @param h_pagesize The horizontal page size
7298 * @param v_pagesize The vertical page size
7300 * This sets the page size to an absolute fixed value, with 0 turning it off
7303 * @see elm_scroller_page_relative_set()
7305 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7307 * @brief Get scroll current page number.
7309 * @param obj The scroller object
7310 * @param h_pagenumber The horizontal page number
7311 * @param v_pagenumber The vertical page number
7313 * The page number starts from 0. 0 is the first page.
7314 * Current page means the page which meets the top-left of the viewport.
7315 * If there are two or more pages in the viewport, it returns the number of the page
7316 * which meets the top-left of the viewport.
7318 * @see elm_scroller_last_page_get()
7319 * @see elm_scroller_page_show()
7320 * @see elm_scroller_page_brint_in()
7322 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7324 * @brief Get scroll last page number.
7326 * @param obj The scroller object
7327 * @param h_pagenumber The horizontal page number
7328 * @param v_pagenumber The vertical page number
7330 * The page number starts from 0. 0 is the first page.
7331 * This returns the last page number among the pages.
7333 * @see elm_scroller_current_page_get()
7334 * @see elm_scroller_page_show()
7335 * @see elm_scroller_page_brint_in()
7337 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7339 * Show a specific virtual region within the scroller content object by page number.
7341 * @param obj The scroller object
7342 * @param h_pagenumber The horizontal page number
7343 * @param v_pagenumber The vertical page number
7345 * 0, 0 of the indicated page is located at the top-left of the viewport.
7346 * This will jump to the page directly without animation.
7351 * sc = elm_scroller_add(win);
7352 * elm_scroller_content_set(sc, content);
7353 * elm_scroller_page_relative_set(sc, 1, 0);
7354 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7355 * elm_scroller_page_show(sc, h_page + 1, v_page);
7358 * @see elm_scroller_page_bring_in()
7360 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7362 * Show a specific virtual region within the scroller content object by page number.
7364 * @param obj The scroller object
7365 * @param h_pagenumber The horizontal page number
7366 * @param v_pagenumber The vertical page number
7368 * 0, 0 of the indicated page is located at the top-left of the viewport.
7369 * This will slide to the page with animation.
7374 * sc = elm_scroller_add(win);
7375 * elm_scroller_content_set(sc, content);
7376 * elm_scroller_page_relative_set(sc, 1, 0);
7377 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7378 * elm_scroller_page_bring_in(sc, h_page, v_page);
7381 * @see elm_scroller_page_show()
7383 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7385 * @brief Show a specific virtual region within the scroller content object.
7387 * @param obj The scroller object
7388 * @param x X coordinate of the region
7389 * @param y Y coordinate of the region
7390 * @param w Width of the region
7391 * @param h Height of the region
7393 * This will ensure all (or part if it does not fit) of the designated
7394 * region in the virtual content object (0, 0 starting at the top-left of the
7395 * virtual content object) is shown within the scroller. Unlike
7396 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7397 * to this location (if configuration in general calls for transitions). It
7398 * may not jump immediately to the new location and make take a while and
7399 * show other content along the way.
7401 * @see elm_scroller_region_show()
7403 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);
7405 * @brief Set event propagation on a scroller
7407 * @param obj The scroller object
7408 * @param propagation If propagation is enabled or not
7410 * This enables or disabled event propagation from the scroller content to
7411 * the scroller and its parent. By default event propagation is disabled.
7413 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7415 * @brief Get event propagation for a scroller
7417 * @param obj The scroller object
7418 * @return The propagation state
7420 * This gets the event propagation for a scroller.
7422 * @see elm_scroller_propagate_events_set()
7424 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7426 * @brief Set scrolling gravity on a scroller
7428 * @param obj The scroller object
7429 * @param x The scrolling horizontal gravity
7430 * @param y The scrolling vertical gravity
7432 * The gravity, defines how the scroller will adjust its view
7433 * when the size of the scroller contents increase.
7435 * The scroller will adjust the view to glue itself as follows.
7437 * x=0.0, for showing the left most region of the content.
7438 * x=1.0, for showing the right most region of the content.
7439 * y=0.0, for showing the bottom most region of the content.
7440 * y=1.0, for showing the top most region of the content.
7442 * Default values for x and y are 0.0
7444 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7446 * @brief Get scrolling gravity values for a scroller
7448 * @param obj The scroller object
7449 * @param x The scrolling horizontal gravity
7450 * @param y The scrolling vertical gravity
7452 * This gets gravity values for a scroller.
7454 * @see elm_scroller_gravity_set()
7457 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7463 * @defgroup Label Label
7465 * @image html img/widget/label/preview-00.png
7466 * @image latex img/widget/label/preview-00.eps
7468 * @brief Widget to display text, with simple html-like markup.
7470 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7471 * text doesn't fit the geometry of the label it will be ellipsized or be
7472 * cut. Elementary provides several themes for this widget:
7473 * @li default - No animation
7474 * @li marker - Centers the text in the label and make it bold by default
7475 * @li slide_long - The entire text appears from the right of the screen and
7476 * slides until it disappears in the left of the screen(reappering on the
7478 * @li slide_short - The text appears in the left of the label and slides to
7479 * the right to show the overflow. When all of the text has been shown the
7480 * position is reset.
7481 * @li slide_bounce - The text appears in the left of the label and slides to
7482 * the right to show the overflow. When all of the text has been shown the
7483 * animation reverses, moving the text to the left.
7485 * Custom themes can of course invent new markup tags and style them any way
7488 * The following signals may be emitted by the label widget:
7489 * @li "language,changed": The program's language changed.
7491 * See @ref tutorial_label for a demonstration of how to use a label widget.
7495 * @brief Add a new label to the parent
7497 * @param parent The parent object
7498 * @return The new object or NULL if it cannot be created
7500 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7502 * @brief Set the label on the label object
7504 * @param obj The label object
7505 * @param label The label will be used on the label object
7506 * @deprecated See elm_object_text_set()
7508 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 */
7510 * @brief Get the label used on the label object
7512 * @param obj The label object
7513 * @return The string inside the label
7514 * @deprecated See elm_object_text_get()
7516 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7518 * @brief Set the wrapping behavior of the label
7520 * @param obj The label object
7521 * @param wrap To wrap text or not
7523 * By default no wrapping is done. Possible values for @p wrap are:
7524 * @li ELM_WRAP_NONE - No wrapping
7525 * @li ELM_WRAP_CHAR - wrap between characters
7526 * @li ELM_WRAP_WORD - wrap between words
7527 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7529 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7531 * @brief Get the wrapping behavior of the label
7533 * @param obj The label object
7536 * @see elm_label_line_wrap_set()
7538 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7540 * @brief Set wrap width of the label
7542 * @param obj The label object
7543 * @param w The wrap width in pixels at a minimum where words need to wrap
7545 * This function sets the maximum width size hint of the label.
7547 * @warning This is only relevant if the label is inside a container.
7549 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7551 * @brief Get wrap width of the label
7553 * @param obj The label object
7554 * @return The wrap width in pixels at a minimum where words need to wrap
7556 * @see elm_label_wrap_width_set()
7558 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7560 * @brief Set wrap height of the label
7562 * @param obj The label object
7563 * @param h The wrap height in pixels at a minimum where words need to wrap
7565 * This function sets the maximum height size hint of the label.
7567 * @warning This is only relevant if the label is inside a container.
7569 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7571 * @brief get wrap width of the label
7573 * @param obj The label object
7574 * @return The wrap height in pixels at a minimum where words need to wrap
7576 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7578 * @brief Set the font size on the label object.
7580 * @param obj The label object
7581 * @param size font size
7583 * @warning NEVER use this. It is for hyper-special cases only. use styles
7584 * instead. e.g. "big", "medium", "small" - or better name them by use:
7585 * "title", "footnote", "quote" etc.
7587 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7589 * @brief Set the text color on the label object
7591 * @param obj The label object
7592 * @param r Red property background color of The label object
7593 * @param g Green property background color of The label object
7594 * @param b Blue property background color of The label object
7595 * @param a Alpha property background color of The label object
7597 * @warning NEVER use this. It is for hyper-special cases only. use styles
7598 * instead. e.g. "big", "medium", "small" - or better name them by use:
7599 * "title", "footnote", "quote" etc.
7601 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);
7603 * @brief Set the text align on the label object
7605 * @param obj The label object
7606 * @param align align mode ("left", "center", "right")
7608 * @warning NEVER use this. It is for hyper-special cases only. use styles
7609 * instead. e.g. "big", "medium", "small" - or better name them by use:
7610 * "title", "footnote", "quote" etc.
7612 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7614 * @brief Set background color of the label
7616 * @param obj The label object
7617 * @param r Red property background color of The label object
7618 * @param g Green property background color of The label object
7619 * @param b Blue property background color of The label object
7620 * @param a Alpha property background alpha of The label object
7622 * @warning NEVER use this. It is for hyper-special cases only. use styles
7623 * instead. e.g. "big", "medium", "small" - or better name them by use:
7624 * "title", "footnote", "quote" etc.
7626 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);
7628 * @brief Set the ellipsis behavior of the label
7630 * @param obj The label object
7631 * @param ellipsis To ellipsis text or not
7633 * If set to true and the text doesn't fit in the label an ellipsis("...")
7634 * will be shown at the end of the widget.
7636 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7637 * choosen wrap method was ELM_WRAP_WORD.
7639 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7640 EINA_DEPRECATED EAPI void elm_label_wrap_mode_set(Evas_Object *obj, Eina_Bool wrapmode) EINA_ARG_NONNULL(1);
7642 * @brief Set the text slide of the label
7644 * @param obj The label object
7645 * @param slide To start slide or stop
7647 * If set to true, the text of the label will slide/scroll through the length of
7650 * @warning This only works with the themes "slide_short", "slide_long" and
7653 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7655 * @brief Get the text slide mode of the label
7657 * @param obj The label object
7658 * @return slide slide mode value
7660 * @see elm_label_slide_set()
7662 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7664 * @brief Set the slide duration(speed) of the label
7666 * @param obj The label object
7667 * @return The duration in seconds in moving text from slide begin position
7668 * to slide end position
7670 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7672 * @brief Get the slide duration(speed) of the label
7674 * @param obj The label object
7675 * @return The duration time in moving text from slide begin position to slide end position
7677 * @see elm_label_slide_duration_set()
7679 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7685 * @defgroup Toggle Toggle
7687 * @image html img/widget/toggle/preview-00.png
7688 * @image latex img/widget/toggle/preview-00.eps
7690 * @brief A toggle is a slider which can be used to toggle between
7691 * two values. It has two states: on and off.
7693 * This widget is deprecated. Please use elm_check_add() instead using the
7694 * toggle style like:
7697 * obj = elm_check_add(parent);
7698 * elm_object_style_set(obj, "toggle");
7699 * elm_object_text_part_set(obj, "on", "ON");
7700 * elm_object_text_part_set(obj, "off", "OFF");
7703 * Signals that you can add callbacks for are:
7704 * @li "changed" - Whenever the toggle value has been changed. Is not called
7705 * until the toggle is released by the cursor (assuming it
7706 * has been triggered by the cursor in the first place).
7708 * @ref tutorial_toggle show how to use a toggle.
7712 * @brief Add a toggle to @p parent.
7714 * @param parent The parent object
7716 * @return The toggle object
7718 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7720 * @brief Sets the label to be displayed with the toggle.
7722 * @param obj The toggle object
7723 * @param label The label to be displayed
7725 * @deprecated use elm_object_text_set() instead.
7727 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7729 * @brief Gets the label of the toggle
7731 * @param obj toggle object
7732 * @return The label of the toggle
7734 * @deprecated use elm_object_text_get() instead.
7736 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7738 * @brief Set the icon used for the toggle
7740 * @param obj The toggle object
7741 * @param icon The icon object for the button
7743 * Once the icon object is set, a previously set one will be deleted
7744 * If you want to keep that old content object, use the
7745 * elm_toggle_icon_unset() function.
7747 * @deprecated use elm_object_content_set() instead.
7749 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7751 * @brief Get the icon used for the toggle
7753 * @param obj The toggle object
7754 * @return The icon object that is being used
7756 * Return the icon object which is set for this widget.
7758 * @see elm_toggle_icon_set()
7760 * @deprecated use elm_object_content_get() instead.
7762 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7764 * @brief Unset the icon used for the toggle
7766 * @param obj The toggle object
7767 * @return The icon object that was being used
7769 * Unparent and return the icon object which was set for this widget.
7771 * @see elm_toggle_icon_set()
7773 * @deprecated use elm_object_content_unset() instead.
7775 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7777 * @brief Sets the labels to be associated with the on and off states of the toggle.
7779 * @param obj The toggle object
7780 * @param onlabel The label displayed when the toggle is in the "on" state
7781 * @param offlabel The label displayed when the toggle is in the "off" state
7783 * @deprecated use elm_object_text_part_set() for "on" and "off" parts
7786 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7788 * @brief Gets the labels associated with the on and off states of the
7791 * @param obj The toggle object
7792 * @param onlabel A char** to place the onlabel of @p obj into
7793 * @param offlabel A char** to place the offlabel of @p obj into
7795 * @deprecated use elm_object_text_part_get() for "on" and "off" parts
7798 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7800 * @brief Sets the state of the toggle to @p state.
7802 * @param obj The toggle object
7803 * @param state The state of @p obj
7805 * @deprecated use elm_check_state_set() instead.
7807 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7809 * @brief Gets the state of the toggle to @p state.
7811 * @param obj The toggle object
7812 * @return The state of @p obj
7814 * @deprecated use elm_check_state_get() instead.
7816 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7818 * @brief Sets the state pointer of the toggle to @p statep.
7820 * @param obj The toggle object
7821 * @param statep The state pointer of @p obj
7823 * @deprecated use elm_check_state_pointer_set() instead.
7825 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7831 * @defgroup Frame Frame
7833 * @image html img/widget/frame/preview-00.png
7834 * @image latex img/widget/frame/preview-00.eps
7836 * @brief Frame is a widget that holds some content and has a title.
7838 * The default look is a frame with a title, but Frame supports multple
7846 * @li outdent_bottom
7848 * Of all this styles only default shows the title. Frame emits no signals.
7850 * Default contents parts of the frame widget that you can use for are:
7851 * @li "elm.swallow.content" - A content of the frame
7853 * Default text parts of the frame widget that you can use for are:
7854 * @li "elm.text" - Label of the frame
7856 * For a detailed example see the @ref tutorial_frame.
7861 * @brief Add a new frame to the parent
7863 * @param parent The parent object
7864 * @return The new object or NULL if it cannot be created
7866 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7868 * @brief Set the frame label
7870 * @param obj The frame object
7871 * @param label The label of this frame object
7873 * @deprecated use elm_object_text_set() instead.
7875 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7877 * @brief Get the frame label
7879 * @param obj The frame object
7881 * @return The label of this frame objet or NULL if unable to get frame
7883 * @deprecated use elm_object_text_get() instead.
7885 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7887 * @brief Set the content of the frame widget
7889 * Once the content object is set, a previously set one will be deleted.
7890 * If you want to keep that old content object, use the
7891 * elm_frame_content_unset() function.
7893 * @param obj The frame object
7894 * @param content The content will be filled in this frame object
7896 * @deprecated use elm_object_content_set() instead.
7898 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7900 * @brief Get the content of the frame widget
7902 * Return the content object which is set for this widget
7904 * @param obj The frame object
7905 * @return The content that is being used
7907 * @deprecated use elm_object_content_get() instead.
7909 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7911 * @brief Unset the content of the frame widget
7913 * Unparent and return the content object which was set for this widget
7915 * @param obj The frame object
7916 * @return The content that was being used
7918 * @deprecated use elm_object_content_unset() instead.
7920 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7926 * @defgroup Table Table
7928 * A container widget to arrange other widgets in a table where items can
7929 * also span multiple columns or rows - even overlap (and then be raised or
7930 * lowered accordingly to adjust stacking if they do overlap).
7932 * For a Table widget the row/column count is not fixed.
7933 * The table widget adjusts itself when subobjects are added to it dynamically.
7935 * The followin are examples of how to use a table:
7936 * @li @ref tutorial_table_01
7937 * @li @ref tutorial_table_02
7942 * @brief Add a new table to the parent
7944 * @param parent The parent object
7945 * @return The new object or NULL if it cannot be created
7947 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7949 * @brief Set the homogeneous layout in the table
7951 * @param obj The layout object
7952 * @param homogeneous A boolean to set if the layout is homogeneous in the
7953 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7955 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7957 * @brief Get the current table homogeneous mode.
7959 * @param obj The table object
7960 * @return A boolean to indicating if the layout is homogeneous in the table
7961 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7963 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7965 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7967 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7969 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7971 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7973 * @brief Set padding between cells.
7975 * @param obj The layout object.
7976 * @param horizontal set the horizontal padding.
7977 * @param vertical set the vertical padding.
7979 * Default value is 0.
7981 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7983 * @brief Get padding between cells.
7985 * @param obj The layout object.
7986 * @param horizontal set the horizontal padding.
7987 * @param vertical set the vertical padding.
7989 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7991 * @brief Add a subobject on the table with the coordinates passed
7993 * @param obj The table object
7994 * @param subobj The subobject to be added to the table
7995 * @param x Row number
7996 * @param y Column number
8000 * @note All positioning inside the table is relative to rows and columns, so
8001 * a value of 0 for x and y, means the top left cell of the table, and a
8002 * value of 1 for w and h means @p subobj only takes that 1 cell.
8004 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8006 * @brief Remove child from table.
8008 * @param obj The table object
8009 * @param subobj The subobject
8011 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
8013 * @brief Faster way to remove all child objects from a table object.
8015 * @param obj The table object
8016 * @param clear If true, will delete children, else just remove from table.
8018 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
8020 * @brief Set the packing location of an existing child of the table
8022 * @param subobj The subobject to be modified in the table
8023 * @param x Row number
8024 * @param y Column number
8028 * Modifies the position of an object already in the table.
8030 * @note All positioning inside the table is relative to rows and columns, so
8031 * a value of 0 for x and y, means the top left cell of the table, and a
8032 * value of 1 for w and h means @p subobj only takes that 1 cell.
8034 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8036 * @brief Get the packing location of an existing child of the table
8038 * @param subobj The subobject to be modified in the table
8039 * @param x Row number
8040 * @param y Column number
8044 * @see elm_table_pack_set()
8046 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
8052 * @defgroup Gengrid Gengrid (Generic grid)
8054 * This widget aims to position objects in a grid layout while
8055 * actually creating and rendering only the visible ones, using the
8056 * same idea as the @ref Genlist "genlist": the user defines a @b
8057 * class for each item, specifying functions that will be called at
8058 * object creation, deletion, etc. When those items are selected by
8059 * the user, a callback function is issued. Users may interact with
8060 * a gengrid via the mouse (by clicking on items to select them and
8061 * clicking on the grid's viewport and swiping to pan the whole
8062 * view) or via the keyboard, navigating through item with the
8065 * @section Gengrid_Layouts Gengrid layouts
8067 * Gengrid may layout its items in one of two possible layouts:
8071 * When in "horizontal mode", items will be placed in @b columns,
8072 * from top to bottom and, when the space for a column is filled,
8073 * another one is started on the right, thus expanding the grid
8074 * horizontally, making for horizontal scrolling. When in "vertical
8075 * mode" , though, items will be placed in @b rows, from left to
8076 * right and, when the space for a row is filled, another one is
8077 * started below, thus expanding the grid vertically (and making
8078 * for vertical scrolling).
8080 * @section Gengrid_Items Gengrid items
8082 * An item in a gengrid can have 0 or more text labels (they can be
8083 * regular text or textblock Evas objects - that's up to the style
8084 * to determine), 0 or more icons (which are simply objects
8085 * swallowed into the gengrid item's theming Edje object) and 0 or
8086 * more <b>boolean states</b>, which have the behavior left to the
8087 * user to define. The Edje part names for each of these properties
8088 * will be looked up, in the theme file for the gengrid, under the
8089 * Edje (string) data items named @c "labels", @c "icons" and @c
8090 * "states", respectively. For each of those properties, if more
8091 * than one part is provided, they must have names listed separated
8092 * by spaces in the data fields. For the default gengrid item
8093 * theme, we have @b one label part (@c "elm.text"), @b two icon
8094 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8097 * A gengrid item may be at one of several styles. Elementary
8098 * provides one by default - "default", but this can be extended by
8099 * system or application custom themes/overlays/extensions (see
8100 * @ref Theme "themes" for more details).
8102 * @section Gengrid_Item_Class Gengrid item classes
8104 * In order to have the ability to add and delete items on the fly,
8105 * gengrid implements a class (callback) system where the
8106 * application provides a structure with information about that
8107 * type of item (gengrid may contain multiple different items with
8108 * different classes, states and styles). Gengrid will call the
8109 * functions in this struct (methods) when an item is "realized"
8110 * (i.e., created dynamically, while the user is scrolling the
8111 * grid). All objects will simply be deleted when no longer needed
8112 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8113 * contains the following members:
8114 * - @c item_style - This is a constant string and simply defines
8115 * the name of the item style. It @b must be specified and the
8116 * default should be @c "default".
8117 * - @c func.label_get - This function is called when an item
8118 * object is actually created. The @c data parameter will point to
8119 * the same data passed to elm_gengrid_item_append() and related
8120 * item creation functions. The @c obj parameter is the gengrid
8121 * object itself, while the @c part one is the name string of one
8122 * of the existing text parts in the Edje group implementing the
8123 * item's theme. This function @b must return a strdup'()ed string,
8124 * as the caller will free() it when done. See
8125 * #Elm_Gengrid_Item_Label_Get_Cb.
8126 * - @c func.content_get - This function is called when an item object
8127 * is actually created. The @c data parameter will point to the
8128 * same data passed to elm_gengrid_item_append() and related item
8129 * creation functions. The @c obj parameter is the gengrid object
8130 * itself, while the @c part one is the name string of one of the
8131 * existing (content) swallow parts in the Edje group implementing the
8132 * item's theme. It must return @c NULL, when no content is desired,
8133 * or a valid object handle, otherwise. The object will be deleted
8134 * by the gengrid on its deletion or when the item is "unrealized".
8135 * See #Elm_Gengrid_Item_Content_Get_Cb.
8136 * - @c func.state_get - This function is called when an item
8137 * object is actually created. The @c data parameter will point to
8138 * the same data passed to elm_gengrid_item_append() and related
8139 * item creation functions. The @c obj parameter is the gengrid
8140 * object itself, while the @c part one is the name string of one
8141 * of the state parts in the Edje group implementing the item's
8142 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8143 * true/on. Gengrids will emit a signal to its theming Edje object
8144 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8145 * "source" arguments, respectively, when the state is true (the
8146 * default is false), where @c XXX is the name of the (state) part.
8147 * See #Elm_Gengrid_Item_State_Get_Cb.
8148 * - @c func.del - This is called when elm_gengrid_item_del() is
8149 * called on an item or elm_gengrid_clear() is called on the
8150 * gengrid. This is intended for use when gengrid items are
8151 * deleted, so any data attached to the item (e.g. its data
8152 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8154 * @section Gengrid_Usage_Hints Usage hints
8156 * If the user wants to have multiple items selected at the same
8157 * time, elm_gengrid_multi_select_set() will permit it. If the
8158 * gengrid is single-selection only (the default), then
8159 * elm_gengrid_select_item_get() will return the selected item or
8160 * @c NULL, if none is selected. If the gengrid is under
8161 * multi-selection, then elm_gengrid_selected_items_get() will
8162 * return a list (that is only valid as long as no items are
8163 * modified (added, deleted, selected or unselected) of child items
8166 * If an item changes (internal (boolean) state, label or content
8167 * changes), then use elm_gengrid_item_update() to have gengrid
8168 * update the item with the new state. A gengrid will re-"realize"
8169 * the item, thus calling the functions in the
8170 * #Elm_Gengrid_Item_Class set for that item.
8172 * To programmatically (un)select an item, use
8173 * elm_gengrid_item_selected_set(). To get its selected state use
8174 * elm_gengrid_item_selected_get(). To make an item disabled
8175 * (unable to be selected and appear differently) use
8176 * elm_gengrid_item_disabled_set() to set this and
8177 * elm_gengrid_item_disabled_get() to get the disabled state.
8179 * Grid cells will only have their selection smart callbacks called
8180 * when firstly getting selected. Any further clicks will do
8181 * nothing, unless you enable the "always select mode", with
8182 * elm_gengrid_always_select_mode_set(), thus making every click to
8183 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8184 * turn off the ability to select items entirely in the widget and
8185 * they will neither appear selected nor call the selection smart
8188 * Remember that you can create new styles and add your own theme
8189 * augmentation per application with elm_theme_extension_add(). If
8190 * you absolutely must have a specific style that overrides any
8191 * theme the user or system sets up you can use
8192 * elm_theme_overlay_add() to add such a file.
8194 * @section Gengrid_Smart_Events Gengrid smart events
8196 * Smart events that you can add callbacks for are:
8197 * - @c "activated" - The user has double-clicked or pressed
8198 * (enter|return|spacebar) on an item. The @c event_info parameter
8199 * is the gengrid item that was activated.
8200 * - @c "clicked,double" - The user has double-clicked an item.
8201 * The @c event_info parameter is the gengrid item that was double-clicked.
8202 * - @c "longpressed" - This is called when the item is pressed for a certain
8203 * amount of time. By default it's 1 second.
8204 * - @c "selected" - The user has made an item selected. The
8205 * @c event_info parameter is the gengrid item that was selected.
8206 * - @c "unselected" - The user has made an item unselected. The
8207 * @c event_info parameter is the gengrid item that was unselected.
8208 * - @c "realized" - This is called when the item in the gengrid
8209 * has its implementing Evas object instantiated, de facto. @c
8210 * event_info is the gengrid item that was created. The object
8211 * may be deleted at any time, so it is highly advised to the
8212 * caller @b not to use the object pointer returned from
8213 * elm_gengrid_item_object_get(), because it may point to freed
8215 * - @c "unrealized" - This is called when the implementing Evas
8216 * object for this item is deleted. @c event_info is the gengrid
8217 * item that was deleted.
8218 * - @c "changed" - Called when an item is added, removed, resized
8219 * or moved and when the gengrid is resized or gets "horizontal"
8221 * - @c "scroll,anim,start" - This is called when scrolling animation has
8223 * - @c "scroll,anim,stop" - This is called when scrolling animation has
8225 * - @c "drag,start,up" - Called when the item in the gengrid has
8226 * been dragged (not scrolled) up.
8227 * - @c "drag,start,down" - Called when the item in the gengrid has
8228 * been dragged (not scrolled) down.
8229 * - @c "drag,start,left" - Called when the item in the gengrid has
8230 * been dragged (not scrolled) left.
8231 * - @c "drag,start,right" - Called when the item in the gengrid has
8232 * been dragged (not scrolled) right.
8233 * - @c "drag,stop" - Called when the item in the gengrid has
8234 * stopped being dragged.
8235 * - @c "drag" - Called when the item in the gengrid is being
8237 * - @c "scroll" - called when the content has been scrolled
8239 * - @c "scroll,drag,start" - called when dragging the content has
8241 * - @c "scroll,drag,stop" - called when dragging the content has
8243 * - @c "edge,top" - This is called when the gengrid is scrolled until
8245 * - @c "edge,bottom" - This is called when the gengrid is scrolled
8246 * until the bottom edge.
8247 * - @c "edge,left" - This is called when the gengrid is scrolled
8248 * until the left edge.
8249 * - @c "edge,right" - This is called when the gengrid is scrolled
8250 * until the right edge.
8252 * List of gengrid examples:
8253 * @li @ref gengrid_example
8257 * @addtogroup Gengrid
8261 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8262 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8263 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8264 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
8265 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. */
8266 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. */
8267 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
8269 /* temporary compatibility code */
8270 typedef Elm_Gengrid_Item_Label_Get_Cb GridItemLabelGetFunc EINA_DEPRECATED;
8271 typedef Elm_Gengrid_Item_Content_Get_Cb GridItemIconGetFunc EINA_DEPRECATED;
8272 typedef Elm_Gengrid_Item_State_Get_Cb GridItemStateGetFunc EINA_DEPRECATED;
8273 typedef Elm_Gengrid_Item_Del_Cb GridItemDelFunc EINA_DEPRECATED;
8276 * @struct _Elm_Gengrid_Item_Class
8278 * Gengrid item class definition. See @ref Gengrid_Item_Class for
8281 struct _Elm_Gengrid_Item_Class
8283 const char *item_style;
8284 struct _Elm_Gengrid_Item_Class_Func
8286 Elm_Gengrid_Item_Label_Get_Cb label_get;
8287 union { /* temporary compatibility code */
8288 Elm_Gengrid_Item_Content_Get_Cb icon_get EINA_DEPRECATED;
8289 Elm_Gengrid_Item_Content_Get_Cb content_get;
8291 Elm_Gengrid_Item_State_Get_Cb state_get;
8292 Elm_Gengrid_Item_Del_Cb del;
8294 }; /**< #Elm_Gengrid_Item_Class member definitions */
8296 * Add a new gengrid widget to the given parent Elementary
8297 * (container) object
8299 * @param parent The parent object
8300 * @return a new gengrid widget handle or @c NULL, on errors
8302 * This function inserts a new gengrid widget on the canvas.
8304 * @see elm_gengrid_item_size_set()
8305 * @see elm_gengrid_group_item_size_set()
8306 * @see elm_gengrid_horizontal_set()
8307 * @see elm_gengrid_item_append()
8308 * @see elm_gengrid_item_del()
8309 * @see elm_gengrid_clear()
8313 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8316 * Set the size for the items of a given gengrid widget
8318 * @param obj The gengrid object.
8319 * @param w The items' width.
8320 * @param h The items' height;
8322 * A gengrid, after creation, has still no information on the size
8323 * to give to each of its cells. So, you most probably will end up
8324 * with squares one @ref Fingers "finger" wide, the default
8325 * size. Use this function to force a custom size for you items,
8326 * making them as big as you wish.
8328 * @see elm_gengrid_item_size_get()
8332 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8335 * Get the size set for the items of a given gengrid widget
8337 * @param obj The gengrid object.
8338 * @param w Pointer to a variable where to store the items' width.
8339 * @param h Pointer to a variable where to store the items' height.
8341 * @note Use @c NULL pointers on the size values you're not
8342 * interested in: they'll be ignored by the function.
8344 * @see elm_gengrid_item_size_get() for more details
8348 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8351 * Set the items grid's alignment within a given gengrid widget
8353 * @param obj The gengrid object.
8354 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8355 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8357 * This sets the alignment of the whole grid of items of a gengrid
8358 * within its given viewport. By default, those values are both
8359 * 0.5, meaning that the gengrid will have its items grid placed
8360 * exactly in the middle of its viewport.
8362 * @note If given alignment values are out of the cited ranges,
8363 * they'll be changed to the nearest boundary values on the valid
8366 * @see elm_gengrid_align_get()
8370 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8373 * Get the items grid's alignment values within a given gengrid
8376 * @param obj The gengrid object.
8377 * @param align_x Pointer to a variable where to store the
8378 * horizontal alignment.
8379 * @param align_y Pointer to a variable where to store the vertical
8382 * @note Use @c NULL pointers on the alignment values you're not
8383 * interested in: they'll be ignored by the function.
8385 * @see elm_gengrid_align_set() for more details
8389 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8392 * Set whether a given gengrid widget is or not able have items
8395 * @param obj The gengrid object
8396 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8397 * @c EINA_FALSE to turn it off
8399 * If a gengrid is set to allow reordering, a click held for more
8400 * than 0.5 over a given item will highlight it specially,
8401 * signalling the gengrid has entered the reordering state. From
8402 * that time on, the user will be able to, while still holding the
8403 * mouse button down, move the item freely in the gengrid's
8404 * viewport, replacing to said item to the locations it goes to.
8405 * The replacements will be animated and, whenever the user
8406 * releases the mouse button, the item being replaced gets a new
8407 * definitive place in the grid.
8409 * @see elm_gengrid_reorder_mode_get()
8413 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8416 * Get whether a given gengrid widget is or not able have items
8419 * @param obj The gengrid object
8420 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8423 * @see elm_gengrid_reorder_mode_set() for more details
8427 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8430 * Append a new item in a given gengrid widget.
8432 * @param obj The gengrid object.
8433 * @param gic The item class for the item.
8434 * @param data The item data.
8435 * @param func Convenience function called when the item is
8437 * @param func_data Data to be passed to @p func.
8438 * @return A handle to the item added or @c NULL, on errors.
8440 * This adds an item to the beginning of the gengrid.
8442 * @see elm_gengrid_item_prepend()
8443 * @see elm_gengrid_item_insert_before()
8444 * @see elm_gengrid_item_insert_after()
8445 * @see elm_gengrid_item_del()
8449 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);
8452 * Prepend a new item in a given gengrid widget.
8454 * @param obj The gengrid object.
8455 * @param gic The item class for the item.
8456 * @param data The item data.
8457 * @param func Convenience function called when the item is
8459 * @param func_data Data to be passed to @p func.
8460 * @return A handle to the item added or @c NULL, on errors.
8462 * This adds an item to the end of the gengrid.
8464 * @see elm_gengrid_item_append()
8465 * @see elm_gengrid_item_insert_before()
8466 * @see elm_gengrid_item_insert_after()
8467 * @see elm_gengrid_item_del()
8471 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);
8474 * Insert an item before another in a gengrid widget
8476 * @param obj The gengrid object.
8477 * @param gic The item class for the item.
8478 * @param data The item data.
8479 * @param relative The item to place this new one before.
8480 * @param func Convenience function called when the item is
8482 * @param func_data Data to be passed to @p func.
8483 * @return A handle to the item added or @c NULL, on errors.
8485 * This inserts an item before another in the gengrid.
8487 * @see elm_gengrid_item_append()
8488 * @see elm_gengrid_item_prepend()
8489 * @see elm_gengrid_item_insert_after()
8490 * @see elm_gengrid_item_del()
8494 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);
8497 * Insert an item after another in a gengrid widget
8499 * @param obj The gengrid object.
8500 * @param gic The item class for the item.
8501 * @param data The item data.
8502 * @param relative The item to place this new one after.
8503 * @param func Convenience function called when the item is
8505 * @param func_data Data to be passed to @p func.
8506 * @return A handle to the item added or @c NULL, on errors.
8508 * This inserts an item after another in the gengrid.
8510 * @see elm_gengrid_item_append()
8511 * @see elm_gengrid_item_prepend()
8512 * @see elm_gengrid_item_insert_after()
8513 * @see elm_gengrid_item_del()
8517 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);
8520 * Insert an item in a gengrid widget using a user-defined sort function.
8522 * @param obj The gengrid object.
8523 * @param gic The item class for the item.
8524 * @param data The item data.
8525 * @param comp User defined comparison function that defines the sort order based on
8526 * Elm_Gen_Item and its data param.
8527 * @param func Convenience function called when the item is selected.
8528 * @param func_data Data to be passed to @p func.
8529 * @return A handle to the item added or @c NULL, on errors.
8531 * This inserts an item in the gengrid based on user defined comparison function.
8533 * @see elm_gengrid_item_append()
8534 * @see elm_gengrid_item_prepend()
8535 * @see elm_gengrid_item_insert_after()
8536 * @see elm_gengrid_item_del()
8537 * @see elm_gengrid_item_direct_sorted_insert()
8541 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);
8544 * Insert an item in a gengrid widget using a user-defined sort function.
8546 * @param obj The gengrid object.
8547 * @param gic The item class for the item.
8548 * @param data The item data.
8549 * @param comp User defined comparison function that defines the sort order based on
8551 * @param func Convenience function called when the item is selected.
8552 * @param func_data Data to be passed to @p func.
8553 * @return A handle to the item added or @c NULL, on errors.
8555 * This inserts an item in the gengrid based on user defined comparison function.
8557 * @see elm_gengrid_item_append()
8558 * @see elm_gengrid_item_prepend()
8559 * @see elm_gengrid_item_insert_after()
8560 * @see elm_gengrid_item_del()
8561 * @see elm_gengrid_item_sorted_insert()
8565 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);
8568 * Set whether items on a given gengrid widget are to get their
8569 * selection callbacks issued for @b every subsequent selection
8570 * click on them or just for the first click.
8572 * @param obj The gengrid object
8573 * @param always_select @c EINA_TRUE to make items "always
8574 * selected", @c EINA_FALSE, otherwise
8576 * By default, grid items will only call their selection callback
8577 * function when firstly getting selected, any subsequent further
8578 * clicks will do nothing. With this call, you make those
8579 * subsequent clicks also to issue the selection callbacks.
8581 * @note <b>Double clicks</b> will @b always be reported on items.
8583 * @see elm_gengrid_always_select_mode_get()
8587 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8590 * Get whether items on a given gengrid widget have their selection
8591 * callbacks issued for @b every subsequent selection click on them
8592 * or just for the first click.
8594 * @param obj The gengrid object.
8595 * @return @c EINA_TRUE if the gengrid items are "always selected",
8596 * @c EINA_FALSE, otherwise
8598 * @see elm_gengrid_always_select_mode_set() for more details
8602 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8605 * Set whether items on a given gengrid widget can be selected or not.
8607 * @param obj The gengrid object
8608 * @param no_select @c EINA_TRUE to make items selectable,
8609 * @c EINA_FALSE otherwise
8611 * This will make items in @p obj selectable or not. In the latter
8612 * case, any user interaction on the gengrid items will neither make
8613 * them appear selected nor them call their selection callback
8616 * @see elm_gengrid_no_select_mode_get()
8620 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8623 * Get whether items on a given gengrid widget can be selected or
8626 * @param obj The gengrid object
8627 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8630 * @see elm_gengrid_no_select_mode_set() for more details
8634 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8637 * Enable or disable multi-selection in a given gengrid widget
8639 * @param obj The gengrid object.
8640 * @param multi @c EINA_TRUE, to enable multi-selection,
8641 * @c EINA_FALSE to disable it.
8643 * Multi-selection is the ability to have @b more than one
8644 * item selected, on a given gengrid, simultaneously. When it is
8645 * enabled, a sequence of clicks on different items will make them
8646 * all selected, progressively. A click on an already selected item
8647 * will unselect it. If interacting via the keyboard,
8648 * multi-selection is enabled while holding the "Shift" key.
8650 * @note By default, multi-selection is @b disabled on gengrids
8652 * @see elm_gengrid_multi_select_get()
8656 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8659 * Get whether multi-selection is enabled or disabled for a given
8662 * @param obj The gengrid object.
8663 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8664 * EINA_FALSE otherwise
8666 * @see elm_gengrid_multi_select_set() for more details
8670 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8673 * Enable or disable bouncing effect for a given gengrid widget
8675 * @param obj The gengrid object
8676 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8677 * @c EINA_FALSE to disable it
8678 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8679 * @c EINA_FALSE to disable it
8681 * The bouncing effect occurs whenever one reaches the gengrid's
8682 * edge's while panning it -- it will scroll past its limits a
8683 * little bit and return to the edge again, in a animated for,
8686 * @note By default, gengrids have bouncing enabled on both axis
8688 * @see elm_gengrid_bounce_get()
8692 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8695 * Get whether bouncing effects are enabled or disabled, for a
8696 * given gengrid widget, on each axis
8698 * @param obj The gengrid object
8699 * @param h_bounce Pointer to a variable where to store the
8700 * horizontal bouncing flag.
8701 * @param v_bounce Pointer to a variable where to store the
8702 * vertical bouncing flag.
8704 * @see elm_gengrid_bounce_set() for more details
8708 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8711 * Set a given gengrid widget's scrolling page size, relative to
8712 * its viewport size.
8714 * @param obj The gengrid object
8715 * @param h_pagerel The horizontal page (relative) size
8716 * @param v_pagerel The vertical page (relative) size
8718 * The gengrid's scroller is capable of binding scrolling by the
8719 * user to "pages". It means that, while scrolling and, specially
8720 * after releasing the mouse button, the grid will @b snap to the
8721 * nearest displaying page's area. When page sizes are set, the
8722 * grid's continuous content area is split into (equal) page sized
8725 * This function sets the size of a page <b>relatively to the
8726 * viewport dimensions</b> of the gengrid, for each axis. A value
8727 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8728 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8729 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8730 * 1.0. Values beyond those will make it behave behave
8731 * inconsistently. If you only want one axis to snap to pages, use
8732 * the value @c 0.0 for the other one.
8734 * There is a function setting page size values in @b absolute
8735 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8736 * is mutually exclusive to this one.
8738 * @see elm_gengrid_page_relative_get()
8742 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8745 * Get a given gengrid widget's scrolling page size, relative to
8746 * its viewport size.
8748 * @param obj The gengrid object
8749 * @param h_pagerel Pointer to a variable where to store the
8750 * horizontal page (relative) size
8751 * @param v_pagerel Pointer to a variable where to store the
8752 * vertical page (relative) size
8754 * @see elm_gengrid_page_relative_set() for more details
8758 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8761 * Set a given gengrid widget's scrolling page size
8763 * @param obj The gengrid object
8764 * @param h_pagerel The horizontal page size, in pixels
8765 * @param v_pagerel The vertical page size, in pixels
8767 * The gengrid's scroller is capable of binding scrolling by the
8768 * user to "pages". It means that, while scrolling and, specially
8769 * after releasing the mouse button, the grid will @b snap to the
8770 * nearest displaying page's area. When page sizes are set, the
8771 * grid's continuous content area is split into (equal) page sized
8774 * This function sets the size of a page of the gengrid, in pixels,
8775 * for each axis. Sane usable values are, between @c 0 and the
8776 * dimensions of @p obj, for each axis. Values beyond those will
8777 * make it behave behave inconsistently. If you only want one axis
8778 * to snap to pages, use the value @c 0 for the other one.
8780 * There is a function setting page size values in @b relative
8781 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8782 * use is mutually exclusive to this one.
8786 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8789 * Set the direction in which a given gengrid widget will expand while
8790 * placing its items.
8792 * @param obj The gengrid object.
8793 * @param setting @c EINA_TRUE to make the gengrid expand
8794 * horizontally, @c EINA_FALSE to expand vertically.
8796 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8797 * in @b columns, from top to bottom and, when the space for a
8798 * column is filled, another one is started on the right, thus
8799 * expanding the grid horizontally. When in "vertical mode"
8800 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8801 * to right and, when the space for a row is filled, another one is
8802 * started below, thus expanding the grid vertically.
8804 * @see elm_gengrid_horizontal_get()
8808 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8811 * Get for what direction a given gengrid widget will expand while
8812 * placing its items.
8814 * @param obj The gengrid object.
8815 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8816 * @c EINA_FALSE if it's set to expand vertically.
8818 * @see elm_gengrid_horizontal_set() for more detais
8822 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8825 * Get the first item in a given gengrid widget
8827 * @param obj The gengrid object
8828 * @return The first item's handle or @c NULL, if there are no
8829 * items in @p obj (and on errors)
8831 * This returns the first item in the @p obj's internal list of
8834 * @see elm_gengrid_last_item_get()
8838 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8841 * Get the last item in a given gengrid widget
8843 * @param obj The gengrid object
8844 * @return The last item's handle or @c NULL, if there are no
8845 * items in @p obj (and on errors)
8847 * This returns the last item in the @p obj's internal list of
8850 * @see elm_gengrid_first_item_get()
8854 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8857 * Get the @b next item in a gengrid widget's internal list of items,
8858 * given a handle to one of those items.
8860 * @param item The gengrid item to fetch next from
8861 * @return The item after @p item, or @c NULL if there's none (and
8864 * This returns the item placed after the @p item, on the container
8867 * @see elm_gengrid_item_prev_get()
8871 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8874 * Get the @b previous item in a gengrid widget's internal list of items,
8875 * given a handle to one of those items.
8877 * @param item The gengrid item to fetch previous from
8878 * @return The item before @p item, or @c NULL if there's none (and
8881 * This returns the item placed before the @p item, on the container
8884 * @see elm_gengrid_item_next_get()
8888 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8891 * Get the gengrid object's handle which contains a given gengrid
8894 * @param item The item to fetch the container from
8895 * @return The gengrid (parent) object
8897 * This returns the gengrid object itself that an item belongs to.
8901 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8904 * Remove a gengrid item from its parent, deleting it.
8906 * @param item The item to be removed.
8907 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8909 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8914 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8917 * Update the contents of a given gengrid item
8919 * @param item The gengrid item
8921 * This updates an item by calling all the item class functions
8922 * again to get the contents, labels and states. Use this when the
8923 * original item data has changed and you want the changes to be
8928 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8931 * Get the Gengrid Item class for the given Gengrid Item.
8933 * @param item The gengrid item
8935 * This returns the Gengrid_Item_Class for the given item. It can be used to examine
8936 * the function pointers and item_style.
8940 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8943 * Get the Gengrid Item class for the given Gengrid Item.
8945 * This sets the Gengrid_Item_Class for the given item. It can be used to examine
8946 * the function pointers and item_style.
8948 * @param item The gengrid item
8949 * @param gic The gengrid item class describing the function pointers and the item style.
8953 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8956 * Return the data associated to a given gengrid item
8958 * @param item The gengrid item.
8959 * @return the data associated with this item.
8961 * This returns the @c data value passed on the
8962 * elm_gengrid_item_append() and related item addition calls.
8964 * @see elm_gengrid_item_append()
8965 * @see elm_gengrid_item_data_set()
8969 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8972 * Set the data associated with a given gengrid item
8974 * @param item The gengrid item
8975 * @param data The data pointer to set on it
8977 * This @b overrides the @c data value passed on the
8978 * elm_gengrid_item_append() and related item addition calls. This
8979 * function @b won't call elm_gengrid_item_update() automatically,
8980 * so you'd issue it afterwards if you want to have the item
8981 * updated to reflect the new data.
8983 * @see elm_gengrid_item_data_get()
8984 * @see elm_gengrid_item_update()
8988 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8991 * Get a given gengrid item's position, relative to the whole
8992 * gengrid's grid area.
8994 * @param item The Gengrid item.
8995 * @param x Pointer to variable to store the item's <b>row number</b>.
8996 * @param y Pointer to variable to store the item's <b>column number</b>.
8998 * This returns the "logical" position of the item within the
8999 * gengrid. For example, @c (0, 1) would stand for first row,
9004 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9007 * Set whether a given gengrid item is selected or not
9009 * @param item The gengrid item
9010 * @param selected Use @c EINA_TRUE, to make it selected, @c
9011 * EINA_FALSE to make it unselected
9013 * This sets the selected state of an item. If multi-selection is
9014 * not enabled on the containing gengrid and @p selected is @c
9015 * EINA_TRUE, any other previously selected items will get
9016 * unselected in favor of this new one.
9018 * @see elm_gengrid_item_selected_get()
9022 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9025 * Get whether a given gengrid item is selected or not
9027 * @param item The gengrid item
9028 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9030 * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9032 * @see elm_gengrid_item_selected_set() for more details
9036 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9039 * Get the real Evas object created to implement the view of a
9040 * given gengrid item
9042 * @param item The gengrid item.
9043 * @return the Evas object implementing this item's view.
9045 * This returns the actual Evas object used to implement the
9046 * specified gengrid item's view. This may be @c NULL, as it may
9047 * not have been created or may have been deleted, at any time, by
9048 * the gengrid. <b>Do not modify this object</b> (move, resize,
9049 * show, hide, etc.), as the gengrid is controlling it. This
9050 * function is for querying, emitting custom signals or hooking
9051 * lower level callbacks for events on that object. Do not delete
9052 * this object under any circumstances.
9054 * @see elm_gengrid_item_data_get()
9058 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9061 * Show the portion of a gengrid's internal grid containing a given
9062 * item, @b immediately.
9064 * @param item The item to display
9066 * This causes gengrid to @b redraw its viewport's contents to the
9067 * region contining the given @p item item, if it is not fully
9070 * @see elm_gengrid_item_bring_in()
9074 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9077 * Animatedly bring in, to the visible area of a gengrid, a given
9080 * @param item The gengrid item to display
9082 * This causes gengrid to jump to the given @p item and show
9083 * it (by scrolling), if it is not fully visible. This will use
9084 * animation to do so and take a period of time to complete.
9086 * @see elm_gengrid_item_show()
9090 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9093 * Set whether a given gengrid item is disabled or not.
9095 * @param item The gengrid item
9096 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9097 * to enable it back.
9099 * A disabled item cannot be selected or unselected. It will also
9100 * change its appearance, to signal the user it's disabled.
9102 * @see elm_gengrid_item_disabled_get()
9106 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9109 * Get whether a given gengrid item is disabled or not.
9111 * @param item The gengrid item
9112 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9115 * @see elm_gengrid_item_disabled_set() for more details
9119 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9122 * Set the text to be shown in a given gengrid item's tooltips.
9124 * @param item The gengrid item
9125 * @param text The text to set in the content
9127 * This call will setup the text to be used as tooltip to that item
9128 * (analogous to elm_object_tooltip_text_set(), but being item
9129 * tooltips with higher precedence than object tooltips). It can
9130 * have only one tooltip at a time, so any previous tooltip data
9135 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9138 * Set the content to be shown in a given gengrid item's tooltip
9140 * @param item The gengrid item.
9141 * @param func The function returning the tooltip contents.
9142 * @param data What to provide to @a func as callback data/context.
9143 * @param del_cb Called when data is not needed anymore, either when
9144 * another callback replaces @p func, the tooltip is unset with
9145 * elm_gengrid_item_tooltip_unset() or the owner @p item
9146 * dies. This callback receives as its first parameter the
9147 * given @p data, being @c event_info the item handle.
9149 * This call will setup the tooltip's contents to @p item
9150 * (analogous to elm_object_tooltip_content_cb_set(), but being
9151 * item tooltips with higher precedence than object tooltips). It
9152 * can have only one tooltip at a time, so any previous tooltip
9153 * content will get removed. @p func (with @p data) will be called
9154 * every time Elementary needs to show the tooltip and it should
9155 * return a valid Evas object, which will be fully managed by the
9156 * tooltip system, getting deleted when the tooltip is gone.
9160 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);
9163 * Unset a tooltip from a given gengrid item
9165 * @param item gengrid item to remove a previously set tooltip from.
9167 * This call removes any tooltip set on @p item. The callback
9168 * provided as @c del_cb to
9169 * elm_gengrid_item_tooltip_content_cb_set() will be called to
9170 * notify it is not used anymore (and have resources cleaned, if
9173 * @see elm_gengrid_item_tooltip_content_cb_set()
9177 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9180 * Set a different @b style for a given gengrid item's tooltip.
9182 * @param item gengrid item with tooltip set
9183 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9184 * "default", @c "transparent", etc)
9186 * Tooltips can have <b>alternate styles</b> to be displayed on,
9187 * which are defined by the theme set on Elementary. This function
9188 * works analogously as elm_object_tooltip_style_set(), but here
9189 * applied only to gengrid item objects. The default style for
9190 * tooltips is @c "default".
9192 * @note before you set a style you should define a tooltip with
9193 * elm_gengrid_item_tooltip_content_cb_set() or
9194 * elm_gengrid_item_tooltip_text_set()
9196 * @see elm_gengrid_item_tooltip_style_get()
9200 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9203 * Get the style set a given gengrid item's tooltip.
9205 * @param item gengrid item with tooltip already set on.
9206 * @return style the theme style in use, which defaults to
9207 * "default". If the object does not have a tooltip set,
9208 * then @c NULL is returned.
9210 * @see elm_gengrid_item_tooltip_style_set() for more details
9214 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9216 * Set the type of mouse pointer/cursor decoration to be shown,
9217 * when the mouse pointer is over the given gengrid widget item
9219 * @param item gengrid item to customize cursor on
9220 * @param cursor the cursor type's name
9222 * This function works analogously as elm_object_cursor_set(), but
9223 * here the cursor's changing area is restricted to the item's
9224 * area, and not the whole widget's. Note that that item cursors
9225 * have precedence over widget cursors, so that a mouse over @p
9226 * item will always show cursor @p type.
9228 * If this function is called twice for an object, a previously set
9229 * cursor will be unset on the second call.
9231 * @see elm_object_cursor_set()
9232 * @see elm_gengrid_item_cursor_get()
9233 * @see elm_gengrid_item_cursor_unset()
9237 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9240 * Get the type of mouse pointer/cursor decoration set to be shown,
9241 * when the mouse pointer is over the given gengrid widget item
9243 * @param item gengrid item with custom cursor set
9244 * @return the cursor type's name or @c NULL, if no custom cursors
9245 * were set to @p item (and on errors)
9247 * @see elm_object_cursor_get()
9248 * @see elm_gengrid_item_cursor_set() for more details
9249 * @see elm_gengrid_item_cursor_unset()
9253 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9256 * Unset any custom mouse pointer/cursor decoration set to be
9257 * shown, when the mouse pointer is over the given gengrid widget
9258 * item, thus making it show the @b default cursor again.
9260 * @param item a gengrid item
9262 * Use this call to undo any custom settings on this item's cursor
9263 * decoration, bringing it back to defaults (no custom style set).
9265 * @see elm_object_cursor_unset()
9266 * @see elm_gengrid_item_cursor_set() for more details
9270 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9273 * Set a different @b style for a given custom cursor set for a
9276 * @param item gengrid item with custom cursor set
9277 * @param style the <b>theme style</b> to use (e.g. @c "default",
9278 * @c "transparent", etc)
9280 * This function only makes sense when one is using custom mouse
9281 * cursor decorations <b>defined in a theme file</b> , which can
9282 * have, given a cursor name/type, <b>alternate styles</b> on
9283 * it. It works analogously as elm_object_cursor_style_set(), but
9284 * here applied only to gengrid item objects.
9286 * @warning Before you set a cursor style you should have defined a
9287 * custom cursor previously on the item, with
9288 * elm_gengrid_item_cursor_set()
9290 * @see elm_gengrid_item_cursor_engine_only_set()
9291 * @see elm_gengrid_item_cursor_style_get()
9295 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9298 * Get the current @b style set for a given gengrid item's custom
9301 * @param item gengrid item with custom cursor set.
9302 * @return style the cursor style in use. If the object does not
9303 * have a cursor set, then @c NULL is returned.
9305 * @see elm_gengrid_item_cursor_style_set() for more details
9309 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9312 * Set if the (custom) cursor for a given gengrid item should be
9313 * searched in its theme, also, or should only rely on the
9316 * @param item item with custom (custom) cursor already set on
9317 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9318 * only on those provided by the rendering engine, @c EINA_FALSE to
9319 * have them searched on the widget's theme, as well.
9321 * @note This call is of use only if you've set a custom cursor
9322 * for gengrid items, with elm_gengrid_item_cursor_set().
9324 * @note By default, cursors will only be looked for between those
9325 * provided by the rendering engine.
9329 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9332 * Get if the (custom) cursor for a given gengrid item is being
9333 * searched in its theme, also, or is only relying on the rendering
9336 * @param item a gengrid item
9337 * @return @c EINA_TRUE, if cursors are being looked for only on
9338 * those provided by the rendering engine, @c EINA_FALSE if they
9339 * are being searched on the widget's theme, as well.
9341 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9345 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9348 * Remove all items from a given gengrid widget
9350 * @param obj The gengrid object.
9352 * This removes (and deletes) all items in @p obj, leaving it
9355 * @see elm_gengrid_item_del(), to remove just one item.
9359 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9362 * Get the selected item in a given gengrid widget
9364 * @param obj The gengrid object.
9365 * @return The selected item's handleor @c NULL, if none is
9366 * selected at the moment (and on errors)
9368 * This returns the selected item in @p obj. If multi selection is
9369 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9370 * the first item in the list is selected, which might not be very
9371 * useful. For that case, see elm_gengrid_selected_items_get().
9375 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9378 * Get <b>a list</b> of selected items in a given gengrid
9380 * @param obj The gengrid object.
9381 * @return The list of selected items or @c NULL, if none is
9382 * selected at the moment (and on errors)
9384 * This returns a list of the selected items, in the order that
9385 * they appear in the grid. This list is only valid as long as no
9386 * more items are selected or unselected (or unselected implictly
9387 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9390 * @see elm_gengrid_selected_item_get()
9394 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9401 * @defgroup Clock Clock
9403 * @image html img/widget/clock/preview-00.png
9404 * @image latex img/widget/clock/preview-00.eps
9406 * This is a @b digital clock widget. In its default theme, it has a
9407 * vintage "flipping numbers clock" appearance, which will animate
9408 * sheets of individual algarisms individually as time goes by.
9410 * A newly created clock will fetch system's time (already
9411 * considering local time adjustments) to start with, and will tick
9412 * accondingly. It may or may not show seconds.
9414 * Clocks have an @b edition mode. When in it, the sheets will
9415 * display extra arrow indications on the top and bottom and the
9416 * user may click on them to raise or lower the time values. After
9417 * it's told to exit edition mode, it will keep ticking with that
9418 * new time set (it keeps the difference from local time).
9420 * Also, when under edition mode, user clicks on the cited arrows
9421 * which are @b held for some time will make the clock to flip the
9422 * sheet, thus editing the time, continuosly and automatically for
9423 * the user. The interval between sheet flips will keep growing in
9424 * time, so that it helps the user to reach a time which is distant
9427 * The time display is, by default, in military mode (24h), but an
9428 * am/pm indicator may be optionally shown, too, when it will
9431 * Smart callbacks one can register to:
9432 * - "changed" - the clock's user changed the time
9434 * Here is an example on its usage:
9435 * @li @ref clock_example
9444 * Identifiers for which clock digits should be editable, when a
9445 * clock widget is in edition mode. Values may be ORed together to
9446 * make a mask, naturally.
9448 * @see elm_clock_edit_set()
9449 * @see elm_clock_digit_edit_set()
9451 typedef enum _Elm_Clock_Digedit
9453 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9454 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9455 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9456 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9457 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9458 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9459 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9460 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9461 } Elm_Clock_Digedit;
9464 * Add a new clock widget to the given parent Elementary
9465 * (container) object
9467 * @param parent The parent object
9468 * @return a new clock widget handle or @c NULL, on errors
9470 * This function inserts a new clock widget on the canvas.
9474 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9477 * Set a clock widget's time, programmatically
9479 * @param obj The clock widget object
9480 * @param hrs The hours to set
9481 * @param min The minutes to set
9482 * @param sec The secondes to set
9484 * This function updates the time that is showed by the clock
9487 * Values @b must be set within the following ranges:
9488 * - 0 - 23, for hours
9489 * - 0 - 59, for minutes
9490 * - 0 - 59, for seconds,
9492 * even if the clock is not in "military" mode.
9494 * @warning The behavior for values set out of those ranges is @b
9499 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9502 * Get a clock widget's time values
9504 * @param obj The clock object
9505 * @param[out] hrs Pointer to the variable to get the hours value
9506 * @param[out] min Pointer to the variable to get the minutes value
9507 * @param[out] sec Pointer to the variable to get the seconds value
9509 * This function gets the time set for @p obj, returning
9510 * it on the variables passed as the arguments to function
9512 * @note Use @c NULL pointers on the time values you're not
9513 * interested in: they'll be ignored by the function.
9517 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9520 * Set whether a given clock widget is under <b>edition mode</b> or
9521 * under (default) displaying-only mode.
9523 * @param obj The clock object
9524 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9525 * put it back to "displaying only" mode
9527 * This function makes a clock's time to be editable or not <b>by
9528 * user interaction</b>. When in edition mode, clocks @b stop
9529 * ticking, until one brings them back to canonical mode. The
9530 * elm_clock_digit_edit_set() function will influence which digits
9531 * of the clock will be editable. By default, all of them will be
9532 * (#ELM_CLOCK_NONE).
9534 * @note am/pm sheets, if being shown, will @b always be editable
9535 * under edition mode.
9537 * @see elm_clock_edit_get()
9541 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9544 * Retrieve whether a given clock widget is under <b>edition
9545 * mode</b> or under (default) displaying-only mode.
9547 * @param obj The clock object
9548 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9551 * This function retrieves whether the clock's time can be edited
9552 * or not by user interaction.
9554 * @see elm_clock_edit_set() for more details
9558 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9561 * Set what digits of the given clock widget should be editable
9562 * when in edition mode.
9564 * @param obj The clock object
9565 * @param digedit Bit mask indicating the digits to be editable
9566 * (values in #Elm_Clock_Digedit).
9568 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9569 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9572 * @see elm_clock_digit_edit_get()
9576 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9579 * Retrieve what digits of the given clock widget should be
9580 * editable when in edition mode.
9582 * @param obj The clock object
9583 * @return Bit mask indicating the digits to be editable
9584 * (values in #Elm_Clock_Digedit).
9586 * @see elm_clock_digit_edit_set() for more details
9590 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9593 * Set if the given clock widget must show hours in military or
9596 * @param obj The clock object
9597 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9600 * This function sets if the clock must show hours in military or
9601 * am/pm mode. In some countries like Brazil the military mode
9602 * (00-24h-format) is used, in opposition to the USA, where the
9603 * am/pm mode is more commonly used.
9605 * @see elm_clock_show_am_pm_get()
9609 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9612 * Get if the given clock widget shows hours in military or am/pm
9615 * @param obj The clock object
9616 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9619 * This function gets if the clock shows hours in military or am/pm
9622 * @see elm_clock_show_am_pm_set() for more details
9626 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9629 * Set if the given clock widget must show time with seconds or not
9631 * @param obj The clock object
9632 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9634 * This function sets if the given clock must show or not elapsed
9635 * seconds. By default, they are @b not shown.
9637 * @see elm_clock_show_seconds_get()
9641 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9644 * Get whether the given clock widget is showing time with seconds
9647 * @param obj The clock object
9648 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9650 * This function gets whether @p obj is showing or not the elapsed
9653 * @see elm_clock_show_seconds_set()
9657 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9660 * Set the interval on time updates for an user mouse button hold
9661 * on clock widgets' time edition.
9663 * @param obj The clock object
9664 * @param interval The (first) interval value in seconds
9666 * This interval value is @b decreased while the user holds the
9667 * mouse pointer either incrementing or decrementing a given the
9668 * clock digit's value.
9670 * This helps the user to get to a given time distant from the
9671 * current one easier/faster, as it will start to flip quicker and
9672 * quicker on mouse button holds.
9674 * The calculation for the next flip interval value, starting from
9675 * the one set with this call, is the previous interval divided by
9676 * 1.05, so it decreases a little bit.
9678 * The default starting interval value for automatic flips is
9681 * @see elm_clock_interval_get()
9685 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9688 * Get the interval on time updates for an user mouse button hold
9689 * on clock widgets' time edition.
9691 * @param obj The clock object
9692 * @return The (first) interval value, in seconds, set on it
9694 * @see elm_clock_interval_set() for more details
9698 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9705 * @defgroup Layout Layout
9707 * @image html img/widget/layout/preview-00.png
9708 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9710 * @image html img/layout-predefined.png
9711 * @image latex img/layout-predefined.eps width=\textwidth
9713 * This is a container widget that takes a standard Edje design file and
9714 * wraps it very thinly in a widget.
9716 * An Edje design (theme) file has a very wide range of possibilities to
9717 * describe the behavior of elements added to the Layout. Check out the Edje
9718 * documentation and the EDC reference to get more information about what can
9719 * be done with Edje.
9721 * Just like @ref List, @ref Box, and other container widgets, any
9722 * object added to the Layout will become its child, meaning that it will be
9723 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9725 * The Layout widget can contain as many Contents, Boxes or Tables as
9726 * described in its theme file. For instance, objects can be added to
9727 * different Tables by specifying the respective Table part names. The same
9728 * is valid for Content and Box.
9730 * The objects added as child of the Layout will behave as described in the
9731 * part description where they were added. There are 3 possible types of
9732 * parts where a child can be added:
9734 * @section secContent Content (SWALLOW part)
9736 * Only one object can be added to the @c SWALLOW part (but you still can
9737 * have many @c SWALLOW parts and one object on each of them). Use the @c
9738 * elm_object_content_set/get/unset functions to set, retrieve and unset
9739 * objects as content of the @c SWALLOW. After being set to this part, the
9740 * object size, position, visibility, clipping and other description
9741 * properties will be totally controled by the description of the given part
9742 * (inside the Edje theme file).
9744 * One can use @c evas_object_size_hint_* functions on the child to have some
9745 * kind of control over its behavior, but the resulting behavior will still
9746 * depend heavily on the @c SWALLOW part description.
9748 * The Edje theme also can change the part description, based on signals or
9749 * scripts running inside the theme. This change can also be animated. All of
9750 * this will affect the child object set as content accordingly. The object
9751 * size will be changed if the part size is changed, it will animate move if
9752 * the part is moving, and so on.
9754 * The following picture demonstrates a Layout widget with a child object
9755 * added to its @c SWALLOW:
9757 * @image html layout_swallow.png
9758 * @image latex layout_swallow.eps width=\textwidth
9760 * @section secBox Box (BOX part)
9762 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9763 * allows one to add objects to the box and have them distributed along its
9764 * area, accordingly to the specified @a layout property (now by @a layout we
9765 * mean the chosen layouting design of the Box, not the Layout widget
9768 * A similar effect for having a box with its position, size and other things
9769 * controled by the Layout theme would be to create an Elementary @ref Box
9770 * widget and add it as a Content in the @c SWALLOW part.
9772 * The main difference of using the Layout Box is that its behavior, the box
9773 * properties like layouting format, padding, align, etc. will be all
9774 * controled by the theme. This means, for example, that a signal could be
9775 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9776 * handled the signal by changing the box padding, or align, or both. Using
9777 * the Elementary @ref Box widget is not necessarily harder or easier, it
9778 * just depends on the circunstances and requirements.
9780 * The Layout Box can be used through the @c elm_layout_box_* set of
9783 * The following picture demonstrates a Layout widget with many child objects
9784 * added to its @c BOX part:
9786 * @image html layout_box.png
9787 * @image latex layout_box.eps width=\textwidth
9789 * @section secTable Table (TABLE part)
9791 * Just like the @ref secBox, the Layout Table is very similar to the
9792 * Elementary @ref Table widget. It allows one to add objects to the Table
9793 * specifying the row and column where the object should be added, and any
9794 * column or row span if necessary.
9796 * Again, we could have this design by adding a @ref Table widget to the @c
9797 * SWALLOW part using elm_object_content_part_set(). The same difference happens
9798 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9799 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9801 * The Layout Table can be used through the @c elm_layout_table_* set of
9804 * The following picture demonstrates a Layout widget with many child objects
9805 * added to its @c TABLE part:
9807 * @image html layout_table.png
9808 * @image latex layout_table.eps width=\textwidth
9810 * @section secPredef Predefined Layouts
9812 * Another interesting thing about the Layout widget is that it offers some
9813 * predefined themes that come with the default Elementary theme. These
9814 * themes can be set by the call elm_layout_theme_set(), and provide some
9815 * basic functionality depending on the theme used.
9817 * Most of them already send some signals, some already provide a toolbar or
9818 * back and next buttons.
9820 * These are available predefined theme layouts. All of them have class = @c
9821 * layout, group = @c application, and style = one of the following options:
9823 * @li @c toolbar-content - application with toolbar and main content area
9824 * @li @c toolbar-content-back - application with toolbar and main content
9825 * area with a back button and title area
9826 * @li @c toolbar-content-back-next - application with toolbar and main
9827 * content area with a back and next buttons and title area
9828 * @li @c content-back - application with a main content area with a back
9829 * button and title area
9830 * @li @c content-back-next - application with a main content area with a
9831 * back and next buttons and title area
9832 * @li @c toolbar-vbox - application with toolbar and main content area as a
9834 * @li @c toolbar-table - application with toolbar and main content area as a
9837 * @section secExamples Examples
9839 * Some examples of the Layout widget can be found here:
9840 * @li @ref layout_example_01
9841 * @li @ref layout_example_02
9842 * @li @ref layout_example_03
9843 * @li @ref layout_example_edc
9848 * Add a new layout to the parent
9850 * @param parent The parent object
9851 * @return The new object or NULL if it cannot be created
9853 * @see elm_layout_file_set()
9854 * @see elm_layout_theme_set()
9858 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9860 * Set the file that will be used as layout
9862 * @param obj The layout object
9863 * @param file The path to file (edj) that will be used as layout
9864 * @param group The group that the layout belongs in edje file
9866 * @return (1 = success, 0 = error)
9870 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9872 * Set the edje group from the elementary theme that will be used as layout
9874 * @param obj The layout object
9875 * @param clas the clas of the group
9876 * @param group the group
9877 * @param style the style to used
9879 * @return (1 = success, 0 = error)
9883 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9885 * Set the layout content.
9887 * @param obj The layout object
9888 * @param swallow The swallow part name in the edje file
9889 * @param content The child that will be added in this layout object
9891 * Once the content object is set, a previously set one will be deleted.
9892 * If you want to keep that old content object, use the
9893 * elm_object_content_part_unset() function.
9895 * @note In an Edje theme, the part used as a content container is called @c
9896 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9897 * expected to be a part name just like the second parameter of
9898 * elm_layout_box_append().
9900 * @see elm_layout_box_append()
9901 * @see elm_object_content_part_get()
9902 * @see elm_object_content_part_unset()
9907 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9909 * Get the child object in the given content part.
9911 * @param obj The layout object
9912 * @param swallow The SWALLOW part to get its content
9914 * @return The swallowed object or NULL if none or an error occurred
9916 * @see elm_object_content_part_set()
9920 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9922 * Unset the layout content.
9924 * @param obj The layout object
9925 * @param swallow The swallow part name in the edje file
9926 * @return The content that was being used
9928 * Unparent and return the content object which was set for this part.
9930 * @see elm_object_content_part_set()
9934 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9936 * Set the text of the given part
9938 * @param obj The layout object
9939 * @param part The TEXT part where to set the text
9940 * @param text The text to set
9943 * @deprecated use elm_object_text_* instead.
9945 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9947 * Get the text set in the given part
9949 * @param obj The layout object
9950 * @param part The TEXT part to retrieve the text off
9952 * @return The text set in @p part
9955 * @deprecated use elm_object_text_* instead.
9957 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9959 * Append child to layout box part.
9961 * @param obj the layout object
9962 * @param part the box part to which the object will be appended.
9963 * @param child the child object to append to box.
9965 * Once the object is appended, it will become child of the layout. Its
9966 * lifetime will be bound to the layout, whenever the layout dies the child
9967 * will be deleted automatically. One should use elm_layout_box_remove() to
9968 * make this layout forget about the object.
9970 * @see elm_layout_box_prepend()
9971 * @see elm_layout_box_insert_before()
9972 * @see elm_layout_box_insert_at()
9973 * @see elm_layout_box_remove()
9977 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9979 * Prepend child to layout box part.
9981 * @param obj the layout object
9982 * @param part the box part to prepend.
9983 * @param child the child object to prepend to box.
9985 * Once the object is prepended, it will become child of the layout. Its
9986 * lifetime will be bound to the layout, whenever the layout dies the child
9987 * will be deleted automatically. One should use elm_layout_box_remove() to
9988 * make this layout forget about the object.
9990 * @see elm_layout_box_append()
9991 * @see elm_layout_box_insert_before()
9992 * @see elm_layout_box_insert_at()
9993 * @see elm_layout_box_remove()
9997 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9999 * Insert child to layout box part before a reference object.
10001 * @param obj the layout object
10002 * @param part the box part to insert.
10003 * @param child the child object to insert into box.
10004 * @param reference another reference object to insert before in box.
10006 * Once the object is inserted, it will become child of the layout. Its
10007 * lifetime will be bound to the layout, whenever the layout dies the child
10008 * will be deleted automatically. One should use elm_layout_box_remove() to
10009 * make this layout forget about the object.
10011 * @see elm_layout_box_append()
10012 * @see elm_layout_box_prepend()
10013 * @see elm_layout_box_insert_before()
10014 * @see elm_layout_box_remove()
10018 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10020 * Insert child to layout box part at a given position.
10022 * @param obj the layout object
10023 * @param part the box part to insert.
10024 * @param child the child object to insert into box.
10025 * @param pos the numeric position >=0 to insert the child.
10027 * Once the object is inserted, it will become child of the layout. Its
10028 * lifetime will be bound to the layout, whenever the layout dies the child
10029 * will be deleted automatically. One should use elm_layout_box_remove() to
10030 * make this layout forget about the object.
10032 * @see elm_layout_box_append()
10033 * @see elm_layout_box_prepend()
10034 * @see elm_layout_box_insert_before()
10035 * @see elm_layout_box_remove()
10039 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10041 * Remove a child of the given part box.
10043 * @param obj The layout object
10044 * @param part The box part name to remove child.
10045 * @param child The object to remove from box.
10046 * @return The object that was being used, or NULL if not found.
10048 * The object will be removed from the box part and its lifetime will
10049 * not be handled by the layout anymore. This is equivalent to
10050 * elm_object_content_part_unset() for box.
10052 * @see elm_layout_box_append()
10053 * @see elm_layout_box_remove_all()
10057 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10059 * Remove all child of the given part box.
10061 * @param obj The layout object
10062 * @param part The box part name to remove child.
10063 * @param clear If EINA_TRUE, then all objects will be deleted as
10064 * well, otherwise they will just be removed and will be
10065 * dangling on the canvas.
10067 * The objects will be removed from the box part and their lifetime will
10068 * not be handled by the layout anymore. This is equivalent to
10069 * elm_layout_box_remove() for all box children.
10071 * @see elm_layout_box_append()
10072 * @see elm_layout_box_remove()
10076 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10078 * Insert child to layout table part.
10080 * @param obj the layout object
10081 * @param part the box part to pack child.
10082 * @param child_obj the child object to pack into table.
10083 * @param col the column to which the child should be added. (>= 0)
10084 * @param row the row to which the child should be added. (>= 0)
10085 * @param colspan how many columns should be used to store this object. (>=
10087 * @param rowspan how many rows should be used to store this object. (>= 1)
10089 * Once the object is inserted, it will become child of the table. Its
10090 * lifetime will be bound to the layout, and whenever the layout dies the
10091 * child will be deleted automatically. One should use
10092 * elm_layout_table_remove() to make this layout forget about the object.
10094 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10095 * more space than a single cell. For instance, the following code:
10097 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10100 * Would result in an object being added like the following picture:
10102 * @image html layout_colspan.png
10103 * @image latex layout_colspan.eps width=\textwidth
10105 * @see elm_layout_table_unpack()
10106 * @see elm_layout_table_clear()
10110 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);
10112 * Unpack (remove) a child of the given part table.
10114 * @param obj The layout object
10115 * @param part The table part name to remove child.
10116 * @param child_obj The object to remove from table.
10117 * @return The object that was being used, or NULL if not found.
10119 * The object will be unpacked from the table part and its lifetime
10120 * will not be handled by the layout anymore. This is equivalent to
10121 * elm_object_content_part_unset() for table.
10123 * @see elm_layout_table_pack()
10124 * @see elm_layout_table_clear()
10128 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10130 * Remove all child of the given part table.
10132 * @param obj The layout object
10133 * @param part The table part name to remove child.
10134 * @param clear If EINA_TRUE, then all objects will be deleted as
10135 * well, otherwise they will just be removed and will be
10136 * dangling on the canvas.
10138 * The objects will be removed from the table part and their lifetime will
10139 * not be handled by the layout anymore. This is equivalent to
10140 * elm_layout_table_unpack() for all table children.
10142 * @see elm_layout_table_pack()
10143 * @see elm_layout_table_unpack()
10147 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10149 * Get the edje layout
10151 * @param obj The layout object
10153 * @return A Evas_Object with the edje layout settings loaded
10154 * with function elm_layout_file_set
10156 * This returns the edje object. It is not expected to be used to then
10157 * swallow objects via edje_object_part_swallow() for example. Use
10158 * elm_object_content_part_set() instead so child object handling and sizing is
10161 * @note This function should only be used if you really need to call some
10162 * low level Edje function on this edje object. All the common stuff (setting
10163 * text, emitting signals, hooking callbacks to signals, etc.) can be done
10164 * with proper elementary functions.
10166 * @see elm_object_signal_callback_add()
10167 * @see elm_object_signal_emit()
10168 * @see elm_object_text_part_set()
10169 * @see elm_object_content_part_set()
10170 * @see elm_layout_box_append()
10171 * @see elm_layout_table_pack()
10172 * @see elm_layout_data_get()
10176 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10178 * Get the edje data from the given layout
10180 * @param obj The layout object
10181 * @param key The data key
10183 * @return The edje data string
10185 * This function fetches data specified inside the edje theme of this layout.
10186 * This function return NULL if data is not found.
10188 * In EDC this comes from a data block within the group block that @p
10189 * obj was loaded from. E.g.
10196 * item: "key1" "value1";
10197 * item: "key2" "value2";
10205 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10209 * @param obj The layout object
10211 * Manually forces a sizing re-evaluation. This is useful when the minimum
10212 * size required by the edje theme of this layout has changed. The change on
10213 * the minimum size required by the edje theme is not immediately reported to
10214 * the elementary layout, so one needs to call this function in order to tell
10215 * the widget (layout) that it needs to reevaluate its own size.
10217 * The minimum size of the theme is calculated based on minimum size of
10218 * parts, the size of elements inside containers like box and table, etc. All
10219 * of this can change due to state changes, and that's when this function
10220 * should be called.
10222 * Also note that a standard signal of "size,eval" "elm" emitted from the
10223 * edje object will cause this to happen too.
10227 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10230 * Sets a specific cursor for an edje part.
10232 * @param obj The layout object.
10233 * @param part_name a part from loaded edje group.
10234 * @param cursor cursor name to use, see Elementary_Cursor.h
10236 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10237 * part not exists or it has "mouse_events: 0".
10241 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10244 * Get the cursor to be shown when mouse is over an edje part
10246 * @param obj The layout object.
10247 * @param part_name a part from loaded edje group.
10248 * @return the cursor name.
10252 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10255 * Unsets a cursor previously set with elm_layout_part_cursor_set().
10257 * @param obj The layout object.
10258 * @param part_name a part from loaded edje group, that had a cursor set
10259 * with elm_layout_part_cursor_set().
10263 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10266 * Sets a specific cursor style for an edje part.
10268 * @param obj The layout object.
10269 * @param part_name a part from loaded edje group.
10270 * @param style the theme style to use (default, transparent, ...)
10272 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10273 * part not exists or it did not had a cursor set.
10277 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10280 * Gets a specific cursor style for an edje part.
10282 * @param obj The layout object.
10283 * @param part_name a part from loaded edje group.
10285 * @return the theme style in use, defaults to "default". If the
10286 * object does not have a cursor set, then NULL is returned.
10290 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10293 * Sets if the cursor set should be searched on the theme or should use
10294 * the provided by the engine, only.
10296 * @note before you set if should look on theme you should define a
10297 * cursor with elm_layout_part_cursor_set(). By default it will only
10298 * look for cursors provided by the engine.
10300 * @param obj The layout object.
10301 * @param part_name a part from loaded edje group.
10302 * @param engine_only if cursors should be just provided by the engine
10303 * or should also search on widget's theme as well
10305 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10306 * part not exists or it did not had a cursor set.
10310 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);
10313 * Gets a specific cursor engine_only for an edje part.
10315 * @param obj The layout object.
10316 * @param part_name a part from loaded edje group.
10318 * @return whenever the cursor is just provided by engine or also from theme.
10322 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10325 * @def elm_layout_icon_set
10326 * Convienience macro to set the icon object in a layout that follows the
10327 * Elementary naming convention for its parts.
10331 #define elm_layout_icon_set(_ly, _obj) \
10334 elm_object_content_part_set((_ly), "elm.swallow.icon", (_obj)); \
10335 if ((_obj)) sig = "elm,state,icon,visible"; \
10336 else sig = "elm,state,icon,hidden"; \
10337 elm_object_signal_emit((_ly), sig, "elm"); \
10341 * @def elm_layout_icon_get
10342 * Convienience macro to get the icon object from a layout that follows the
10343 * Elementary naming convention for its parts.
10347 #define elm_layout_icon_get(_ly) \
10348 elm_object_content_part_get((_ly), "elm.swallow.icon")
10351 * @def elm_layout_end_set
10352 * Convienience macro to set the end object in a layout that follows the
10353 * Elementary naming convention for its parts.
10357 #define elm_layout_end_set(_ly, _obj) \
10360 elm_object_content_part_set((_ly), "elm.swallow.end", (_obj)); \
10361 if ((_obj)) sig = "elm,state,end,visible"; \
10362 else sig = "elm,state,end,hidden"; \
10363 elm_object_signal_emit((_ly), sig, "elm"); \
10367 * @def elm_layout_end_get
10368 * Convienience macro to get the end object in a layout that follows the
10369 * Elementary naming convention for its parts.
10373 #define elm_layout_end_get(_ly) \
10374 elm_object_content_part_get((_ly), "elm.swallow.end")
10377 * @def elm_layout_label_set
10378 * Convienience macro to set the label in a layout that follows the
10379 * Elementary naming convention for its parts.
10382 * @deprecated use elm_object_text_* instead.
10384 #define elm_layout_label_set(_ly, _txt) \
10385 elm_layout_text_set((_ly), "elm.text", (_txt))
10388 * @def elm_layout_label_get
10389 * Convenience macro to get the label in a layout that follows the
10390 * Elementary naming convention for its parts.
10393 * @deprecated use elm_object_text_* instead.
10395 #define elm_layout_label_get(_ly) \
10396 elm_layout_text_get((_ly), "elm.text")
10398 /* smart callbacks called:
10399 * "theme,changed" - when elm theme is changed.
10403 * @defgroup Notify Notify
10405 * @image html img/widget/notify/preview-00.png
10406 * @image latex img/widget/notify/preview-00.eps
10408 * Display a container in a particular region of the parent(top, bottom,
10409 * etc). A timeout can be set to automatically hide the notify. This is so
10410 * that, after an evas_object_show() on a notify object, if a timeout was set
10411 * on it, it will @b automatically get hidden after that time.
10413 * Signals that you can add callbacks for are:
10414 * @li "timeout" - when timeout happens on notify and it's hidden
10415 * @li "block,clicked" - when a click outside of the notify happens
10417 * Default contents parts of the notify widget that you can use for are:
10418 * @li "elm.swallow.content" - A content of the notify
10420 * @ref tutorial_notify show usage of the API.
10425 * @brief Possible orient values for notify.
10427 * This values should be used in conjunction to elm_notify_orient_set() to
10428 * set the position in which the notify should appear(relative to its parent)
10429 * and in conjunction with elm_notify_orient_get() to know where the notify
10432 typedef enum _Elm_Notify_Orient
10434 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10435 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10436 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10437 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10438 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10439 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10440 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10441 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10442 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10443 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10444 } Elm_Notify_Orient;
10446 * @brief Add a new notify to the parent
10448 * @param parent The parent object
10449 * @return The new object or NULL if it cannot be created
10451 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10453 * @brief Set the content of the notify widget
10455 * @param obj The notify object
10456 * @param content The content will be filled in this notify object
10458 * Once the content object is set, a previously set one will be deleted. If
10459 * you want to keep that old content object, use the
10460 * elm_notify_content_unset() function.
10462 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10464 * @brief Unset the content of the notify widget
10466 * @param obj The notify object
10467 * @return The content that was being used
10469 * Unparent and return the content object which was set for this widget
10471 * @see elm_notify_content_set()
10473 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10475 * @brief Return the content of the notify widget
10477 * @param obj The notify object
10478 * @return The content that is being used
10480 * @see elm_notify_content_set()
10482 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10484 * @brief Set the notify parent
10486 * @param obj The notify object
10487 * @param content The new parent
10489 * Once the parent object is set, a previously set one will be disconnected
10492 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10494 * @brief Get the notify parent
10496 * @param obj The notify object
10497 * @return The parent
10499 * @see elm_notify_parent_set()
10501 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10503 * @brief Set the orientation
10505 * @param obj The notify object
10506 * @param orient The new orientation
10508 * Sets the position in which the notify will appear in its parent.
10510 * @see @ref Elm_Notify_Orient for possible values.
10512 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10514 * @brief Return the orientation
10515 * @param obj The notify object
10516 * @return The orientation of the notification
10518 * @see elm_notify_orient_set()
10519 * @see Elm_Notify_Orient
10521 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10523 * @brief Set the time interval after which the notify window is going to be
10526 * @param obj The notify object
10527 * @param time The timeout in seconds
10529 * This function sets a timeout and starts the timer controlling when the
10530 * notify is hidden. Since calling evas_object_show() on a notify restarts
10531 * the timer controlling when the notify is hidden, setting this before the
10532 * notify is shown will in effect mean starting the timer when the notify is
10535 * @note Set a value <= 0.0 to disable a running timer.
10537 * @note If the value > 0.0 and the notify is previously visible, the
10538 * timer will be started with this value, canceling any running timer.
10540 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10542 * @brief Return the timeout value (in seconds)
10543 * @param obj the notify object
10545 * @see elm_notify_timeout_set()
10547 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10549 * @brief Sets whether events should be passed to by a click outside
10552 * @param obj The notify object
10553 * @param repeats EINA_TRUE Events are repeats, else no
10555 * When true if the user clicks outside the window the events will be caught
10556 * by the others widgets, else the events are blocked.
10558 * @note The default value is EINA_TRUE.
10560 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10562 * @brief Return true if events are repeat below the notify object
10563 * @param obj the notify object
10565 * @see elm_notify_repeat_events_set()
10567 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10573 * @defgroup Hover Hover
10575 * @image html img/widget/hover/preview-00.png
10576 * @image latex img/widget/hover/preview-00.eps
10578 * A Hover object will hover over its @p parent object at the @p target
10579 * location. Anything in the background will be given a darker coloring to
10580 * indicate that the hover object is on top (at the default theme). When the
10581 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10582 * clicked that @b doesn't cause the hover to be dismissed.
10584 * A Hover object has two parents. One parent that owns it during creation
10585 * and the other parent being the one over which the hover object spans.
10588 * @note The hover object will take up the entire space of @p target
10591 * Elementary has the following styles for the hover widget:
10595 * @li hoversel_vertical
10597 * The following are the available position for content:
10609 * Signals that you can add callbacks for are:
10610 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10611 * @li "smart,changed" - a content object placed under the "smart"
10612 * policy was replaced to a new slot direction.
10614 * See @ref tutorial_hover for more information.
10618 typedef enum _Elm_Hover_Axis
10620 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10621 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10622 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10623 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10626 * @brief Adds a hover object to @p parent
10628 * @param parent The parent object
10629 * @return The hover object or NULL if one could not be created
10631 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10633 * @brief Sets the target object for the hover.
10635 * @param obj The hover object
10636 * @param target The object to center the hover onto. The hover
10638 * This function will cause the hover to be centered on the target object.
10640 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10642 * @brief Gets the target object for the hover.
10644 * @param obj The hover object
10645 * @param parent The object to locate the hover over.
10647 * @see elm_hover_target_set()
10649 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10651 * @brief Sets the parent object for the hover.
10653 * @param obj The hover object
10654 * @param parent The object to locate the hover over.
10656 * This function will cause the hover to take up the entire space that the
10657 * parent object fills.
10659 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10661 * @brief Gets the parent object for the hover.
10663 * @param obj The hover object
10664 * @return The parent object to locate the hover over.
10666 * @see elm_hover_parent_set()
10668 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10670 * @brief Sets the content of the hover object and the direction in which it
10673 * @param obj The hover object
10674 * @param swallow The direction that the object will be displayed
10675 * at. Accepted values are "left", "top-left", "top", "top-right",
10676 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10678 * @param content The content to place at @p swallow
10680 * Once the content object is set for a given direction, a previously
10681 * set one (on the same direction) will be deleted. If you want to
10682 * keep that old content object, use the elm_hover_content_unset()
10685 * All directions may have contents at the same time, except for
10686 * "smart". This is a special placement hint and its use case
10687 * independs of the calculations coming from
10688 * elm_hover_best_content_location_get(). Its use is for cases when
10689 * one desires only one hover content, but with a dinamic special
10690 * placement within the hover area. The content's geometry, whenever
10691 * it changes, will be used to decide on a best location not
10692 * extrapolating the hover's parent object view to show it in (still
10693 * being the hover's target determinant of its medium part -- move and
10694 * resize it to simulate finger sizes, for example). If one of the
10695 * directions other than "smart" are used, a previously content set
10696 * using it will be deleted, and vice-versa.
10698 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10700 * @brief Get the content of the hover object, in a given direction.
10702 * Return the content object which was set for this widget in the
10703 * @p swallow direction.
10705 * @param obj The hover object
10706 * @param swallow The direction that the object was display at.
10707 * @return The content that was being used
10709 * @see elm_hover_content_set()
10711 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10713 * @brief Unset the content of the hover object, in a given direction.
10715 * Unparent and return the content object set at @p swallow direction.
10717 * @param obj The hover object
10718 * @param swallow The direction that the object was display at.
10719 * @return The content that was being used.
10721 * @see elm_hover_content_set()
10723 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10725 * @brief Returns the best swallow location for content in the hover.
10727 * @param obj The hover object
10728 * @param pref_axis The preferred orientation axis for the hover object to use
10729 * @return The edje location to place content into the hover or @c
10732 * Best is defined here as the location at which there is the most available
10735 * @p pref_axis may be one of
10736 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10737 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10738 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10739 * - @c ELM_HOVER_AXIS_BOTH -- both
10741 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10742 * nescessarily be along the horizontal axis("left" or "right"). If
10743 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10744 * be along the vertical axis("top" or "bottom"). Chossing
10745 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10746 * returned position may be in either axis.
10748 * @see elm_hover_content_set()
10750 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10757 * @defgroup Entry Entry
10759 * @image html img/widget/entry/preview-00.png
10760 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10761 * @image html img/widget/entry/preview-01.png
10762 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10763 * @image html img/widget/entry/preview-02.png
10764 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10765 * @image html img/widget/entry/preview-03.png
10766 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10768 * An entry is a convenience widget which shows a box that the user can
10769 * enter text into. Entries by default don't scroll, so they grow to
10770 * accomodate the entire text, resizing the parent window as needed. This
10771 * can be changed with the elm_entry_scrollable_set() function.
10773 * They can also be single line or multi line (the default) and when set
10774 * to multi line mode they support text wrapping in any of the modes
10775 * indicated by #Elm_Wrap_Type.
10777 * Other features include password mode, filtering of inserted text with
10778 * elm_entry_text_filter_append() and related functions, inline "items" and
10779 * formatted markup text.
10781 * @section entry-markup Formatted text
10783 * The markup tags supported by the Entry are defined by the theme, but
10784 * even when writing new themes or extensions it's a good idea to stick to
10785 * a sane default, to maintain coherency and avoid application breakages.
10786 * Currently defined by the default theme are the following tags:
10787 * @li \<br\>: Inserts a line break.
10788 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10790 * @li \<tab\>: Inserts a tab.
10791 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10793 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10794 * @li \<link\>...\</link\>: Underlines the enclosed text.
10795 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10797 * @section entry-special Special markups
10799 * Besides those used to format text, entries support two special markup
10800 * tags used to insert clickable portions of text or items inlined within
10803 * @subsection entry-anchors Anchors
10805 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10806 * \</a\> tags and an event will be generated when this text is clicked,
10810 * This text is outside <a href=anc-01>but this one is an anchor</a>
10813 * The @c href attribute in the opening tag gives the name that will be
10814 * used to identify the anchor and it can be any valid utf8 string.
10816 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10817 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10818 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10819 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10822 * @subsection entry-items Items
10824 * Inlined in the text, any other @c Evas_Object can be inserted by using
10825 * \<item\> tags this way:
10828 * <item size=16x16 vsize=full href=emoticon/haha></item>
10831 * Just like with anchors, the @c href identifies each item, but these need,
10832 * in addition, to indicate their size, which is done using any one of
10833 * @c size, @c absize or @c relsize attributes. These attributes take their
10834 * value in the WxH format, where W is the width and H the height of the
10837 * @li absize: Absolute pixel size for the item. Whatever value is set will
10838 * be the item's size regardless of any scale value the object may have
10839 * been set to. The final line height will be adjusted to fit larger items.
10840 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10842 * @li relsize: Size is adjusted for the item to fit within the current
10845 * Besides their size, items are specificed a @c vsize value that affects
10846 * how their final size and position are calculated. The possible values
10848 * @li ascent: Item will be placed within the line's baseline and its
10849 * ascent. That is, the height between the line where all characters are
10850 * positioned and the highest point in the line. For @c size and @c absize
10851 * items, the descent value will be added to the total line height to make
10852 * them fit. @c relsize items will be adjusted to fit within this space.
10853 * @li full: Items will be placed between the descent and ascent, or the
10854 * lowest point in the line and its highest.
10856 * The next image shows different configurations of items and how they
10857 * are the previously mentioned options affect their sizes. In all cases,
10858 * the green line indicates the ascent, blue for the baseline and red for
10861 * @image html entry_item.png
10862 * @image latex entry_item.eps width=\textwidth
10864 * And another one to show how size differs from absize. In the first one,
10865 * the scale value is set to 1.0, while the second one is using one of 2.0.
10867 * @image html entry_item_scale.png
10868 * @image latex entry_item_scale.eps width=\textwidth
10870 * After the size for an item is calculated, the entry will request an
10871 * object to place in its space. For this, the functions set with
10872 * elm_entry_item_provider_append() and related functions will be called
10873 * in order until one of them returns a @c non-NULL value. If no providers
10874 * are available, or all of them return @c NULL, then the entry falls back
10875 * to one of the internal defaults, provided the name matches with one of
10878 * All of the following are currently supported:
10881 * - emoticon/angry-shout
10882 * - emoticon/crazy-laugh
10883 * - emoticon/evil-laugh
10885 * - emoticon/goggle-smile
10886 * - emoticon/grumpy
10887 * - emoticon/grumpy-smile
10888 * - emoticon/guilty
10889 * - emoticon/guilty-smile
10891 * - emoticon/half-smile
10892 * - emoticon/happy-panting
10894 * - emoticon/indifferent
10896 * - emoticon/knowing-grin
10898 * - emoticon/little-bit-sorry
10899 * - emoticon/love-lots
10901 * - emoticon/minimal-smile
10902 * - emoticon/not-happy
10903 * - emoticon/not-impressed
10905 * - emoticon/opensmile
10908 * - emoticon/squint-laugh
10909 * - emoticon/surprised
10910 * - emoticon/suspicious
10911 * - emoticon/tongue-dangling
10912 * - emoticon/tongue-poke
10914 * - emoticon/unhappy
10915 * - emoticon/very-sorry
10918 * - emoticon/worried
10921 * Alternatively, an item may reference an image by its path, using
10922 * the URI form @c file:///path/to/an/image.png and the entry will then
10923 * use that image for the item.
10925 * @section entry-files Loading and saving files
10927 * Entries have convinience functions to load text from a file and save
10928 * changes back to it after a short delay. The automatic saving is enabled
10929 * by default, but can be disabled with elm_entry_autosave_set() and files
10930 * can be loaded directly as plain text or have any markup in them
10931 * recognized. See elm_entry_file_set() for more details.
10933 * @section entry-signals Emitted signals
10935 * This widget emits the following signals:
10937 * @li "changed": The text within the entry was changed.
10938 * @li "changed,user": The text within the entry was changed because of user interaction.
10939 * @li "activated": The enter key was pressed on a single line entry.
10940 * @li "press": A mouse button has been pressed on the entry.
10941 * @li "longpressed": A mouse button has been pressed and held for a couple
10943 * @li "clicked": The entry has been clicked (mouse press and release).
10944 * @li "clicked,double": The entry has been double clicked.
10945 * @li "clicked,triple": The entry has been triple clicked.
10946 * @li "focused": The entry has received focus.
10947 * @li "unfocused": The entry has lost focus.
10948 * @li "selection,paste": A paste of the clipboard contents was requested.
10949 * @li "selection,copy": A copy of the selected text into the clipboard was
10951 * @li "selection,cut": A cut of the selected text into the clipboard was
10953 * @li "selection,start": A selection has begun and no previous selection
10955 * @li "selection,changed": The current selection has changed.
10956 * @li "selection,cleared": The current selection has been cleared.
10957 * @li "cursor,changed": The cursor has changed position.
10958 * @li "anchor,clicked": An anchor has been clicked. The event_info
10959 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10960 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10961 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10962 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10963 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10964 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10965 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10966 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10967 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10968 * @li "preedit,changed": The preedit string has changed.
10969 * @li "language,changed": Program language changed.
10971 * @section entry-examples
10973 * An overview of the Entry API can be seen in @ref entry_example_01
10978 * @typedef Elm_Entry_Anchor_Info
10980 * The info sent in the callback for the "anchor,clicked" signals emitted
10983 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10985 * @struct _Elm_Entry_Anchor_Info
10987 * The info sent in the callback for the "anchor,clicked" signals emitted
10990 struct _Elm_Entry_Anchor_Info
10992 const char *name; /**< The name of the anchor, as stated in its href */
10993 int button; /**< The mouse button used to click on it */
10994 Evas_Coord x, /**< Anchor geometry, relative to canvas */
10995 y, /**< Anchor geometry, relative to canvas */
10996 w, /**< Anchor geometry, relative to canvas */
10997 h; /**< Anchor geometry, relative to canvas */
11000 * @typedef Elm_Entry_Filter_Cb
11001 * This callback type is used by entry filters to modify text.
11002 * @param data The data specified as the last param when adding the filter
11003 * @param entry The entry object
11004 * @param text A pointer to the location of the text being filtered. This data can be modified,
11005 * but any additional allocations must be managed by the user.
11006 * @see elm_entry_text_filter_append
11007 * @see elm_entry_text_filter_prepend
11009 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11012 * This adds an entry to @p parent object.
11014 * By default, entries are:
11018 * @li autosave is enabled
11020 * @param parent The parent object
11021 * @return The new object or NULL if it cannot be created
11023 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11025 * Sets the entry to single line mode.
11027 * In single line mode, entries don't ever wrap when the text reaches the
11028 * edge, and instead they keep growing horizontally. Pressing the @c Enter
11029 * key will generate an @c "activate" event instead of adding a new line.
11031 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11032 * and pressing enter will break the text into a different line
11033 * without generating any events.
11035 * @param obj The entry object
11036 * @param single_line If true, the text in the entry
11037 * will be on a single line.
11039 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11041 * Gets whether the entry is set to be single line.
11043 * @param obj The entry object
11044 * @return single_line If true, the text in the entry is set to display
11045 * on a single line.
11047 * @see elm_entry_single_line_set()
11049 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11051 * Sets the entry to password mode.
11053 * In password mode, entries are implicitly single line and the display of
11054 * any text in them is replaced with asterisks (*).
11056 * @param obj The entry object
11057 * @param password If true, password mode is enabled.
11059 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11061 * Gets whether the entry is set to password mode.
11063 * @param obj The entry object
11064 * @return If true, the entry is set to display all characters
11065 * as asterisks (*).
11067 * @see elm_entry_password_set()
11069 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11071 * This sets the text displayed within the entry to @p entry.
11073 * @param obj The entry object
11074 * @param entry The text to be displayed
11076 * @deprecated Use elm_object_text_set() instead.
11077 * @note Using this function bypasses text filters
11079 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11081 * This returns the text currently shown in object @p entry.
11082 * See also elm_entry_entry_set().
11084 * @param obj The entry object
11085 * @return The currently displayed text or NULL on failure
11087 * @deprecated Use elm_object_text_get() instead.
11089 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11091 * Appends @p entry to the text of the entry.
11093 * Adds the text in @p entry to the end of any text already present in the
11096 * The appended text is subject to any filters set for the widget.
11098 * @param obj The entry object
11099 * @param entry The text to be displayed
11101 * @see elm_entry_text_filter_append()
11103 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11105 * Gets whether the entry is empty.
11107 * Empty means no text at all. If there are any markup tags, like an item
11108 * tag for which no provider finds anything, and no text is displayed, this
11109 * function still returns EINA_FALSE.
11111 * @param obj The entry object
11112 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11114 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11116 * Gets any selected text within the entry.
11118 * If there's any selected text in the entry, this function returns it as
11119 * a string in markup format. NULL is returned if no selection exists or
11120 * if an error occurred.
11122 * The returned value points to an internal string and should not be freed
11123 * or modified in any way. If the @p entry object is deleted or its
11124 * contents are changed, the returned pointer should be considered invalid.
11126 * @param obj The entry object
11127 * @return The selected text within the entry or NULL on failure
11129 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11131 * Inserts the given text into the entry at the current cursor position.
11133 * This inserts text at the cursor position as if it was typed
11134 * by the user (note that this also allows markup which a user
11135 * can't just "type" as it would be converted to escaped text, so this
11136 * call can be used to insert things like emoticon items or bold push/pop
11137 * tags, other font and color change tags etc.)
11139 * If any selection exists, it will be replaced by the inserted text.
11141 * The inserted text is subject to any filters set for the widget.
11143 * @param obj The entry object
11144 * @param entry The text to insert
11146 * @see elm_entry_text_filter_append()
11148 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11150 * Set the line wrap type to use on multi-line entries.
11152 * Sets the wrap type used by the entry to any of the specified in
11153 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11154 * line (without inserting a line break or paragraph separator) when it
11155 * reaches the far edge of the widget.
11157 * Note that this only makes sense for multi-line entries. A widget set
11158 * to be single line will never wrap.
11160 * @param obj The entry object
11161 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11163 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11164 EINA_DEPRECATED EAPI void elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
11166 * Gets the wrap mode the entry was set to use.
11168 * @param obj The entry object
11169 * @return Wrap type
11171 * @see also elm_entry_line_wrap_set()
11173 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11175 * Sets if the entry is to be editable or not.
11177 * By default, entries are editable and when focused, any text input by the
11178 * user will be inserted at the current cursor position. But calling this
11179 * function with @p editable as EINA_FALSE will prevent the user from
11180 * inputting text into the entry.
11182 * The only way to change the text of a non-editable entry is to use
11183 * elm_object_text_set(), elm_entry_entry_insert() and other related
11186 * @param obj The entry object
11187 * @param editable If EINA_TRUE, user input will be inserted in the entry,
11188 * if not, the entry is read-only and no user input is allowed.
11190 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11192 * Gets whether the entry is editable or not.
11194 * @param obj The entry object
11195 * @return If true, the entry is editable by the user.
11196 * If false, it is not editable by the user
11198 * @see elm_entry_editable_set()
11200 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11202 * This drops any existing text selection within the entry.
11204 * @param obj The entry object
11206 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11208 * This selects all text within the entry.
11210 * @param obj The entry object
11212 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11214 * This moves the cursor one place to the right within the entry.
11216 * @param obj The entry object
11217 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11219 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11221 * This moves the cursor one place to the left within the entry.
11223 * @param obj The entry object
11224 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11226 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11228 * This moves the cursor one line up within the entry.
11230 * @param obj The entry object
11231 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11233 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11235 * This moves the cursor one line down within the entry.
11237 * @param obj The entry object
11238 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11240 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11242 * This moves the cursor to the beginning of the entry.
11244 * @param obj The entry object
11246 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11248 * This moves the cursor to the end of the entry.
11250 * @param obj The entry object
11252 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11254 * This moves the cursor to the beginning of the current line.
11256 * @param obj The entry object
11258 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11260 * This moves the cursor to the end of the current line.
11262 * @param obj The entry object
11264 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11266 * This begins a selection within the entry as though
11267 * the user were holding down the mouse button to make a selection.
11269 * @param obj The entry object
11271 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11273 * This ends a selection within the entry as though
11274 * the user had just released the mouse button while making a selection.
11276 * @param obj The entry object
11278 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11280 * Gets whether a format node exists at the current cursor position.
11282 * A format node is anything that defines how the text is rendered. It can
11283 * be a visible format node, such as a line break or a paragraph separator,
11284 * or an invisible one, such as bold begin or end tag.
11285 * This function returns whether any format node exists at the current
11288 * @param obj The entry object
11289 * @return EINA_TRUE if the current cursor position contains a format node,
11290 * EINA_FALSE otherwise.
11292 * @see elm_entry_cursor_is_visible_format_get()
11294 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11296 * Gets if the current cursor position holds a visible format node.
11298 * @param obj The entry object
11299 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11300 * if it's an invisible one or no format exists.
11302 * @see elm_entry_cursor_is_format_get()
11304 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11306 * Gets the character pointed by the cursor at its current position.
11308 * This function returns a string with the utf8 character stored at the
11309 * current cursor position.
11310 * Only the text is returned, any format that may exist will not be part
11311 * of the return value.
11313 * @param obj The entry object
11314 * @return The text pointed by the cursors.
11316 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11318 * This function returns the geometry of the cursor.
11320 * It's useful if you want to draw something on the cursor (or where it is),
11321 * or for example in the case of scrolled entry where you want to show the
11324 * @param obj The entry object
11325 * @param x returned geometry
11326 * @param y returned geometry
11327 * @param w returned geometry
11328 * @param h returned geometry
11329 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11331 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);
11333 * Sets the cursor position in the entry to the given value
11335 * The value in @p pos is the index of the character position within the
11336 * contents of the string as returned by elm_entry_cursor_pos_get().
11338 * @param obj The entry object
11339 * @param pos The position of the cursor
11341 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11343 * Retrieves the current position of the cursor in the entry
11345 * @param obj The entry object
11346 * @return The cursor position
11348 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11350 * This executes a "cut" action on the selected text in the entry.
11352 * @param obj The entry object
11354 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11356 * This executes a "copy" action on the selected text in the entry.
11358 * @param obj The entry object
11360 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11362 * This executes a "paste" action in the entry.
11364 * @param obj The entry object
11366 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11368 * This clears and frees the items in a entry's contextual (longpress)
11371 * @param obj The entry object
11373 * @see elm_entry_context_menu_item_add()
11375 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11377 * This adds an item to the entry's contextual menu.
11379 * A longpress on an entry will make the contextual menu show up, if this
11380 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11381 * By default, this menu provides a few options like enabling selection mode,
11382 * which is useful on embedded devices that need to be explicit about it,
11383 * and when a selection exists it also shows the copy and cut actions.
11385 * With this function, developers can add other options to this menu to
11386 * perform any action they deem necessary.
11388 * @param obj The entry object
11389 * @param label The item's text label
11390 * @param icon_file The item's icon file
11391 * @param icon_type The item's icon type
11392 * @param func The callback to execute when the item is clicked
11393 * @param data The data to associate with the item for related functions
11395 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);
11397 * This disables the entry's contextual (longpress) menu.
11399 * @param obj The entry object
11400 * @param disabled If true, the menu is disabled
11402 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11404 * This returns whether the entry's contextual (longpress) menu is
11407 * @param obj The entry object
11408 * @return If true, the menu is disabled
11410 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11412 * This appends a custom item provider to the list for that entry
11414 * This appends the given callback. The list is walked from beginning to end
11415 * with each function called given the item href string in the text. If the
11416 * function returns an object handle other than NULL (it should create an
11417 * object to do this), then this object is used to replace that item. If
11418 * not the next provider is called until one provides an item object, or the
11419 * default provider in entry does.
11421 * @param obj The entry object
11422 * @param func The function called to provide the item object
11423 * @param data The data passed to @p func
11425 * @see @ref entry-items
11427 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);
11429 * This prepends a custom item provider to the list for that entry
11431 * This prepends the given callback. See elm_entry_item_provider_append() for
11434 * @param obj The entry object
11435 * @param func The function called to provide the item object
11436 * @param data The data passed to @p func
11438 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);
11440 * This removes a custom item provider to the list for that entry
11442 * This removes the given callback. See elm_entry_item_provider_append() for
11445 * @param obj The entry object
11446 * @param func The function called to provide the item object
11447 * @param data The data passed to @p func
11449 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);
11451 * Append a filter function for text inserted in the entry
11453 * Append the given callback to the list. This functions will be called
11454 * whenever any text is inserted into the entry, with the text to be inserted
11455 * as a parameter. The callback function is free to alter the text in any way
11456 * it wants, but it must remember to free the given pointer and update it.
11457 * If the new text is to be discarded, the function can free it and set its
11458 * text parameter to NULL. This will also prevent any following filters from
11461 * @param obj The entry object
11462 * @param func The function to use as text filter
11463 * @param data User data to pass to @p func
11465 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11467 * Prepend a filter function for text insdrted in the entry
11469 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11470 * for more information
11472 * @param obj The entry object
11473 * @param func The function to use as text filter
11474 * @param data User data to pass to @p func
11476 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11478 * Remove a filter from the list
11480 * Removes the given callback from the filter list. See
11481 * elm_entry_text_filter_append() for more information.
11483 * @param obj The entry object
11484 * @param func The filter function to remove
11485 * @param data The user data passed when adding the function
11487 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11489 * This converts a markup (HTML-like) string into UTF-8.
11491 * The returned string is a malloc'ed buffer and it should be freed when
11492 * not needed anymore.
11494 * @param s The string (in markup) to be converted
11495 * @return The converted string (in UTF-8). It should be freed.
11497 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11499 * This converts a UTF-8 string into markup (HTML-like).
11501 * The returned string is a malloc'ed buffer and it should be freed when
11502 * not needed anymore.
11504 * @param s The string (in UTF-8) to be converted
11505 * @return The converted string (in markup). It should be freed.
11507 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11509 * This sets the file (and implicitly loads it) for the text to display and
11510 * then edit. All changes are written back to the file after a short delay if
11511 * the entry object is set to autosave (which is the default).
11513 * If the entry had any other file set previously, any changes made to it
11514 * will be saved if the autosave feature is enabled, otherwise, the file
11515 * will be silently discarded and any non-saved changes will be lost.
11517 * @param obj The entry object
11518 * @param file The path to the file to load and save
11519 * @param format The file format
11521 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11523 * Gets the file being edited by the entry.
11525 * This function can be used to retrieve any file set on the entry for
11526 * edition, along with the format used to load and save it.
11528 * @param obj The entry object
11529 * @param file The path to the file to load and save
11530 * @param format The file format
11532 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11534 * This function writes any changes made to the file set with
11535 * elm_entry_file_set()
11537 * @param obj The entry object
11539 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11541 * This sets the entry object to 'autosave' the loaded text file or not.
11543 * @param obj The entry object
11544 * @param autosave Autosave the loaded file or not
11546 * @see elm_entry_file_set()
11548 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11550 * This gets the entry object's 'autosave' status.
11552 * @param obj The entry object
11553 * @return Autosave the loaded file or not
11555 * @see elm_entry_file_set()
11557 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11559 * Control pasting of text and images for the widget.
11561 * Normally the entry allows both text and images to be pasted. By setting
11562 * textonly to be true, this prevents images from being pasted.
11564 * Note this only changes the behaviour of text.
11566 * @param obj The entry object
11567 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11568 * text+image+other.
11570 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11572 * Getting elm_entry text paste/drop mode.
11574 * In textonly mode, only text may be pasted or dropped into the widget.
11576 * @param obj The entry object
11577 * @return If the widget only accepts text from pastes.
11579 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11581 * Enable or disable scrolling in entry
11583 * Normally the entry is not scrollable unless you enable it with this call.
11585 * @param obj The entry object
11586 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11588 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11590 * Get the scrollable state of the entry
11592 * Normally the entry is not scrollable. This gets the scrollable state
11593 * of the entry. See elm_entry_scrollable_set() for more information.
11595 * @param obj The entry object
11596 * @return The scrollable state
11598 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11600 * This sets a widget to be displayed to the left of a scrolled entry.
11602 * @param obj The scrolled entry object
11603 * @param icon The widget to display on the left side of the scrolled
11606 * @note A previously set widget will be destroyed.
11607 * @note If the object being set does not have minimum size hints set,
11608 * it won't get properly displayed.
11610 * @see elm_entry_end_set()
11612 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11614 * Gets the leftmost widget of the scrolled entry. This object is
11615 * owned by the scrolled entry and should not be modified.
11617 * @param obj The scrolled entry object
11618 * @return the left widget inside the scroller
11620 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11622 * Unset the leftmost widget of the scrolled entry, unparenting and
11625 * @param obj The scrolled entry object
11626 * @return the previously set icon sub-object of this entry, on
11629 * @see elm_entry_icon_set()
11631 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11633 * Sets the visibility of the left-side widget of the scrolled entry,
11634 * set by elm_entry_icon_set().
11636 * @param obj The scrolled entry object
11637 * @param setting EINA_TRUE if the object should be displayed,
11638 * EINA_FALSE if not.
11640 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11642 * This sets a widget to be displayed to the end of a scrolled entry.
11644 * @param obj The scrolled entry object
11645 * @param end The widget to display on the right side of the scrolled
11648 * @note A previously set widget will be destroyed.
11649 * @note If the object being set does not have minimum size hints set,
11650 * it won't get properly displayed.
11652 * @see elm_entry_icon_set
11654 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11656 * Gets the endmost widget of the scrolled entry. This object is owned
11657 * by the scrolled entry and should not be modified.
11659 * @param obj The scrolled entry object
11660 * @return the right widget inside the scroller
11662 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11664 * Unset the endmost widget of the scrolled entry, unparenting and
11667 * @param obj The scrolled entry object
11668 * @return the previously set icon sub-object of this entry, on
11671 * @see elm_entry_icon_set()
11673 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11675 * Sets the visibility of the end widget of the scrolled entry, set by
11676 * elm_entry_end_set().
11678 * @param obj The scrolled entry object
11679 * @param setting EINA_TRUE if the object should be displayed,
11680 * EINA_FALSE if not.
11682 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11684 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11687 * Setting an entry to single-line mode with elm_entry_single_line_set()
11688 * will automatically disable the display of scrollbars when the entry
11689 * moves inside its scroller.
11691 * @param obj The scrolled entry object
11692 * @param h The horizontal scrollbar policy to apply
11693 * @param v The vertical scrollbar policy to apply
11695 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11697 * This enables/disables bouncing within the entry.
11699 * This function sets whether the entry will bounce when scrolling reaches
11700 * the end of the contained entry.
11702 * @param obj The scrolled entry object
11703 * @param h The horizontal bounce state
11704 * @param v The vertical bounce state
11706 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11708 * Get the bounce mode
11710 * @param obj The Entry object
11711 * @param h_bounce Allow bounce horizontally
11712 * @param v_bounce Allow bounce vertically
11714 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11716 /* pre-made filters for entries */
11718 * @typedef Elm_Entry_Filter_Limit_Size
11720 * Data for the elm_entry_filter_limit_size() entry filter.
11722 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11724 * @struct _Elm_Entry_Filter_Limit_Size
11726 * Data for the elm_entry_filter_limit_size() entry filter.
11728 struct _Elm_Entry_Filter_Limit_Size
11730 int max_char_count; /**< The maximum number of characters allowed. */
11731 int max_byte_count; /**< The maximum number of bytes allowed*/
11734 * Filter inserted text based on user defined character and byte limits
11736 * Add this filter to an entry to limit the characters that it will accept
11737 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11738 * The funtion works on the UTF-8 representation of the string, converting
11739 * it from the set markup, thus not accounting for any format in it.
11741 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11742 * it as data when setting the filter. In it, it's possible to set limits
11743 * by character count or bytes (any of them is disabled if 0), and both can
11744 * be set at the same time. In that case, it first checks for characters,
11747 * The function will cut the inserted text in order to allow only the first
11748 * number of characters that are still allowed. The cut is made in
11749 * characters, even when limiting by bytes, in order to always contain
11750 * valid ones and avoid half unicode characters making it in.
11752 * This filter, like any others, does not apply when setting the entry text
11753 * directly with elm_object_text_set() (or the deprecated
11754 * elm_entry_entry_set()).
11756 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11758 * @typedef Elm_Entry_Filter_Accept_Set
11760 * Data for the elm_entry_filter_accept_set() entry filter.
11762 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11764 * @struct _Elm_Entry_Filter_Accept_Set
11766 * Data for the elm_entry_filter_accept_set() entry filter.
11768 struct _Elm_Entry_Filter_Accept_Set
11770 const char *accepted; /**< Set of characters accepted in the entry. */
11771 const char *rejected; /**< Set of characters rejected from the entry. */
11774 * Filter inserted text based on accepted or rejected sets of characters
11776 * Add this filter to an entry to restrict the set of accepted characters
11777 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11778 * This structure contains both accepted and rejected sets, but they are
11779 * mutually exclusive.
11781 * The @c accepted set takes preference, so if it is set, the filter will
11782 * only work based on the accepted characters, ignoring anything in the
11783 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11785 * In both cases, the function filters by matching utf8 characters to the
11786 * raw markup text, so it can be used to remove formatting tags.
11788 * This filter, like any others, does not apply when setting the entry text
11789 * directly with elm_object_text_set() (or the deprecated
11790 * elm_entry_entry_set()).
11792 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11794 * Set the input panel layout of the entry
11796 * @param obj The entry object
11797 * @param layout layout type
11799 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11801 * Get the input panel layout of the entry
11803 * @param obj The entry object
11804 * @return layout type
11806 * @see elm_entry_input_panel_layout_set
11808 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11810 * Set the autocapitalization type on the immodule.
11812 * @param obj The entry object
11813 * @param autocapital_type The type of autocapitalization
11815 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
11817 * Retrieve the autocapitalization type on the immodule.
11819 * @param obj The entry object
11820 * @return autocapitalization type
11822 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11824 * Sets the attribute to show the input panel automatically.
11826 * @param obj The entry object
11827 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
11829 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
11831 * Retrieve the attribute to show the input panel automatically.
11833 * @param obj The entry object
11834 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
11836 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11838 EAPI void elm_entry_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11839 EAPI void elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
11840 EAPI void elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
11841 EAPI void elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
11842 EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
11843 EAPI void elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
11844 EAPI void elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
11846 EINA_DEPRECATED EAPI void elm_entry_wrap_width_set(Evas_Object *obj, Evas_Coord w);
11847 EINA_DEPRECATED EAPI Evas_Coord elm_entry_wrap_width_get(const Evas_Object *obj);
11848 EINA_DEPRECATED EAPI void elm_entry_fontsize_set(Evas_Object *obj, int fontsize);
11849 EINA_DEPRECATED EAPI void elm_entry_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11850 EINA_DEPRECATED EAPI void elm_entry_text_align_set(Evas_Object *obj, const char *alignmode);
11856 /* composite widgets - these basically put together basic widgets above
11857 * in convenient packages that do more than basic stuff */
11861 * @defgroup Anchorview Anchorview
11863 * @image html img/widget/anchorview/preview-00.png
11864 * @image latex img/widget/anchorview/preview-00.eps
11866 * Anchorview is for displaying text that contains markup with anchors
11867 * like <c>\<a href=1234\>something\</\></c> in it.
11869 * Besides being styled differently, the anchorview widget provides the
11870 * necessary functionality so that clicking on these anchors brings up a
11871 * popup with user defined content such as "call", "add to contacts" or
11872 * "open web page". This popup is provided using the @ref Hover widget.
11874 * This widget is very similar to @ref Anchorblock, so refer to that
11875 * widget for an example. The only difference Anchorview has is that the
11876 * widget is already provided with scrolling functionality, so if the
11877 * text set to it is too large to fit in the given space, it will scroll,
11878 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11879 * text can be displayed.
11881 * This widget emits the following signals:
11882 * @li "anchor,clicked": will be called when an anchor is clicked. The
11883 * @p event_info parameter on the callback will be a pointer of type
11884 * ::Elm_Entry_Anchorview_Info.
11886 * See @ref Anchorblock for an example on how to use both of them.
11895 * @typedef Elm_Entry_Anchorview_Info
11897 * The info sent in the callback for "anchor,clicked" signals emitted by
11898 * the Anchorview widget.
11900 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11902 * @struct _Elm_Entry_Anchorview_Info
11904 * The info sent in the callback for "anchor,clicked" signals emitted by
11905 * the Anchorview widget.
11907 struct _Elm_Entry_Anchorview_Info
11909 const char *name; /**< Name of the anchor, as indicated in its href
11911 int button; /**< The mouse button used to click on it */
11912 Evas_Object *hover; /**< The hover object to use for the popup */
11914 Evas_Coord x, y, w, h;
11915 } anchor, /**< Geometry selection of text used as anchor */
11916 hover_parent; /**< Geometry of the object used as parent by the
11918 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11919 for content on the left side of
11920 the hover. Before calling the
11921 callback, the widget will make the
11922 necessary calculations to check
11923 which sides are fit to be set with
11924 content, based on the position the
11925 hover is activated and its distance
11926 to the edges of its parent object
11928 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11929 the right side of the hover.
11930 See @ref hover_left */
11931 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11932 of the hover. See @ref hover_left */
11933 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11934 below the hover. See @ref
11938 * Add a new Anchorview object
11940 * @param parent The parent object
11941 * @return The new object or NULL if it cannot be created
11943 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11945 * Set the text to show in the anchorview
11947 * Sets the text of the anchorview to @p text. This text can include markup
11948 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11949 * text that will be specially styled and react to click events, ended with
11950 * either of \</a\> or \</\>. When clicked, the anchor will emit an
11951 * "anchor,clicked" signal that you can attach a callback to with
11952 * evas_object_smart_callback_add(). The name of the anchor given in the
11953 * event info struct will be the one set in the href attribute, in this
11954 * case, anchorname.
11956 * Other markup can be used to style the text in different ways, but it's
11957 * up to the style defined in the theme which tags do what.
11958 * @deprecated use elm_object_text_set() instead.
11960 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11962 * Get the markup text set for the anchorview
11964 * Retrieves the text set on the anchorview, with markup tags included.
11966 * @param obj The anchorview object
11967 * @return The markup text set or @c NULL if nothing was set or an error
11969 * @deprecated use elm_object_text_set() instead.
11971 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11973 * Set the parent of the hover popup
11975 * Sets the parent object to use by the hover created by the anchorview
11976 * when an anchor is clicked. See @ref Hover for more details on this.
11977 * If no parent is set, the same anchorview object will be used.
11979 * @param obj The anchorview object
11980 * @param parent The object to use as parent for the hover
11982 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11984 * Get the parent of the hover popup
11986 * Get the object used as parent for the hover created by the anchorview
11987 * widget. See @ref Hover for more details on this.
11989 * @param obj The anchorview object
11990 * @return The object used as parent for the hover, NULL if none is set.
11992 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11994 * Set the style that the hover should use
11996 * When creating the popup hover, anchorview will request that it's
11997 * themed according to @p style.
11999 * @param obj The anchorview object
12000 * @param style The style to use for the underlying hover
12002 * @see elm_object_style_set()
12004 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12006 * Get the style that the hover should use
12008 * Get the style the hover created by anchorview will use.
12010 * @param obj The anchorview object
12011 * @return The style to use by the hover. NULL means the default is used.
12013 * @see elm_object_style_set()
12015 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12017 * Ends the hover popup in the anchorview
12019 * When an anchor is clicked, the anchorview widget will create a hover
12020 * object to use as a popup with user provided content. This function
12021 * terminates this popup, returning the anchorview to its normal state.
12023 * @param obj The anchorview object
12025 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12027 * Set bouncing behaviour when the scrolled content reaches an edge
12029 * Tell the internal scroller object whether it should bounce or not
12030 * when it reaches the respective edges for each axis.
12032 * @param obj The anchorview object
12033 * @param h_bounce Whether to bounce or not in the horizontal axis
12034 * @param v_bounce Whether to bounce or not in the vertical axis
12036 * @see elm_scroller_bounce_set()
12038 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12040 * Get the set bouncing behaviour of the internal scroller
12042 * Get whether the internal scroller should bounce when the edge of each
12043 * axis is reached scrolling.
12045 * @param obj The anchorview object
12046 * @param h_bounce Pointer where to store the bounce state of the horizontal
12048 * @param v_bounce Pointer where to store the bounce state of the vertical
12051 * @see elm_scroller_bounce_get()
12053 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12055 * Appends a custom item provider to the given anchorview
12057 * Appends the given function to the list of items providers. This list is
12058 * called, one function at a time, with the given @p data pointer, the
12059 * anchorview object and, in the @p item parameter, the item name as
12060 * referenced in its href string. Following functions in the list will be
12061 * called in order until one of them returns something different to NULL,
12062 * which should be an Evas_Object which will be used in place of the item
12065 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12066 * href=item/name\>\</item\>
12068 * @param obj The anchorview object
12069 * @param func The function to add to the list of providers
12070 * @param data User data that will be passed to the callback function
12072 * @see elm_entry_item_provider_append()
12074 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);
12076 * Prepend a custom item provider to the given anchorview
12078 * Like elm_anchorview_item_provider_append(), but it adds the function
12079 * @p func to the beginning of the list, instead of the end.
12081 * @param obj The anchorview object
12082 * @param func The function to add to the list of providers
12083 * @param data User data that will be passed to the callback function
12085 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);
12087 * Remove a custom item provider from the list of the given anchorview
12089 * Removes the function and data pairing that matches @p func and @p data.
12090 * That is, unless the same function and same user data are given, the
12091 * function will not be removed from the list. This allows us to add the
12092 * same callback several times, with different @p data pointers and be
12093 * able to remove them later without conflicts.
12095 * @param obj The anchorview object
12096 * @param func The function to remove from the list
12097 * @param data The data matching the function to remove from the list
12099 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);
12106 * @defgroup Anchorblock Anchorblock
12108 * @image html img/widget/anchorblock/preview-00.png
12109 * @image latex img/widget/anchorblock/preview-00.eps
12111 * Anchorblock is for displaying text that contains markup with anchors
12112 * like <c>\<a href=1234\>something\</\></c> in it.
12114 * Besides being styled differently, the anchorblock widget provides the
12115 * necessary functionality so that clicking on these anchors brings up a
12116 * popup with user defined content such as "call", "add to contacts" or
12117 * "open web page". This popup is provided using the @ref Hover widget.
12119 * This widget emits the following signals:
12120 * @li "anchor,clicked": will be called when an anchor is clicked. The
12121 * @p event_info parameter on the callback will be a pointer of type
12122 * ::Elm_Entry_Anchorblock_Info.
12128 * Since examples are usually better than plain words, we might as well
12129 * try @ref tutorial_anchorblock_example "one".
12132 * @addtogroup Anchorblock
12136 * @typedef Elm_Entry_Anchorblock_Info
12138 * The info sent in the callback for "anchor,clicked" signals emitted by
12139 * the Anchorblock widget.
12141 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12143 * @struct _Elm_Entry_Anchorblock_Info
12145 * The info sent in the callback for "anchor,clicked" signals emitted by
12146 * the Anchorblock widget.
12148 struct _Elm_Entry_Anchorblock_Info
12150 const char *name; /**< Name of the anchor, as indicated in its href
12152 int button; /**< The mouse button used to click on it */
12153 Evas_Object *hover; /**< The hover object to use for the popup */
12155 Evas_Coord x, y, w, h;
12156 } anchor, /**< Geometry selection of text used as anchor */
12157 hover_parent; /**< Geometry of the object used as parent by the
12159 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12160 for content on the left side of
12161 the hover. Before calling the
12162 callback, the widget will make the
12163 necessary calculations to check
12164 which sides are fit to be set with
12165 content, based on the position the
12166 hover is activated and its distance
12167 to the edges of its parent object
12169 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12170 the right side of the hover.
12171 See @ref hover_left */
12172 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12173 of the hover. See @ref hover_left */
12174 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12175 below the hover. See @ref
12179 * Add a new Anchorblock object
12181 * @param parent The parent object
12182 * @return The new object or NULL if it cannot be created
12184 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12186 * Set the text to show in the anchorblock
12188 * Sets the text of the anchorblock to @p text. This text can include markup
12189 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12190 * of text that will be specially styled and react to click events, ended
12191 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12192 * "anchor,clicked" signal that you can attach a callback to with
12193 * evas_object_smart_callback_add(). The name of the anchor given in the
12194 * event info struct will be the one set in the href attribute, in this
12195 * case, anchorname.
12197 * Other markup can be used to style the text in different ways, but it's
12198 * up to the style defined in the theme which tags do what.
12199 * @deprecated use elm_object_text_set() instead.
12201 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12203 * Get the markup text set for the anchorblock
12205 * Retrieves the text set on the anchorblock, with markup tags included.
12207 * @param obj The anchorblock object
12208 * @return The markup text set or @c NULL if nothing was set or an error
12210 * @deprecated use elm_object_text_set() instead.
12212 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12214 * Set the parent of the hover popup
12216 * Sets the parent object to use by the hover created by the anchorblock
12217 * when an anchor is clicked. See @ref Hover for more details on this.
12219 * @param obj The anchorblock object
12220 * @param parent The object to use as parent for the hover
12222 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12224 * Get the parent of the hover popup
12226 * Get the object used as parent for the hover created by the anchorblock
12227 * widget. See @ref Hover for more details on this.
12228 * If no parent is set, the same anchorblock object will be used.
12230 * @param obj The anchorblock object
12231 * @return The object used as parent for the hover, NULL if none is set.
12233 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12235 * Set the style that the hover should use
12237 * When creating the popup hover, anchorblock will request that it's
12238 * themed according to @p style.
12240 * @param obj The anchorblock object
12241 * @param style The style to use for the underlying hover
12243 * @see elm_object_style_set()
12245 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12247 * Get the style that the hover should use
12249 * Get the style, the hover created by anchorblock will use.
12251 * @param obj The anchorblock object
12252 * @return The style to use by the hover. NULL means the default is used.
12254 * @see elm_object_style_set()
12256 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12258 * Ends the hover popup in the anchorblock
12260 * When an anchor is clicked, the anchorblock widget will create a hover
12261 * object to use as a popup with user provided content. This function
12262 * terminates this popup, returning the anchorblock to its normal state.
12264 * @param obj The anchorblock object
12266 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12268 * Appends a custom item provider to the given anchorblock
12270 * Appends the given function to the list of items providers. This list is
12271 * called, one function at a time, with the given @p data pointer, the
12272 * anchorblock object and, in the @p item parameter, the item name as
12273 * referenced in its href string. Following functions in the list will be
12274 * called in order until one of them returns something different to NULL,
12275 * which should be an Evas_Object which will be used in place of the item
12278 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12279 * href=item/name\>\</item\>
12281 * @param obj The anchorblock object
12282 * @param func The function to add to the list of providers
12283 * @param data User data that will be passed to the callback function
12285 * @see elm_entry_item_provider_append()
12287 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);
12289 * Prepend a custom item provider to the given anchorblock
12291 * Like elm_anchorblock_item_provider_append(), but it adds the function
12292 * @p func to the beginning of the list, instead of the end.
12294 * @param obj The anchorblock object
12295 * @param func The function to add to the list of providers
12296 * @param data User data that will be passed to the callback function
12298 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);
12300 * Remove a custom item provider from the list of the given anchorblock
12302 * Removes the function and data pairing that matches @p func and @p data.
12303 * That is, unless the same function and same user data are given, the
12304 * function will not be removed from the list. This allows us to add the
12305 * same callback several times, with different @p data pointers and be
12306 * able to remove them later without conflicts.
12308 * @param obj The anchorblock object
12309 * @param func The function to remove from the list
12310 * @param data The data matching the function to remove from the list
12312 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);
12318 * @defgroup Bubble Bubble
12320 * @image html img/widget/bubble/preview-00.png
12321 * @image latex img/widget/bubble/preview-00.eps
12322 * @image html img/widget/bubble/preview-01.png
12323 * @image latex img/widget/bubble/preview-01.eps
12324 * @image html img/widget/bubble/preview-02.png
12325 * @image latex img/widget/bubble/preview-02.eps
12327 * @brief The Bubble is a widget to show text similar to how speech is
12328 * represented in comics.
12330 * The bubble widget contains 5 important visual elements:
12331 * @li The frame is a rectangle with rounded edjes and an "arrow".
12332 * @li The @p icon is an image to which the frame's arrow points to.
12333 * @li The @p label is a text which appears to the right of the icon if the
12334 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12336 * @li The @p info is a text which appears to the right of the label. Info's
12337 * font is of a ligther color than label.
12338 * @li The @p content is an evas object that is shown inside the frame.
12340 * The position of the arrow, icon, label and info depends on which corner is
12341 * selected. The four available corners are:
12342 * @li "top_left" - Default
12344 * @li "bottom_left"
12345 * @li "bottom_right"
12347 * Signals that you can add callbacks for are:
12348 * @li "clicked" - This is called when a user has clicked the bubble.
12350 * For an example of using a buble see @ref bubble_01_example_page "this".
12355 #define ELM_BUBBLE_CONTENT_ICON "elm.swallow.icon"
12358 * Add a new bubble to the parent
12360 * @param parent The parent object
12361 * @return The new object or NULL if it cannot be created
12363 * This function adds a text bubble to the given parent evas object.
12365 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12367 * Set the label of the bubble
12369 * @param obj The bubble object
12370 * @param label The string to set in the label
12372 * This function sets the title of the bubble. Where this appears depends on
12373 * the selected corner.
12374 * @deprecated use elm_object_text_set() instead.
12376 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12378 * Get the label of the bubble
12380 * @param obj The bubble object
12381 * @return The string of set in the label
12383 * This function gets the title of the bubble.
12384 * @deprecated use elm_object_text_get() instead.
12386 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12388 * Set the info of the bubble
12390 * @param obj The bubble object
12391 * @param info The given info about the bubble
12393 * This function sets the info of the bubble. Where this appears depends on
12394 * the selected corner.
12395 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12397 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12399 * Get the info of the bubble
12401 * @param obj The bubble object
12403 * @return The "info" string of the bubble
12405 * This function gets the info text.
12406 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12408 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12410 * Set the content to be shown in the bubble
12412 * Once the content object is set, a previously set one will be deleted.
12413 * If you want to keep the old content object, use the
12414 * elm_bubble_content_unset() function.
12416 * @param obj The bubble object
12417 * @param content The given content of the bubble
12419 * This function sets the content shown on the middle of the bubble.
12421 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12423 * Get the content shown in the bubble
12425 * Return the content object which is set for this widget.
12427 * @param obj The bubble object
12428 * @return The content that is being used
12430 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12432 * Unset the content shown in the bubble
12434 * Unparent and return the content object which was set for this widget.
12436 * @param obj The bubble object
12437 * @return The content that was being used
12439 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12441 * Set the icon of the bubble
12443 * Once the icon object is set, a previously set one will be deleted.
12444 * If you want to keep the old content object, use the
12445 * elm_icon_content_unset() function.
12447 * @param obj The bubble object
12448 * @param icon The given icon for the bubble
12450 * @deprecated use elm_object_content_part_set() instead
12453 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12455 * Get the icon of the bubble
12457 * @param obj The bubble object
12458 * @return The icon for the bubble
12460 * This function gets the icon shown on the top left of bubble.
12462 * @deprecated use elm_object_content_part_get() instead
12465 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12467 * Unset the icon of the bubble
12469 * Unparent and return the icon object which was set for this widget.
12471 * @param obj The bubble object
12472 * @return The icon that was being used
12474 * @deprecated use elm_object_content_part_unset() instead
12477 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12479 * Set the corner of the bubble
12481 * @param obj The bubble object.
12482 * @param corner The given corner for the bubble.
12484 * This function sets the corner of the bubble. The corner will be used to
12485 * determine where the arrow in the frame points to and where label, icon and
12488 * Possible values for corner are:
12489 * @li "top_left" - Default
12491 * @li "bottom_left"
12492 * @li "bottom_right"
12494 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12496 * Get the corner of the bubble
12498 * @param obj The bubble object.
12499 * @return The given corner for the bubble.
12501 * This function gets the selected corner of the bubble.
12503 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12505 EINA_DEPRECATED EAPI void elm_bubble_sweep_layout_set(Evas_Object *obj, Evas_Object *sweep) EINA_ARG_NONNULL(1);
12506 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_sweep_layout_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12513 * @defgroup Photo Photo
12515 * For displaying the photo of a person (contact). Simple, yet
12516 * with a very specific purpose.
12518 * Signals that you can add callbacks for are:
12520 * "clicked" - This is called when a user has clicked the photo
12521 * "drag,start" - Someone started dragging the image out of the object
12522 * "drag,end" - Dragged item was dropped (somewhere)
12528 * Add a new photo to the parent
12530 * @param parent The parent object
12531 * @return The new object or NULL if it cannot be created
12535 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12538 * Set the file that will be used as photo
12540 * @param obj The photo object
12541 * @param file The path to file that will be used as photo
12543 * @return (1 = success, 0 = error)
12547 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12550 * Set the file that will be used as thumbnail in the photo.
12552 * @param obj The photo object.
12553 * @param file The path to file that will be used as thumb.
12554 * @param group The key used in case of an EET file.
12558 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12561 * Set the size that will be used on the photo
12563 * @param obj The photo object
12564 * @param size The size that the photo will be
12568 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12571 * Set if the photo should be completely visible or not.
12573 * @param obj The photo object
12574 * @param fill if true the photo will be completely visible
12578 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12581 * Set editability of the photo.
12583 * An editable photo can be dragged to or from, and can be cut or
12584 * pasted too. Note that pasting an image or dropping an item on
12585 * the image will delete the existing content.
12587 * @param obj The photo object.
12588 * @param set To set of clear editablity.
12590 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12596 /* gesture layer */
12598 * @defgroup Elm_Gesture_Layer Gesture Layer
12599 * Gesture Layer Usage:
12601 * Use Gesture Layer to detect gestures.
12602 * The advantage is that you don't have to implement
12603 * gesture detection, just set callbacks of gesture state.
12604 * By using gesture layer we make standard interface.
12606 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12607 * with a parent object parameter.
12608 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12609 * call. Usually with same object as target (2nd parameter).
12611 * Now you need to tell gesture layer what gestures you follow.
12612 * This is done with @ref elm_gesture_layer_cb_set call.
12613 * By setting the callback you actually saying to gesture layer:
12614 * I would like to know when the gesture @ref Elm_Gesture_Types
12615 * switches to state @ref Elm_Gesture_State.
12617 * Next, you need to implement the actual action that follows the input
12618 * in your callback.
12620 * Note that if you like to stop being reported about a gesture, just set
12621 * all callbacks referring this gesture to NULL.
12622 * (again with @ref elm_gesture_layer_cb_set)
12624 * The information reported by gesture layer to your callback is depending
12625 * on @ref Elm_Gesture_Types:
12626 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12627 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12628 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12630 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12631 * @ref ELM_GESTURE_MOMENTUM.
12633 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12634 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12635 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12636 * Note that we consider a flick as a line-gesture that should be completed
12637 * in flick-time-limit as defined in @ref Config.
12639 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12641 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12644 * Gesture Layer Tweaks:
12646 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12647 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12649 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12650 * so gesture starts when user touches (a *DOWN event) touch-surface
12651 * and ends when no fingers touches surface (a *UP event).
12655 * @enum _Elm_Gesture_Types
12656 * Enum of supported gesture types.
12657 * @ingroup Elm_Gesture_Layer
12659 enum _Elm_Gesture_Types
12661 ELM_GESTURE_FIRST = 0,
12663 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12664 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12665 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12666 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12668 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12670 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12671 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12673 ELM_GESTURE_ZOOM, /**< Zoom */
12674 ELM_GESTURE_ROTATE, /**< Rotate */
12680 * @typedef Elm_Gesture_Types
12681 * gesture types enum
12682 * @ingroup Elm_Gesture_Layer
12684 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12687 * @enum _Elm_Gesture_State
12688 * Enum of gesture states.
12689 * @ingroup Elm_Gesture_Layer
12691 enum _Elm_Gesture_State
12693 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12694 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12695 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12696 ELM_GESTURE_STATE_END, /**< Gesture completed */
12697 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12701 * @typedef Elm_Gesture_State
12702 * gesture states enum
12703 * @ingroup Elm_Gesture_Layer
12705 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12708 * @struct _Elm_Gesture_Taps_Info
12709 * Struct holds taps info for user
12710 * @ingroup Elm_Gesture_Layer
12712 struct _Elm_Gesture_Taps_Info
12714 Evas_Coord x, y; /**< Holds center point between fingers */
12715 unsigned int n; /**< Number of fingers tapped */
12716 unsigned int timestamp; /**< event timestamp */
12720 * @typedef Elm_Gesture_Taps_Info
12721 * holds taps info for user
12722 * @ingroup Elm_Gesture_Layer
12724 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12727 * @struct _Elm_Gesture_Momentum_Info
12728 * Struct holds momentum info for user
12729 * x1 and y1 are not necessarily in sync
12730 * x1 holds x value of x direction starting point
12731 * and same holds for y1.
12732 * This is noticeable when doing V-shape movement
12733 * @ingroup Elm_Gesture_Layer
12735 struct _Elm_Gesture_Momentum_Info
12736 { /* Report line ends, timestamps, and momentum computed */
12737 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12738 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12739 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12740 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12742 unsigned int tx; /**< Timestamp of start of final x-swipe */
12743 unsigned int ty; /**< Timestamp of start of final y-swipe */
12745 Evas_Coord mx; /**< Momentum on X */
12746 Evas_Coord my; /**< Momentum on Y */
12748 unsigned int n; /**< Number of fingers */
12752 * @typedef Elm_Gesture_Momentum_Info
12753 * holds momentum info for user
12754 * @ingroup Elm_Gesture_Layer
12756 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12759 * @struct _Elm_Gesture_Line_Info
12760 * Struct holds line info for user
12761 * @ingroup Elm_Gesture_Layer
12763 struct _Elm_Gesture_Line_Info
12764 { /* Report line ends, timestamps, and momentum computed */
12765 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12766 /* FIXME should be radians, bot degrees */
12767 double angle; /**< Angle (direction) of lines */
12771 * @typedef Elm_Gesture_Line_Info
12772 * Holds line info for user
12773 * @ingroup Elm_Gesture_Layer
12775 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12778 * @struct _Elm_Gesture_Zoom_Info
12779 * Struct holds zoom info for user
12780 * @ingroup Elm_Gesture_Layer
12782 struct _Elm_Gesture_Zoom_Info
12784 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12785 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12786 double zoom; /**< Zoom value: 1.0 means no zoom */
12787 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12791 * @typedef Elm_Gesture_Zoom_Info
12792 * Holds zoom info for user
12793 * @ingroup Elm_Gesture_Layer
12795 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12798 * @struct _Elm_Gesture_Rotate_Info
12799 * Struct holds rotation info for user
12800 * @ingroup Elm_Gesture_Layer
12802 struct _Elm_Gesture_Rotate_Info
12804 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12805 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12806 double base_angle; /**< Holds start-angle */
12807 double angle; /**< Rotation value: 0.0 means no rotation */
12808 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12812 * @typedef Elm_Gesture_Rotate_Info
12813 * Holds rotation info for user
12814 * @ingroup Elm_Gesture_Layer
12816 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12819 * @typedef Elm_Gesture_Event_Cb
12820 * User callback used to stream gesture info from gesture layer
12821 * @param data user data
12822 * @param event_info gesture report info
12823 * Returns a flag field to be applied on the causing event.
12824 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12825 * upon the event, in an irreversible way.
12827 * @ingroup Elm_Gesture_Layer
12829 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12832 * Use function to set callbacks to be notified about
12833 * change of state of gesture.
12834 * When a user registers a callback with this function
12835 * this means this gesture has to be tested.
12837 * When ALL callbacks for a gesture are set to NULL
12838 * it means user isn't interested in gesture-state
12839 * and it will not be tested.
12841 * @param obj Pointer to gesture-layer.
12842 * @param idx The gesture you would like to track its state.
12843 * @param cb callback function pointer.
12844 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12845 * @param data user info to be sent to callback (usually, Smart Data)
12847 * @ingroup Elm_Gesture_Layer
12849 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);
12852 * Call this function to get repeat-events settings.
12854 * @param obj Pointer to gesture-layer.
12856 * @return repeat events settings.
12857 * @see elm_gesture_layer_hold_events_set()
12858 * @ingroup Elm_Gesture_Layer
12860 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12863 * This function called in order to make gesture-layer repeat events.
12864 * Set this of you like to get the raw events only if gestures were not detected.
12865 * Clear this if you like gesture layer to fwd events as testing gestures.
12867 * @param obj Pointer to gesture-layer.
12868 * @param r Repeat: TRUE/FALSE
12870 * @ingroup Elm_Gesture_Layer
12872 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12875 * This function sets step-value for zoom action.
12876 * Set step to any positive value.
12877 * Cancel step setting by setting to 0.0
12879 * @param obj Pointer to gesture-layer.
12880 * @param s new zoom step value.
12882 * @ingroup Elm_Gesture_Layer
12884 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12887 * This function sets step-value for rotate action.
12888 * Set step to any positive value.
12889 * Cancel step setting by setting to 0.0
12891 * @param obj Pointer to gesture-layer.
12892 * @param s new roatate step value.
12894 * @ingroup Elm_Gesture_Layer
12896 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12899 * This function called to attach gesture-layer to an Evas_Object.
12900 * @param obj Pointer to gesture-layer.
12901 * @param t Pointer to underlying object (AKA Target)
12903 * @return TRUE, FALSE on success, failure.
12905 * @ingroup Elm_Gesture_Layer
12907 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12910 * Call this function to construct a new gesture-layer object.
12911 * This does not activate the gesture layer. You have to
12912 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12914 * @param parent the parent object.
12916 * @return Pointer to new gesture-layer object.
12918 * @ingroup Elm_Gesture_Layer
12920 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12923 * @defgroup Thumb Thumb
12925 * @image html img/widget/thumb/preview-00.png
12926 * @image latex img/widget/thumb/preview-00.eps
12928 * A thumb object is used for displaying the thumbnail of an image or video.
12929 * You must have compiled Elementary with Ethumb_Client support and the DBus
12930 * service must be present and auto-activated in order to have thumbnails to
12933 * Once the thumbnail object becomes visible, it will check if there is a
12934 * previously generated thumbnail image for the file set on it. If not, it
12935 * will start generating this thumbnail.
12937 * Different config settings will cause different thumbnails to be generated
12938 * even on the same file.
12940 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12941 * Ethumb documentation to change this path, and to see other configuration
12944 * Signals that you can add callbacks for are:
12946 * - "clicked" - This is called when a user has clicked the thumb without dragging
12948 * - "clicked,double" - This is called when a user has double-clicked the thumb.
12949 * - "press" - This is called when a user has pressed down the thumb.
12950 * - "generate,start" - The thumbnail generation started.
12951 * - "generate,stop" - The generation process stopped.
12952 * - "generate,error" - The generation failed.
12953 * - "load,error" - The thumbnail image loading failed.
12955 * available styles:
12959 * An example of use of thumbnail:
12961 * - @ref thumb_example_01
12965 * @addtogroup Thumb
12970 * @enum _Elm_Thumb_Animation_Setting
12971 * @typedef Elm_Thumb_Animation_Setting
12973 * Used to set if a video thumbnail is animating or not.
12977 typedef enum _Elm_Thumb_Animation_Setting
12979 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12980 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
12981 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
12982 ELM_THUMB_ANIMATION_LAST
12983 } Elm_Thumb_Animation_Setting;
12986 * Add a new thumb object to the parent.
12988 * @param parent The parent object.
12989 * @return The new object or NULL if it cannot be created.
12991 * @see elm_thumb_file_set()
12992 * @see elm_thumb_ethumb_client_get()
12996 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12998 * Reload thumbnail if it was generated before.
13000 * @param obj The thumb object to reload
13002 * This is useful if the ethumb client configuration changed, like its
13003 * size, aspect or any other property one set in the handle returned
13004 * by elm_thumb_ethumb_client_get().
13006 * If the options didn't change, the thumbnail won't be generated again, but
13007 * the old one will still be used.
13009 * @see elm_thumb_file_set()
13013 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13015 * Set the file that will be used as thumbnail.
13017 * @param obj The thumb object.
13018 * @param file The path to file that will be used as thumb.
13019 * @param key The key used in case of an EET file.
13021 * The file can be an image or a video (in that case, acceptable extensions are:
13022 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13023 * function elm_thumb_animate().
13025 * @see elm_thumb_file_get()
13026 * @see elm_thumb_reload()
13027 * @see elm_thumb_animate()
13031 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13033 * Get the image or video path and key used to generate the thumbnail.
13035 * @param obj The thumb object.
13036 * @param file Pointer to filename.
13037 * @param key Pointer to key.
13039 * @see elm_thumb_file_set()
13040 * @see elm_thumb_path_get()
13044 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13046 * Get the path and key to the image or video generated by ethumb.
13048 * One just need to make sure that the thumbnail was generated before getting
13049 * its path; otherwise, the path will be NULL. One way to do that is by asking
13050 * for the path when/after the "generate,stop" smart callback is called.
13052 * @param obj The thumb object.
13053 * @param file Pointer to thumb path.
13054 * @param key Pointer to thumb key.
13056 * @see elm_thumb_file_get()
13060 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13062 * Set the animation state for the thumb object. If its content is an animated
13063 * video, you may start/stop the animation or tell it to play continuously and
13066 * @param obj The thumb object.
13067 * @param setting The animation setting.
13069 * @see elm_thumb_file_set()
13073 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13075 * Get the animation state for the thumb object.
13077 * @param obj The thumb object.
13078 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13081 * @see elm_thumb_animate_set()
13085 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13087 * Get the ethumb_client handle so custom configuration can be made.
13089 * @return Ethumb_Client instance or NULL.
13091 * This must be called before the objects are created to be sure no object is
13092 * visible and no generation started.
13094 * Example of usage:
13097 * #include <Elementary.h>
13098 * #ifndef ELM_LIB_QUICKLAUNCH
13100 * elm_main(int argc, char **argv)
13102 * Ethumb_Client *client;
13104 * elm_need_ethumb();
13108 * client = elm_thumb_ethumb_client_get();
13111 * ERR("could not get ethumb_client");
13114 * ethumb_client_size_set(client, 100, 100);
13115 * ethumb_client_crop_align_set(client, 0.5, 0.5);
13118 * // Create elm_thumb objects here
13128 * @note There's only one client handle for Ethumb, so once a configuration
13129 * change is done to it, any other request for thumbnails (for any thumbnail
13130 * object) will use that configuration. Thus, this configuration is global.
13134 EAPI void *elm_thumb_ethumb_client_get(void);
13136 * Get the ethumb_client connection state.
13138 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13141 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
13143 * Make the thumbnail 'editable'.
13145 * @param obj Thumb object.
13146 * @param set Turn on or off editability. Default is @c EINA_FALSE.
13148 * This means the thumbnail is a valid drag target for drag and drop, and can be
13149 * cut or pasted too.
13151 * @see elm_thumb_editable_get()
13155 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13156 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13158 * Make the thumbnail 'editable'.
13160 * @param obj Thumb object.
13161 * @return Editability.
13163 * This means the thumbnail is a valid drag target for drag and drop, and can be
13164 * cut or pasted too.
13166 * @see elm_thumb_editable_set()
13170 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13177 * @defgroup Web Web
13179 * @image html img/widget/web/preview-00.png
13180 * @image latex img/widget/web/preview-00.eps
13182 * A web object is used for displaying web pages (HTML/CSS/JS)
13183 * using WebKit-EFL. You must have compiled Elementary with
13186 * Signals that you can add callbacks for are:
13187 * @li "download,request": A file download has been requested. Event info is
13188 * a pointer to a Elm_Web_Download
13189 * @li "editorclient,contents,changed": Editor client's contents changed
13190 * @li "editorclient,selection,changed": Editor client's selection changed
13191 * @li "frame,created": A new frame was created. Event info is an
13192 * Evas_Object which can be handled with WebKit's ewk_frame API
13193 * @li "icon,received": An icon was received by the main frame
13194 * @li "inputmethod,changed": Input method changed. Event info is an
13195 * Eina_Bool indicating whether it's enabled or not
13196 * @li "js,windowobject,clear": JS window object has been cleared
13197 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13198 * is a char *link[2], where the first string contains the URL the link
13199 * points to, and the second one the title of the link
13200 * @li "link,hover,out": Mouse cursor left the link
13201 * @li "load,document,finished": Loading of a document finished. Event info
13202 * is the frame that finished loading
13203 * @li "load,error": Load failed. Event info is a pointer to
13204 * Elm_Web_Frame_Load_Error
13205 * @li "load,finished": Load finished. Event info is NULL on success, on
13206 * error it's a pointer to Elm_Web_Frame_Load_Error
13207 * @li "load,newwindow,show": A new window was created and is ready to be
13209 * @li "load,progress": Overall load progress. Event info is a pointer to
13210 * a double containing a value between 0.0 and 1.0
13211 * @li "load,provisional": Started provisional load
13212 * @li "load,started": Loading of a document started
13213 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13214 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13215 * the menubar is visible, or EINA_FALSE in case it's not
13216 * @li "menubar,visible,set": Informs menubar visibility. Event info is
13217 * an Eina_Bool indicating the visibility
13218 * @li "popup,created": A dropdown widget was activated, requesting its
13219 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13220 * @li "popup,willdelete": The web object is ready to destroy the popup
13221 * object created. Event info is a pointer to Elm_Web_Menu
13222 * @li "ready": Page is fully loaded
13223 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13224 * info is a pointer to Eina_Bool where the visibility state should be set
13225 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13226 * is an Eina_Bool with the visibility state set
13227 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13228 * a string with the new text
13229 * @li "statusbar,visible,get": Queries visibility of the status bar.
13230 * Event info is a pointer to Eina_Bool where the visibility state should be
13232 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13233 * an Eina_Bool with the visibility value
13234 * @li "title,changed": Title of the main frame changed. Event info is a
13235 * string with the new title
13236 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13237 * is a pointer to Eina_Bool where the visibility state should be set
13238 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13239 * info is an Eina_Bool with the visibility state
13240 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13241 * a string with the text to show
13242 * @li "uri,changed": URI of the main frame changed. Event info is a string
13244 * @li "view,resized": The web object internal's view changed sized
13245 * @li "windows,close,request": A JavaScript request to close the current
13246 * window was requested
13247 * @li "zoom,animated,end": Animated zoom finished
13249 * available styles:
13252 * An example of use of web:
13254 * - @ref web_example_01 TBD
13263 * Structure used to report load errors.
13265 * Load errors are reported as signal by elm_web. All the strings are
13266 * temporary references and should @b not be used after the signal
13267 * callback returns. If it's required, make copies with strdup() or
13268 * eina_stringshare_add() (they are not even guaranteed to be
13269 * stringshared, so must use eina_stringshare_add() and not
13270 * eina_stringshare_ref()).
13272 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13274 * Structure used to report load errors.
13276 * Load errors are reported as signal by elm_web. All the strings are
13277 * temporary references and should @b not be used after the signal
13278 * callback returns. If it's required, make copies with strdup() or
13279 * eina_stringshare_add() (they are not even guaranteed to be
13280 * stringshared, so must use eina_stringshare_add() and not
13281 * eina_stringshare_ref()).
13283 struct _Elm_Web_Frame_Load_Error
13285 int code; /**< Numeric error code */
13286 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13287 const char *domain; /**< Error domain name */
13288 const char *description; /**< Error description (already localized) */
13289 const char *failing_url; /**< The URL that failed to load */
13290 Evas_Object *frame; /**< Frame object that produced the error */
13294 * The possibles types that the items in a menu can be
13296 typedef enum _Elm_Web_Menu_Item_Type
13298 ELM_WEB_MENU_SEPARATOR,
13299 ELM_WEB_MENU_GROUP,
13300 ELM_WEB_MENU_OPTION
13301 } Elm_Web_Menu_Item_Type;
13304 * Structure describing the items in a menu
13306 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13308 * Structure describing the items in a menu
13310 struct _Elm_Web_Menu_Item
13312 const char *text; /**< The text for the item */
13313 Elm_Web_Menu_Item_Type type; /**< The type of the item */
13317 * Structure describing the menu of a popup
13319 * This structure will be passed as the @c event_info for the "popup,create"
13320 * signal, which is emitted when a dropdown menu is opened. Users wanting
13321 * to handle these popups by themselves should listen to this signal and
13322 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13323 * property as @c EINA_FALSE means that the user will not handle the popup
13324 * and the default implementation will be used.
13326 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13327 * will be emitted to notify the user that it can destroy any objects and
13328 * free all data related to it.
13330 * @see elm_web_popup_selected_set()
13331 * @see elm_web_popup_destroy()
13333 typedef struct _Elm_Web_Menu Elm_Web_Menu;
13335 * Structure describing the menu of a popup
13337 * This structure will be passed as the @c event_info for the "popup,create"
13338 * signal, which is emitted when a dropdown menu is opened. Users wanting
13339 * to handle these popups by themselves should listen to this signal and
13340 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13341 * property as @c EINA_FALSE means that the user will not handle the popup
13342 * and the default implementation will be used.
13344 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13345 * will be emitted to notify the user that it can destroy any objects and
13346 * free all data related to it.
13348 * @see elm_web_popup_selected_set()
13349 * @see elm_web_popup_destroy()
13351 struct _Elm_Web_Menu
13353 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13354 int x; /**< The X position of the popup, relative to the elm_web object */
13355 int y; /**< The Y position of the popup, relative to the elm_web object */
13356 int width; /**< Width of the popup menu */
13357 int height; /**< Height of the popup menu */
13359 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. */
13362 typedef struct _Elm_Web_Download Elm_Web_Download;
13363 struct _Elm_Web_Download
13369 * Types of zoom available.
13371 typedef enum _Elm_Web_Zoom_Mode
13373 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13374 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13375 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13376 ELM_WEB_ZOOM_MODE_LAST
13377 } Elm_Web_Zoom_Mode;
13379 * Opaque handler containing the features (such as statusbar, menubar, etc)
13380 * that are to be set on a newly requested window.
13382 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13384 * Callback type for the create_window hook.
13386 * The function parameters are:
13387 * @li @p data User data pointer set when setting the hook function
13388 * @li @p obj The elm_web object requesting the new window
13389 * @li @p js Set to @c EINA_TRUE if the request was originated from
13390 * JavaScript. @c EINA_FALSE otherwise.
13391 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13392 * the features requested for the new window.
13394 * The returned value of the function should be the @c elm_web widget where
13395 * the request will be loaded. That is, if a new window or tab is created,
13396 * the elm_web widget in it should be returned, and @b NOT the window
13398 * Returning @c NULL should cancel the request.
13400 * @see elm_web_window_create_hook_set()
13402 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13404 * Callback type for the JS alert hook.
13406 * The function parameters are:
13407 * @li @p data User data pointer set when setting the hook function
13408 * @li @p obj The elm_web object requesting the new window
13409 * @li @p message The message to show in the alert dialog
13411 * The function should return the object representing the alert dialog.
13412 * Elm_Web will run a second main loop to handle the dialog and normal
13413 * flow of the application will be restored when the object is deleted, so
13414 * the user should handle the popup properly in order to delete the object
13415 * when the action is finished.
13416 * If the function returns @c NULL the popup will be ignored.
13418 * @see elm_web_dialog_alert_hook_set()
13420 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13422 * Callback type for the JS confirm hook.
13424 * The function parameters are:
13425 * @li @p data User data pointer set when setting the hook function
13426 * @li @p obj The elm_web object requesting the new window
13427 * @li @p message The message to show in the confirm dialog
13428 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13429 * the user selected @c Ok, @c EINA_FALSE otherwise.
13431 * The function should return the object representing the confirm dialog.
13432 * Elm_Web will run a second main loop to handle the dialog and normal
13433 * flow of the application will be restored when the object is deleted, so
13434 * the user should handle the popup properly in order to delete the object
13435 * when the action is finished.
13436 * If the function returns @c NULL the popup will be ignored.
13438 * @see elm_web_dialog_confirm_hook_set()
13440 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13442 * Callback type for the JS prompt hook.
13444 * The function parameters are:
13445 * @li @p data User data pointer set when setting the hook function
13446 * @li @p obj The elm_web object requesting the new window
13447 * @li @p message The message to show in the prompt dialog
13448 * @li @p def_value The default value to present the user in the entry
13449 * @li @p value Pointer where to store the value given by the user. Must
13450 * be a malloc'ed string or @c NULL if the user cancelled the popup.
13451 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13452 * the user selected @c Ok, @c EINA_FALSE otherwise.
13454 * The function should return the object representing the prompt dialog.
13455 * Elm_Web will run a second main loop to handle the dialog and normal
13456 * flow of the application will be restored when the object is deleted, so
13457 * the user should handle the popup properly in order to delete the object
13458 * when the action is finished.
13459 * If the function returns @c NULL the popup will be ignored.
13461 * @see elm_web_dialog_prompt_hook_set()
13463 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13465 * Callback type for the JS file selector hook.
13467 * The function parameters are:
13468 * @li @p data User data pointer set when setting the hook function
13469 * @li @p obj The elm_web object requesting the new window
13470 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13471 * @li @p accept_types Mime types accepted
13472 * @li @p selected Pointer where to store the list of malloc'ed strings
13473 * containing the path to each file selected. Must be @c NULL if the file
13474 * dialog is cancelled
13475 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13476 * the user selected @c Ok, @c EINA_FALSE otherwise.
13478 * The function should return the object representing the file selector
13480 * Elm_Web will run a second main loop to handle the dialog and normal
13481 * flow of the application will be restored when the object is deleted, so
13482 * the user should handle the popup properly in order to delete the object
13483 * when the action is finished.
13484 * If the function returns @c NULL the popup will be ignored.
13486 * @see elm_web_dialog_file selector_hook_set()
13488 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);
13490 * Callback type for the JS console message hook.
13492 * When a console message is added from JavaScript, any set function to the
13493 * console message hook will be called for the user to handle. There is no
13494 * default implementation of this hook.
13496 * The function parameters are:
13497 * @li @p data User data pointer set when setting the hook function
13498 * @li @p obj The elm_web object that originated the message
13499 * @li @p message The message sent
13500 * @li @p line_number The line number
13501 * @li @p source_id Source id
13503 * @see elm_web_console_message_hook_set()
13505 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13507 * Add a new web object to the parent.
13509 * @param parent The parent object.
13510 * @return The new object or NULL if it cannot be created.
13512 * @see elm_web_uri_set()
13513 * @see elm_web_webkit_view_get()
13515 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13518 * Get internal ewk_view object from web object.
13520 * Elementary may not provide some low level features of EWebKit,
13521 * instead of cluttering the API with proxy methods we opted to
13522 * return the internal reference. Be careful using it as it may
13523 * interfere with elm_web behavior.
13525 * @param obj The web object.
13526 * @return The internal ewk_view object or NULL if it does not
13527 * exist. (Failure to create or Elementary compiled without
13530 * @see elm_web_add()
13532 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13535 * Sets the function to call when a new window is requested
13537 * This hook will be called when a request to create a new window is
13538 * issued from the web page loaded.
13539 * There is no default implementation for this feature, so leaving this
13540 * unset or passing @c NULL in @p func will prevent new windows from
13543 * @param obj The web object where to set the hook function
13544 * @param func The hook function to be called when a window is requested
13545 * @param data User data
13547 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13549 * Sets the function to call when an alert dialog
13551 * This hook will be called when a JavaScript alert dialog is requested.
13552 * If no function is set or @c NULL is passed in @p func, the default
13553 * implementation will take place.
13555 * @param obj The web object where to set the hook function
13556 * @param func The callback function to be used
13557 * @param data User data
13559 * @see elm_web_inwin_mode_set()
13561 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13563 * Sets the function to call when an confirm dialog
13565 * This hook will be called when a JavaScript confirm dialog is requested.
13566 * If no function is set or @c NULL is passed in @p func, the default
13567 * implementation will take place.
13569 * @param obj The web object where to set the hook function
13570 * @param func The callback function to be used
13571 * @param data User data
13573 * @see elm_web_inwin_mode_set()
13575 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13577 * Sets the function to call when an prompt dialog
13579 * This hook will be called when a JavaScript prompt dialog is requested.
13580 * If no function is set or @c NULL is passed in @p func, the default
13581 * implementation will take place.
13583 * @param obj The web object where to set the hook function
13584 * @param func The callback function to be used
13585 * @param data User data
13587 * @see elm_web_inwin_mode_set()
13589 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13591 * Sets the function to call when an file selector dialog
13593 * This hook will be called when a JavaScript file selector dialog is
13595 * If no function is set or @c NULL is passed in @p func, the default
13596 * implementation will take place.
13598 * @param obj The web object where to set the hook function
13599 * @param func The callback function to be used
13600 * @param data User data
13602 * @see elm_web_inwin_mode_set()
13604 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13606 * Sets the function to call when a console message is emitted from JS
13608 * This hook will be called when a console message is emitted from
13609 * JavaScript. There is no default implementation for this feature.
13611 * @param obj The web object where to set the hook function
13612 * @param func The callback function to be used
13613 * @param data User data
13615 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13617 * Gets the status of the tab propagation
13619 * @param obj The web object to query
13620 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13622 * @see elm_web_tab_propagate_set()
13624 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
13626 * Sets whether to use tab propagation
13628 * If tab propagation is enabled, whenever the user presses the Tab key,
13629 * Elementary will handle it and switch focus to the next widget.
13630 * The default value is disabled, where WebKit will handle the Tab key to
13631 * cycle focus though its internal objects, jumping to the next widget
13632 * only when that cycle ends.
13634 * @param obj The web object
13635 * @param propagate Whether to propagate Tab keys to Elementary or not
13637 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13639 * Sets the URI for the web object
13641 * It must be a full URI, with resource included, in the form
13642 * http://www.enlightenment.org or file:///tmp/something.html
13644 * @param obj The web object
13645 * @param uri The URI to set
13646 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13648 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
13650 * Gets the current URI for the object
13652 * The returned string must not be freed and is guaranteed to be
13655 * @param obj The web object
13656 * @return A stringshared internal string with the current URI, or NULL on
13659 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
13661 * Gets the current title
13663 * The returned string must not be freed and is guaranteed to be
13666 * @param obj The web object
13667 * @return A stringshared internal string with the current title, or NULL on
13670 EAPI const char *elm_web_title_get(const Evas_Object *obj);
13672 * Sets the background color to be used by the web object
13674 * This is the color that will be used by default when the loaded page
13675 * does not set it's own. Color values are pre-multiplied.
13677 * @param obj The web object
13678 * @param r Red component
13679 * @param g Green component
13680 * @param b Blue component
13681 * @param a Alpha component
13683 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13685 * Gets the background color to be used by the web object
13687 * This is the color that will be used by default when the loaded page
13688 * does not set it's own. Color values are pre-multiplied.
13690 * @param obj The web object
13691 * @param r Red component
13692 * @param g Green component
13693 * @param b Blue component
13694 * @param a Alpha component
13696 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13698 * Gets a copy of the currently selected text
13700 * The string returned must be freed by the user when it's done with it.
13702 * @param obj The web object
13703 * @return A newly allocated string, or NULL if nothing is selected or an
13706 EAPI char *elm_view_selection_get(const Evas_Object *obj);
13708 * Tells the web object which index in the currently open popup was selected
13710 * When the user handles the popup creation from the "popup,created" signal,
13711 * it needs to tell the web object which item was selected by calling this
13712 * function with the index corresponding to the item.
13714 * @param obj The web object
13715 * @param index The index selected
13717 * @see elm_web_popup_destroy()
13719 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
13721 * Dismisses an open dropdown popup
13723 * When the popup from a dropdown widget is to be dismissed, either after
13724 * selecting an option or to cancel it, this function must be called, which
13725 * will later emit an "popup,willdelete" signal to notify the user that
13726 * any memory and objects related to this popup can be freed.
13728 * @param obj The web object
13729 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13730 * if there was no menu to destroy
13732 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
13734 * Searches the given string in a document.
13736 * @param obj The web object where to search the text
13737 * @param string String to search
13738 * @param case_sensitive If search should be case sensitive or not
13739 * @param forward If search is from cursor and on or backwards
13740 * @param wrap If search should wrap at the end
13742 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13745 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13747 * Marks matches of the given string in a document.
13749 * @param obj The web object where to search text
13750 * @param string String to match
13751 * @param case_sensitive If match should be case sensitive or not
13752 * @param highlight If matches should be highlighted
13753 * @param limit Maximum amount of matches, or zero to unlimited
13755 * @return number of matched @a string
13757 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13759 * Clears all marked matches in the document
13761 * @param obj The web object
13763 * @return EINA_TRUE on success, EINA_FALSE otherwise
13765 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
13767 * Sets whether to highlight the matched marks
13769 * If enabled, marks set with elm_web_text_matches_mark() will be
13772 * @param obj The web object
13773 * @param highlight Whether to highlight the marks or not
13775 * @return EINA_TRUE on success, EINA_FALSE otherwise
13777 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13779 * Gets whether highlighting marks is enabled
13781 * @param The web object
13783 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13786 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
13788 * Gets the overall loading progress of the page
13790 * Returns the estimated loading progress of the page, with a value between
13791 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13792 * included in the page.
13794 * @param The web object
13796 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13799 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
13801 * Stops loading the current page
13803 * Cancels the loading of the current page in the web object. This will
13804 * cause a "load,error" signal to be emitted, with the is_cancellation
13805 * flag set to EINA_TRUE.
13807 * @param obj The web object
13809 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13811 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
13813 * Requests a reload of the current document in the object
13815 * @param obj The web object
13817 * @return EINA_TRUE on success, EINA_FALSE otherwise
13819 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
13821 * Requests a reload of the current document, avoiding any existing caches
13823 * @param obj The web object
13825 * @return EINA_TRUE on success, EINA_FALSE otherwise
13827 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
13829 * Goes back one step in the browsing history
13831 * This is equivalent to calling elm_web_object_navigate(obj, -1);
13833 * @param obj The web object
13835 * @return EINA_TRUE on success, EINA_FALSE otherwise
13837 * @see elm_web_history_enable_set()
13838 * @see elm_web_back_possible()
13839 * @see elm_web_forward()
13840 * @see elm_web_navigate()
13842 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
13844 * Goes forward one step in the browsing history
13846 * This is equivalent to calling elm_web_object_navigate(obj, 1);
13848 * @param obj The web object
13850 * @return EINA_TRUE on success, EINA_FALSE otherwise
13852 * @see elm_web_history_enable_set()
13853 * @see elm_web_forward_possible()
13854 * @see elm_web_back()
13855 * @see elm_web_navigate()
13857 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
13859 * Jumps the given number of steps in the browsing history
13861 * The @p steps value can be a negative integer to back in history, or a
13862 * positive to move forward.
13864 * @param obj The web object
13865 * @param steps The number of steps to jump
13867 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13868 * history exists to jump the given number of steps
13870 * @see elm_web_history_enable_set()
13871 * @see elm_web_navigate_possible()
13872 * @see elm_web_back()
13873 * @see elm_web_forward()
13875 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
13877 * Queries whether it's possible to go back in history
13879 * @param obj The web object
13881 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13884 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
13886 * Queries whether it's possible to go forward in history
13888 * @param obj The web object
13890 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13893 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
13895 * Queries whether it's possible to jump the given number of steps
13897 * The @p steps value can be a negative integer to back in history, or a
13898 * positive to move forward.
13900 * @param obj The web object
13901 * @param steps The number of steps to check for
13903 * @return EINA_TRUE if enough history exists to perform the given jump,
13904 * EINA_FALSE otherwise
13906 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
13908 * Gets whether browsing history is enabled for the given object
13910 * @param obj The web object
13912 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
13914 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
13916 * Enables or disables the browsing history
13918 * @param obj The web object
13919 * @param enable Whether to enable or disable the browsing history
13921 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
13923 * Sets the zoom level of the web object
13925 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
13926 * values meaning zoom in and lower meaning zoom out. This function will
13927 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
13928 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
13930 * @param obj The web object
13931 * @param zoom The zoom level to set
13933 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
13935 * Gets the current zoom level set on the web object
13937 * Note that this is the zoom level set on the web object and not that
13938 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
13939 * the two zoom levels should match, but for the other two modes the
13940 * Webkit zoom is calculated internally to match the chosen mode without
13941 * changing the zoom level set for the web object.
13943 * @param obj The web object
13945 * @return The zoom level set on the object
13947 EAPI double elm_web_zoom_get(const Evas_Object *obj);
13949 * Sets the zoom mode to use
13951 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
13952 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
13954 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
13955 * with the elm_web_zoom_set() function.
13956 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
13957 * make sure the entirety of the web object's contents are shown.
13958 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
13959 * fit the contents in the web object's size, without leaving any space
13962 * @param obj The web object
13963 * @param mode The mode to set
13965 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
13967 * Gets the currently set zoom mode
13969 * @param obj The web object
13971 * @return The current zoom mode set for the object, or
13972 * ::ELM_WEB_ZOOM_MODE_LAST on error
13974 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
13976 * Shows the given region in the web object
13978 * @param obj The web object
13979 * @param x The x coordinate of the region to show
13980 * @param y The y coordinate of the region to show
13981 * @param w The width of the region to show
13982 * @param h The height of the region to show
13984 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
13986 * Brings in the region to the visible area
13988 * Like elm_web_region_show(), but it animates the scrolling of the object
13991 * @param obj The web object
13992 * @param x The x coordinate of the region to show
13993 * @param y The y coordinate of the region to show
13994 * @param w The width of the region to show
13995 * @param h The height of the region to show
13997 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
13999 * Sets the default dialogs to use an Inwin instead of a normal window
14001 * If set, then the default implementation for the JavaScript dialogs and
14002 * file selector will be opened in an Inwin. Otherwise they will use a
14003 * normal separated window.
14005 * @param obj The web object
14006 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
14008 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
14010 * Gets whether Inwin mode is set for the current object
14012 * @param obj The web object
14014 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
14016 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
14018 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
14019 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
14020 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);
14021 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
14028 * @defgroup Hoversel Hoversel
14030 * @image html img/widget/hoversel/preview-00.png
14031 * @image latex img/widget/hoversel/preview-00.eps
14033 * A hoversel is a button that pops up a list of items (automatically
14034 * choosing the direction to display) that have a label and, optionally, an
14035 * icon to select from. It is a convenience widget to avoid the need to do
14036 * all the piecing together yourself. It is intended for a small number of
14037 * items in the hoversel menu (no more than 8), though is capable of many
14040 * Signals that you can add callbacks for are:
14041 * "clicked" - the user clicked the hoversel button and popped up the sel
14042 * "selected" - an item in the hoversel list is selected. event_info is the item
14043 * "dismissed" - the hover is dismissed
14045 * See @ref tutorial_hoversel for an example.
14048 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
14050 * @brief Add a new Hoversel object
14052 * @param parent The parent object
14053 * @return The new object or NULL if it cannot be created
14055 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14057 * @brief This sets the hoversel to expand horizontally.
14059 * @param obj The hoversel object
14060 * @param horizontal If true, the hover will expand horizontally to the
14063 * @note The initial button will display horizontally regardless of this
14066 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14068 * @brief This returns whether the hoversel is set to expand horizontally.
14070 * @param obj The hoversel object
14071 * @return If true, the hover will expand horizontally to the right.
14073 * @see elm_hoversel_horizontal_set()
14075 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14077 * @brief Set the Hover parent
14079 * @param obj The hoversel object
14080 * @param parent The parent to use
14082 * Sets the hover parent object, the area that will be darkened when the
14083 * hoversel is clicked. Should probably be the window that the hoversel is
14084 * in. See @ref Hover objects for more information.
14086 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14088 * @brief Get the Hover parent
14090 * @param obj The hoversel object
14091 * @return The used parent
14093 * Gets the hover parent object.
14095 * @see elm_hoversel_hover_parent_set()
14097 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14099 * @brief Set the hoversel button label
14101 * @param obj The hoversel object
14102 * @param label The label text.
14104 * This sets the label of the button that is always visible (before it is
14105 * clicked and expanded).
14107 * @deprecated elm_object_text_set()
14109 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14111 * @brief Get the hoversel button label
14113 * @param obj The hoversel object
14114 * @return The label text.
14116 * @deprecated elm_object_text_get()
14118 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14120 * @brief Set the icon of the hoversel button
14122 * @param obj The hoversel object
14123 * @param icon The icon object
14125 * Sets the icon of the button that is always visible (before it is clicked
14126 * and expanded). Once the icon object is set, a previously set one will be
14127 * deleted, if you want to keep that old content object, use the
14128 * elm_hoversel_icon_unset() function.
14130 * @see elm_object_content_set() for the button widget
14132 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14134 * @brief Get the icon of the hoversel button
14136 * @param obj The hoversel object
14137 * @return The icon object
14139 * Get the icon of the button that is always visible (before it is clicked
14140 * and expanded). Also see elm_object_content_get() for the button widget.
14142 * @see elm_hoversel_icon_set()
14144 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14146 * @brief Get and unparent the icon of the hoversel button
14148 * @param obj The hoversel object
14149 * @return The icon object that was being used
14151 * Unparent and return the icon of the button that is always visible
14152 * (before it is clicked and expanded).
14154 * @see elm_hoversel_icon_set()
14155 * @see elm_object_content_unset() for the button widget
14157 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14159 * @brief This triggers the hoversel popup from code, the same as if the user
14160 * had clicked the button.
14162 * @param obj The hoversel object
14164 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14166 * @brief This dismisses the hoversel popup as if the user had clicked
14167 * outside the hover.
14169 * @param obj The hoversel object
14171 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14173 * @brief Returns whether the hoversel is expanded.
14175 * @param obj The hoversel object
14176 * @return This will return EINA_TRUE if the hoversel is expanded or
14177 * EINA_FALSE if it is not expanded.
14179 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14181 * @brief This will remove all the children items from the hoversel.
14183 * @param obj The hoversel object
14185 * @warning Should @b not be called while the hoversel is active; use
14186 * elm_hoversel_expanded_get() to check first.
14188 * @see elm_hoversel_item_del_cb_set()
14189 * @see elm_hoversel_item_del()
14191 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14193 * @brief Get the list of items within the given hoversel.
14195 * @param obj The hoversel object
14196 * @return Returns a list of Elm_Hoversel_Item*
14198 * @see elm_hoversel_item_add()
14200 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14202 * @brief Add an item to the hoversel button
14204 * @param obj The hoversel object
14205 * @param label The text label to use for the item (NULL if not desired)
14206 * @param icon_file An image file path on disk to use for the icon or standard
14207 * icon name (NULL if not desired)
14208 * @param icon_type The icon type if relevant
14209 * @param func Convenience function to call when this item is selected
14210 * @param data Data to pass to item-related functions
14211 * @return A handle to the item added.
14213 * This adds an item to the hoversel to show when it is clicked. Note: if you
14214 * need to use an icon from an edje file then use
14215 * elm_hoversel_item_icon_set() right after the this function, and set
14216 * icon_file to NULL here.
14218 * For more information on what @p icon_file and @p icon_type are see the
14219 * @ref Icon "icon documentation".
14221 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);
14223 * @brief Delete an item from the hoversel
14225 * @param item The item to delete
14227 * This deletes the item from the hoversel (should not be called while the
14228 * hoversel is active; use elm_hoversel_expanded_get() to check first).
14230 * @see elm_hoversel_item_add()
14231 * @see elm_hoversel_item_del_cb_set()
14233 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14235 * @brief Set the function to be called when an item from the hoversel is
14238 * @param item The item to set the callback on
14239 * @param func The function called
14241 * That function will receive these parameters:
14242 * @li void *item_data
14243 * @li Evas_Object *the_item_object
14244 * @li Elm_Hoversel_Item *the_object_struct
14246 * @see elm_hoversel_item_add()
14248 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14250 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14251 * that will be passed to associated function callbacks.
14253 * @param item The item to get the data from
14254 * @return The data pointer set with elm_hoversel_item_add()
14256 * @see elm_hoversel_item_add()
14258 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14260 * @brief This returns the label text of the given hoversel item.
14262 * @param item The item to get the label
14263 * @return The label text of the hoversel item
14265 * @see elm_hoversel_item_add()
14267 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14269 * @brief This sets the icon for the given hoversel item.
14271 * @param item The item to set the icon
14272 * @param icon_file An image file path on disk to use for the icon or standard
14274 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14275 * to NULL if the icon is not an edje file
14276 * @param icon_type The icon type
14278 * The icon can be loaded from the standard set, from an image file, or from
14281 * @see elm_hoversel_item_add()
14283 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);
14285 * @brief Get the icon object of the hoversel item
14287 * @param item The item to get the icon from
14288 * @param icon_file The image file path on disk used for the icon or standard
14290 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14291 * if the icon is not an edje file
14292 * @param icon_type The icon type
14294 * @see elm_hoversel_item_icon_set()
14295 * @see elm_hoversel_item_add()
14297 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);
14303 * @defgroup Toolbar Toolbar
14304 * @ingroup Elementary
14306 * @image html img/widget/toolbar/preview-00.png
14307 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14309 * @image html img/toolbar.png
14310 * @image latex img/toolbar.eps width=\textwidth
14312 * A toolbar is a widget that displays a list of items inside
14313 * a box. It can be scrollable, show a menu with items that don't fit
14314 * to toolbar size or even crop them.
14316 * Only one item can be selected at a time.
14318 * Items can have multiple states, or show menus when selected by the user.
14320 * Smart callbacks one can listen to:
14321 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14322 * - "language,changed" - when the program language changes
14324 * Available styles for it:
14326 * - @c "transparent" - no background or shadow, just show the content
14328 * List of examples:
14329 * @li @ref toolbar_example_01
14330 * @li @ref toolbar_example_02
14331 * @li @ref toolbar_example_03
14335 * @addtogroup Toolbar
14340 * @enum _Elm_Toolbar_Shrink_Mode
14341 * @typedef Elm_Toolbar_Shrink_Mode
14343 * Set toolbar's items display behavior, it can be scrollabel,
14344 * show a menu with exceeding items, or simply hide them.
14346 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14349 * Values <b> don't </b> work as bitmask, only one can be choosen.
14351 * @see elm_toolbar_mode_shrink_set()
14352 * @see elm_toolbar_mode_shrink_get()
14356 typedef enum _Elm_Toolbar_Shrink_Mode
14358 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
14359 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
14360 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14361 ELM_TOOLBAR_SHRINK_MENU, /**< Inserts a button to pop up a menu with exceeding items. */
14362 ELM_TOOLBAR_SHRINK_LAST /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14363 } Elm_Toolbar_Shrink_Mode;
14365 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(). */
14367 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(). */
14370 * Add a new toolbar widget to the given parent Elementary
14371 * (container) object.
14373 * @param parent The parent object.
14374 * @return a new toolbar widget handle or @c NULL, on errors.
14376 * This function inserts a new toolbar widget on the canvas.
14380 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14383 * Set the icon size, in pixels, to be used by toolbar items.
14385 * @param obj The toolbar object
14386 * @param icon_size The icon size in pixels
14388 * @note Default value is @c 32. It reads value from elm config.
14390 * @see elm_toolbar_icon_size_get()
14394 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14397 * Get the icon size, in pixels, to be used by toolbar items.
14399 * @param obj The toolbar object.
14400 * @return The icon size in pixels.
14402 * @see elm_toolbar_icon_size_set() for details.
14406 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14409 * Sets icon lookup order, for toolbar items' icons.
14411 * @param obj The toolbar object.
14412 * @param order The icon lookup order.
14414 * Icons added before calling this function will not be affected.
14415 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14417 * @see elm_toolbar_icon_order_lookup_get()
14421 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14424 * Gets the icon lookup order.
14426 * @param obj The toolbar object.
14427 * @return The icon lookup order.
14429 * @see elm_toolbar_icon_order_lookup_set() for details.
14433 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14436 * Set whether the toolbar should always have an item selected.
14438 * @param obj The toolbar object.
14439 * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14442 * This will cause the toolbar to always have an item selected, and clicking
14443 * the selected item will not cause a selected event to be emitted. Enabling this mode
14444 * will immediately select the first toolbar item.
14446 * Always-selected is disabled by default.
14448 * @see elm_toolbar_always_select_mode_get().
14452 EAPI void elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14455 * Get whether the toolbar should always have an item selected.
14457 * @param obj The toolbar object.
14458 * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14459 * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14461 * @see elm_toolbar_always_select_mode_set() for details.
14465 EAPI Eina_Bool elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14468 * Set whether the toolbar items' should be selected by the user or not.
14470 * @param obj The toolbar object.
14471 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14474 * This will turn off the ability to select items entirely and they will
14475 * neither appear selected nor emit selected signals. The clicked
14476 * callback function will still be called.
14478 * Selection is enabled by default.
14480 * @see elm_toolbar_no_select_mode_get().
14484 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14487 * Set whether the toolbar items' should be selected by the user or not.
14489 * @param obj The toolbar object.
14490 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14491 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14493 * @see elm_toolbar_no_select_mode_set() for details.
14497 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14500 * Append item to the toolbar.
14502 * @param obj The toolbar object.
14503 * @param icon A string with icon name or the absolute path of an image file.
14504 * @param label The label of the item.
14505 * @param func The function to call when the item is clicked.
14506 * @param data The data to associate with the item for related callbacks.
14507 * @return The created item or @c NULL upon failure.
14509 * A new item will be created and appended to the toolbar, i.e., will
14510 * be set as @b last item.
14512 * Items created with this method can be deleted with
14513 * elm_toolbar_item_del().
14515 * Associated @p data can be properly freed when item is deleted if a
14516 * callback function is set with elm_toolbar_item_del_cb_set().
14518 * If a function is passed as argument, it will be called everytime this item
14519 * is selected, i.e., the user clicks over an unselected item.
14520 * If such function isn't needed, just passing
14521 * @c NULL as @p func is enough. The same should be done for @p data.
14523 * Toolbar will load icon image from fdo or current theme.
14524 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14525 * If an absolute path is provided it will load it direct from a file.
14527 * @see elm_toolbar_item_icon_set()
14528 * @see elm_toolbar_item_del()
14529 * @see elm_toolbar_item_del_cb_set()
14533 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);
14536 * Prepend item to the toolbar.
14538 * @param obj The toolbar object.
14539 * @param icon A string with icon name or the absolute path of an image file.
14540 * @param label The label of the item.
14541 * @param func The function to call when the item is clicked.
14542 * @param data The data to associate with the item for related callbacks.
14543 * @return The created item or @c NULL upon failure.
14545 * A new item will be created and prepended to the toolbar, i.e., will
14546 * be set as @b first item.
14548 * Items created with this method can be deleted with
14549 * elm_toolbar_item_del().
14551 * Associated @p data can be properly freed when item is deleted if a
14552 * callback function is set with elm_toolbar_item_del_cb_set().
14554 * If a function is passed as argument, it will be called everytime this item
14555 * is selected, i.e., the user clicks over an unselected item.
14556 * If such function isn't needed, just passing
14557 * @c NULL as @p func is enough. The same should be done for @p data.
14559 * Toolbar will load icon image from fdo or current theme.
14560 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14561 * If an absolute path is provided it will load it direct from a file.
14563 * @see elm_toolbar_item_icon_set()
14564 * @see elm_toolbar_item_del()
14565 * @see elm_toolbar_item_del_cb_set()
14569 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);
14572 * Insert a new item into the toolbar object before item @p before.
14574 * @param obj The toolbar object.
14575 * @param before The toolbar item to insert before.
14576 * @param icon A string with icon name or the absolute path of an image file.
14577 * @param label The label of the item.
14578 * @param func The function to call when the item is clicked.
14579 * @param data The data to associate with the item for related callbacks.
14580 * @return The created item or @c NULL upon failure.
14582 * A new item will be created and added to the toolbar. Its position in
14583 * this toolbar will be just before item @p before.
14585 * Items created with this method can be deleted with
14586 * elm_toolbar_item_del().
14588 * Associated @p data can be properly freed when item is deleted if a
14589 * callback function is set with elm_toolbar_item_del_cb_set().
14591 * If a function is passed as argument, it will be called everytime this item
14592 * is selected, i.e., the user clicks over an unselected item.
14593 * If such function isn't needed, just passing
14594 * @c NULL as @p func is enough. The same should be done for @p data.
14596 * Toolbar will load icon image from fdo or current theme.
14597 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14598 * If an absolute path is provided it will load it direct from a file.
14600 * @see elm_toolbar_item_icon_set()
14601 * @see elm_toolbar_item_del()
14602 * @see elm_toolbar_item_del_cb_set()
14606 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);
14609 * Insert a new item into the toolbar object after item @p after.
14611 * @param obj The toolbar object.
14612 * @param after The toolbar item to insert after.
14613 * @param icon A string with icon name or the absolute path of an image file.
14614 * @param label The label of the item.
14615 * @param func The function to call when the item is clicked.
14616 * @param data The data to associate with the item for related callbacks.
14617 * @return The created item or @c NULL upon failure.
14619 * A new item will be created and added to the toolbar. Its position in
14620 * this toolbar will be just after item @p after.
14622 * Items created with this method can be deleted with
14623 * elm_toolbar_item_del().
14625 * Associated @p data can be properly freed when item is deleted if a
14626 * callback function is set with elm_toolbar_item_del_cb_set().
14628 * If a function is passed as argument, it will be called everytime this item
14629 * is selected, i.e., the user clicks over an unselected item.
14630 * If such function isn't needed, just passing
14631 * @c NULL as @p func is enough. The same should be done for @p data.
14633 * Toolbar will load icon image from fdo or current theme.
14634 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14635 * If an absolute path is provided it will load it direct from a file.
14637 * @see elm_toolbar_item_icon_set()
14638 * @see elm_toolbar_item_del()
14639 * @see elm_toolbar_item_del_cb_set()
14643 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);
14646 * Get the first item in the given toolbar widget's list of
14649 * @param obj The toolbar object
14650 * @return The first item or @c NULL, if it has no items (and on
14653 * @see elm_toolbar_item_append()
14654 * @see elm_toolbar_last_item_get()
14658 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14661 * Get the last item in the given toolbar widget's list of
14664 * @param obj The toolbar object
14665 * @return The last item or @c NULL, if it has no items (and on
14668 * @see elm_toolbar_item_prepend()
14669 * @see elm_toolbar_first_item_get()
14673 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14676 * Get the item after @p item in toolbar.
14678 * @param item The toolbar item.
14679 * @return The item after @p item, or @c NULL if none or on failure.
14681 * @note If it is the last item, @c NULL will be returned.
14683 * @see elm_toolbar_item_append()
14687 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14690 * Get the item before @p item in toolbar.
14692 * @param item The toolbar item.
14693 * @return The item before @p item, or @c NULL if none or on failure.
14695 * @note If it is the first item, @c NULL will be returned.
14697 * @see elm_toolbar_item_prepend()
14701 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14704 * Get the toolbar object from an item.
14706 * @param item The item.
14707 * @return The toolbar object.
14709 * This returns the toolbar object itself that an item belongs to.
14713 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14716 * Set the priority of a toolbar item.
14718 * @param item The toolbar item.
14719 * @param priority The item priority. The default is zero.
14721 * This is used only when the toolbar shrink mode is set to
14722 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14723 * When space is less than required, items with low priority
14724 * will be removed from the toolbar and added to a dynamically-created menu,
14725 * while items with higher priority will remain on the toolbar,
14726 * with the same order they were added.
14728 * @see elm_toolbar_item_priority_get()
14732 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14735 * Get the priority of a toolbar item.
14737 * @param item The toolbar item.
14738 * @return The @p item priority, or @c 0 on failure.
14740 * @see elm_toolbar_item_priority_set() for details.
14744 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14747 * Get the label of item.
14749 * @param item The item of toolbar.
14750 * @return The label of item.
14752 * The return value is a pointer to the label associated to @p item when
14753 * it was created, with function elm_toolbar_item_append() or similar,
14755 * with function elm_toolbar_item_label_set. If no label
14756 * was passed as argument, it will return @c NULL.
14758 * @see elm_toolbar_item_label_set() for more details.
14759 * @see elm_toolbar_item_append()
14763 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14766 * Set the label of item.
14768 * @param item The item of toolbar.
14769 * @param text The label of item.
14771 * The label to be displayed by the item.
14772 * Label will be placed at icons bottom (if set).
14774 * If a label was passed as argument on item creation, with function
14775 * elm_toolbar_item_append() or similar, it will be already
14776 * displayed by the item.
14778 * @see elm_toolbar_item_label_get()
14779 * @see elm_toolbar_item_append()
14783 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14786 * Return the data associated with a given toolbar widget item.
14788 * @param item The toolbar widget item handle.
14789 * @return The data associated with @p item.
14791 * @see elm_toolbar_item_data_set()
14795 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14798 * Set the data associated with a given toolbar widget item.
14800 * @param item The toolbar widget item handle.
14801 * @param data The new data pointer to set to @p item.
14803 * This sets new item data on @p item.
14805 * @warning The old data pointer won't be touched by this function, so
14806 * the user had better to free that old data himself/herself.
14810 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14813 * Returns a pointer to a toolbar item by its label.
14815 * @param obj The toolbar object.
14816 * @param label The label of the item to find.
14818 * @return The pointer to the toolbar item matching @p label or @c NULL
14823 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14826 * Get whether the @p item is selected or not.
14828 * @param item The toolbar item.
14829 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14830 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14832 * @see elm_toolbar_selected_item_set() for details.
14833 * @see elm_toolbar_item_selected_get()
14837 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14840 * Set the selected state of an item.
14842 * @param item The toolbar item
14843 * @param selected The selected state
14845 * This sets the selected state of the given item @p it.
14846 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14848 * If a new item is selected the previosly selected will be unselected.
14849 * Previoulsy selected item can be get with function
14850 * elm_toolbar_selected_item_get().
14852 * Selected items will be highlighted.
14854 * @see elm_toolbar_item_selected_get()
14855 * @see elm_toolbar_selected_item_get()
14859 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14862 * Get the selected item.
14864 * @param obj The toolbar object.
14865 * @return The selected toolbar item.
14867 * The selected item can be unselected with function
14868 * elm_toolbar_item_selected_set().
14870 * The selected item always will be highlighted on toolbar.
14872 * @see elm_toolbar_selected_items_get()
14876 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14879 * Set the icon associated with @p item.
14881 * @param obj The parent of this item.
14882 * @param item The toolbar item.
14883 * @param icon A string with icon name or the absolute path of an image file.
14885 * Toolbar will load icon image from fdo or current theme.
14886 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14887 * If an absolute path is provided it will load it direct from a file.
14889 * @see elm_toolbar_icon_order_lookup_set()
14890 * @see elm_toolbar_icon_order_lookup_get()
14894 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
14897 * Get the string used to set the icon of @p item.
14899 * @param item The toolbar item.
14900 * @return The string associated with the icon object.
14902 * @see elm_toolbar_item_icon_set() for details.
14906 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14909 * Get the object of @p item.
14911 * @param item The toolbar item.
14912 * @return The object
14916 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14919 * Get the icon object of @p item.
14921 * @param item The toolbar item.
14922 * @return The icon object
14924 * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
14928 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14931 * Set the icon associated with @p item to an image in a binary buffer.
14933 * @param item The toolbar item.
14934 * @param img The binary data that will be used as an image
14935 * @param size The size of binary data @p img
14936 * @param format Optional format of @p img to pass to the image loader
14937 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
14939 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
14941 * @note The icon image set by this function can be changed by
14942 * elm_toolbar_item_icon_set().
14946 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);
14949 * Delete them item from the toolbar.
14951 * @param item The item of toolbar to be deleted.
14953 * @see elm_toolbar_item_append()
14954 * @see elm_toolbar_item_del_cb_set()
14958 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14961 * Set the function called when a toolbar item is freed.
14963 * @param item The item to set the callback on.
14964 * @param func The function called.
14966 * If there is a @p func, then it will be called prior item's memory release.
14967 * That will be called with the following arguments:
14969 * @li item's Evas object;
14972 * This way, a data associated to a toolbar item could be properly freed.
14976 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14979 * Get a value whether toolbar item is disabled or not.
14981 * @param item The item.
14982 * @return The disabled state.
14984 * @see elm_toolbar_item_disabled_set() for more details.
14988 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14991 * Sets the disabled/enabled state of a toolbar item.
14993 * @param item The item.
14994 * @param disabled The disabled state.
14996 * A disabled item cannot be selected or unselected. It will also
14997 * change its appearance (generally greyed out). This sets the
14998 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15003 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15006 * Set or unset item as a separator.
15008 * @param item The toolbar item.
15009 * @param setting @c EINA_TRUE to set item @p item as separator or
15010 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15012 * Items aren't set as separator by default.
15014 * If set as separator it will display separator theme, so won't display
15017 * @see elm_toolbar_item_separator_get()
15021 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
15024 * Get a value whether item is a separator or not.
15026 * @param item The toolbar item.
15027 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15028 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15030 * @see elm_toolbar_item_separator_set() for details.
15034 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15037 * Set the shrink state of toolbar @p obj.
15039 * @param obj The toolbar object.
15040 * @param shrink_mode Toolbar's items display behavior.
15042 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
15043 * but will enforce a minimun size so all the items will fit, won't scroll
15044 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
15045 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
15046 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
15050 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15053 * Get the shrink mode of toolbar @p obj.
15055 * @param obj The toolbar object.
15056 * @return Toolbar's items display behavior.
15058 * @see elm_toolbar_mode_shrink_set() for details.
15062 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15065 * Enable/disable homogenous mode.
15067 * @param obj The toolbar object
15068 * @param homogeneous Assume the items within the toolbar are of the
15069 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15071 * This will enable the homogeneous mode where items are of the same size.
15072 * @see elm_toolbar_homogeneous_get()
15076 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15079 * Get whether the homogenous mode is enabled.
15081 * @param obj The toolbar object.
15082 * @return Assume the items within the toolbar are of the same height
15083 * and width (EINA_TRUE = on, EINA_FALSE = off).
15085 * @see elm_toolbar_homogeneous_set()
15089 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15092 * Enable/disable homogenous mode.
15094 * @param obj The toolbar object
15095 * @param homogeneous Assume the items within the toolbar are of the
15096 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15098 * This will enable the homogeneous mode where items are of the same size.
15099 * @see elm_toolbar_homogeneous_get()
15101 * @deprecated use elm_toolbar_homogeneous_set() instead.
15105 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
15108 * Get whether the homogenous mode is enabled.
15110 * @param obj The toolbar object.
15111 * @return Assume the items within the toolbar are of the same height
15112 * and width (EINA_TRUE = on, EINA_FALSE = off).
15114 * @see elm_toolbar_homogeneous_set()
15115 * @deprecated use elm_toolbar_homogeneous_get() instead.
15119 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15122 * Set the parent object of the toolbar items' menus.
15124 * @param obj The toolbar object.
15125 * @param parent The parent of the menu objects.
15127 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15129 * For more details about setting the parent for toolbar menus, see
15130 * elm_menu_parent_set().
15132 * @see elm_menu_parent_set() for details.
15133 * @see elm_toolbar_item_menu_set() for details.
15137 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15140 * Get the parent object of the toolbar items' menus.
15142 * @param obj The toolbar object.
15143 * @return The parent of the menu objects.
15145 * @see elm_toolbar_menu_parent_set() for details.
15149 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15152 * Set the alignment of the items.
15154 * @param obj The toolbar object.
15155 * @param align The new alignment, a float between <tt> 0.0 </tt>
15156 * and <tt> 1.0 </tt>.
15158 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15159 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15162 * Centered items by default.
15164 * @see elm_toolbar_align_get()
15168 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15171 * Get the alignment of the items.
15173 * @param obj The toolbar object.
15174 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15177 * @see elm_toolbar_align_set() for details.
15181 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15184 * Set whether the toolbar item opens a menu.
15186 * @param item The toolbar item.
15187 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15189 * A toolbar item can be set to be a menu, using this function.
15191 * Once it is set to be a menu, it can be manipulated through the
15192 * menu-like function elm_toolbar_menu_parent_set() and the other
15193 * elm_menu functions, using the Evas_Object @c menu returned by
15194 * elm_toolbar_item_menu_get().
15196 * So, items to be displayed in this item's menu should be added with
15197 * elm_menu_item_add().
15199 * The following code exemplifies the most basic usage:
15201 * tb = elm_toolbar_add(win)
15202 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15203 * elm_toolbar_item_menu_set(item, EINA_TRUE);
15204 * elm_toolbar_menu_parent_set(tb, win);
15205 * menu = elm_toolbar_item_menu_get(item);
15206 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15207 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15211 * @see elm_toolbar_item_menu_get()
15215 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15218 * Get toolbar item's menu.
15220 * @param item The toolbar item.
15221 * @return Item's menu object or @c NULL on failure.
15223 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15224 * this function will set it.
15226 * @see elm_toolbar_item_menu_set() for details.
15230 EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15233 * Add a new state to @p item.
15235 * @param item The item.
15236 * @param icon A string with icon name or the absolute path of an image file.
15237 * @param label The label of the new state.
15238 * @param func The function to call when the item is clicked when this
15239 * state is selected.
15240 * @param data The data to associate with the state.
15241 * @return The toolbar item state, or @c NULL upon failure.
15243 * Toolbar will load icon image from fdo or current theme.
15244 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15245 * If an absolute path is provided it will load it direct from a file.
15247 * States created with this function can be removed with
15248 * elm_toolbar_item_state_del().
15250 * @see elm_toolbar_item_state_del()
15251 * @see elm_toolbar_item_state_sel()
15252 * @see elm_toolbar_item_state_get()
15256 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);
15259 * Delete a previoulsy added state to @p item.
15261 * @param item The toolbar item.
15262 * @param state The state to be deleted.
15263 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15265 * @see elm_toolbar_item_state_add()
15267 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15270 * Set @p state as the current state of @p it.
15272 * @param it The item.
15273 * @param state The state to use.
15274 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15276 * If @p state is @c NULL, it won't select any state and the default item's
15277 * icon and label will be used. It's the same behaviour than
15278 * elm_toolbar_item_state_unser().
15280 * @see elm_toolbar_item_state_unset()
15284 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15287 * Unset the state of @p it.
15289 * @param it The item.
15291 * The default icon and label from this item will be displayed.
15293 * @see elm_toolbar_item_state_set() for more details.
15297 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15300 * Get the current state of @p it.
15302 * @param item The item.
15303 * @return The selected state or @c NULL if none is selected or on failure.
15305 * @see elm_toolbar_item_state_set() for details.
15306 * @see elm_toolbar_item_state_unset()
15307 * @see elm_toolbar_item_state_add()
15311 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15314 * Get the state after selected state in toolbar's @p item.
15316 * @param it The toolbar item to change state.
15317 * @return The state after current state, or @c NULL on failure.
15319 * If last state is selected, this function will return first state.
15321 * @see elm_toolbar_item_state_set()
15322 * @see elm_toolbar_item_state_add()
15326 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15329 * Get the state before selected state in toolbar's @p item.
15331 * @param it The toolbar item to change state.
15332 * @return The state before current state, or @c NULL on failure.
15334 * If first state is selected, this function will return last state.
15336 * @see elm_toolbar_item_state_set()
15337 * @see elm_toolbar_item_state_add()
15341 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15344 * Set the text to be shown in a given toolbar item's tooltips.
15346 * @param item Target item.
15347 * @param text The text to set in the content.
15349 * Setup the text as tooltip to object. The item can have only one tooltip,
15350 * so any previous tooltip data - set with this function or
15351 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15353 * @see elm_object_tooltip_text_set() for more details.
15357 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15360 * Set the content to be shown in the tooltip item.
15362 * Setup the tooltip to item. The item can have only one tooltip,
15363 * so any previous tooltip data is removed. @p func(with @p data) will
15364 * be called every time that need show the tooltip and it should
15365 * return a valid Evas_Object. This object is then managed fully by
15366 * tooltip system and is deleted when the tooltip is gone.
15368 * @param item the toolbar item being attached a tooltip.
15369 * @param func the function used to create the tooltip contents.
15370 * @param data what to provide to @a func as callback data/context.
15371 * @param del_cb called when data is not needed anymore, either when
15372 * another callback replaces @a func, the tooltip is unset with
15373 * elm_toolbar_item_tooltip_unset() or the owner @a item
15374 * dies. This callback receives as the first parameter the
15375 * given @a data, and @c event_info is the item.
15377 * @see elm_object_tooltip_content_cb_set() for more details.
15381 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);
15384 * Unset tooltip from item.
15386 * @param item toolbar item to remove previously set tooltip.
15388 * Remove tooltip from item. The callback provided as del_cb to
15389 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15390 * it is not used anymore.
15392 * @see elm_object_tooltip_unset() for more details.
15393 * @see elm_toolbar_item_tooltip_content_cb_set()
15397 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15400 * Sets a different style for this item tooltip.
15402 * @note before you set a style you should define a tooltip with
15403 * elm_toolbar_item_tooltip_content_cb_set() or
15404 * elm_toolbar_item_tooltip_text_set()
15406 * @param item toolbar item with tooltip already set.
15407 * @param style the theme style to use (default, transparent, ...)
15409 * @see elm_object_tooltip_style_set() for more details.
15413 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15416 * Get the style for this item tooltip.
15418 * @param item toolbar item with tooltip already set.
15419 * @return style the theme style in use, defaults to "default". If the
15420 * object does not have a tooltip set, then NULL is returned.
15422 * @see elm_object_tooltip_style_get() for more details.
15423 * @see elm_toolbar_item_tooltip_style_set()
15427 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15430 * Set the type of mouse pointer/cursor decoration to be shown,
15431 * when the mouse pointer is over the given toolbar widget item
15433 * @param item toolbar item to customize cursor on
15434 * @param cursor the cursor type's name
15436 * This function works analogously as elm_object_cursor_set(), but
15437 * here the cursor's changing area is restricted to the item's
15438 * area, and not the whole widget's. Note that that item cursors
15439 * have precedence over widget cursors, so that a mouse over an
15440 * item with custom cursor set will always show @b that cursor.
15442 * If this function is called twice for an object, a previously set
15443 * cursor will be unset on the second call.
15445 * @see elm_object_cursor_set()
15446 * @see elm_toolbar_item_cursor_get()
15447 * @see elm_toolbar_item_cursor_unset()
15451 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15454 * Get the type of mouse pointer/cursor decoration set to be shown,
15455 * when the mouse pointer is over the given toolbar widget item
15457 * @param item toolbar item with custom cursor set
15458 * @return the cursor type's name or @c NULL, if no custom cursors
15459 * were set to @p item (and on errors)
15461 * @see elm_object_cursor_get()
15462 * @see elm_toolbar_item_cursor_set()
15463 * @see elm_toolbar_item_cursor_unset()
15467 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15470 * Unset any custom mouse pointer/cursor decoration set to be
15471 * shown, when the mouse pointer is over the given toolbar widget
15472 * item, thus making it show the @b default cursor again.
15474 * @param item a toolbar item
15476 * Use this call to undo any custom settings on this item's cursor
15477 * decoration, bringing it back to defaults (no custom style set).
15479 * @see elm_object_cursor_unset()
15480 * @see elm_toolbar_item_cursor_set()
15484 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15487 * Set a different @b style for a given custom cursor set for a
15490 * @param item toolbar item with custom cursor set
15491 * @param style the <b>theme style</b> to use (e.g. @c "default",
15492 * @c "transparent", etc)
15494 * This function only makes sense when one is using custom mouse
15495 * cursor decorations <b>defined in a theme file</b>, which can have,
15496 * given a cursor name/type, <b>alternate styles</b> on it. It
15497 * works analogously as elm_object_cursor_style_set(), but here
15498 * applyed only to toolbar item objects.
15500 * @warning Before you set a cursor style you should have definen a
15501 * custom cursor previously on the item, with
15502 * elm_toolbar_item_cursor_set()
15504 * @see elm_toolbar_item_cursor_engine_only_set()
15505 * @see elm_toolbar_item_cursor_style_get()
15509 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15512 * Get the current @b style set for a given toolbar item's custom
15515 * @param item toolbar item with custom cursor set.
15516 * @return style the cursor style in use. If the object does not
15517 * have a cursor set, then @c NULL is returned.
15519 * @see elm_toolbar_item_cursor_style_set() for more details
15523 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15526 * Set if the (custom)cursor for a given toolbar item should be
15527 * searched in its theme, also, or should only rely on the
15528 * rendering engine.
15530 * @param item item with custom (custom) cursor already set on
15531 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15532 * only on those provided by the rendering engine, @c EINA_FALSE to
15533 * have them searched on the widget's theme, as well.
15535 * @note This call is of use only if you've set a custom cursor
15536 * for toolbar items, with elm_toolbar_item_cursor_set().
15538 * @note By default, cursors will only be looked for between those
15539 * provided by the rendering engine.
15543 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15546 * Get if the (custom) cursor for a given toolbar item is being
15547 * searched in its theme, also, or is only relying on the rendering
15550 * @param item a toolbar item
15551 * @return @c EINA_TRUE, if cursors are being looked for only on
15552 * those provided by the rendering engine, @c EINA_FALSE if they
15553 * are being searched on the widget's theme, as well.
15555 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15559 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15562 * Change a toolbar's orientation
15563 * @param obj The toolbar object
15564 * @param vertical If @c EINA_TRUE, the toolbar is vertical
15565 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15567 * @deprecated use elm_toolbar_horizontal_set() instead.
15569 EINA_DEPRECATED EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15572 * Change a toolbar's orientation
15573 * @param obj The toolbar object
15574 * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15575 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15578 EAPI void elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15581 * Get a toolbar's orientation
15582 * @param obj The toolbar object
15583 * @return If @c EINA_TRUE, the toolbar is vertical
15584 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15586 * @deprecated use elm_toolbar_horizontal_get() instead.
15588 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15591 * Get a toolbar's orientation
15592 * @param obj The toolbar object
15593 * @return If @c EINA_TRUE, the toolbar is horizontal
15594 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15597 EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15603 * @defgroup Tooltips Tooltips
15605 * The Tooltip is an (internal, for now) smart object used to show a
15606 * content in a frame on mouse hover of objects(or widgets), with
15607 * tips/information about them.
15612 EAPI double elm_tooltip_delay_get(void);
15613 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
15614 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15615 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15616 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15617 EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15618 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15619 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);
15620 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15621 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15622 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15625 * @defgroup Cursors Cursors
15627 * The Elementary cursor is an internal smart object used to
15628 * customize the mouse cursor displayed over objects (or
15629 * widgets). In the most common scenario, the cursor decoration
15630 * comes from the graphical @b engine Elementary is running
15631 * on. Those engines may provide different decorations for cursors,
15632 * and Elementary provides functions to choose them (think of X11
15633 * cursors, as an example).
15635 * There's also the possibility of, besides using engine provided
15636 * cursors, also use ones coming from Edje theming files. Both
15637 * globally and per widget, Elementary makes it possible for one to
15638 * make the cursors lookup to be held on engines only or on
15639 * Elementary's theme file, too. To set cursor's hot spot,
15640 * two data items should be added to cursor's theme: "hot_x" and
15641 * "hot_y", that are the offset from upper-left corner of the cursor
15642 * (coordinates 0,0).
15648 * Set the cursor to be shown when mouse is over the object
15650 * Set the cursor that will be displayed when mouse is over the
15651 * object. The object can have only one cursor set to it, so if
15652 * this function is called twice for an object, the previous set
15654 * If using X cursors, a definition of all the valid cursor names
15655 * is listed on Elementary_Cursors.h. If an invalid name is set
15656 * the default cursor will be used.
15658 * @param obj the object being set a cursor.
15659 * @param cursor the cursor name to be used.
15663 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15666 * Get the cursor to be shown when mouse is over the object
15668 * @param obj an object with cursor already set.
15669 * @return the cursor name.
15673 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15676 * Unset cursor for object
15678 * Unset cursor for object, and set the cursor to default if the mouse
15679 * was over this object.
15681 * @param obj Target object
15682 * @see elm_object_cursor_set()
15686 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15689 * Sets a different style for this object cursor.
15691 * @note before you set a style you should define a cursor with
15692 * elm_object_cursor_set()
15694 * @param obj an object with cursor already set.
15695 * @param style the theme style to use (default, transparent, ...)
15699 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15702 * Get the style for this object cursor.
15704 * @param obj an object with cursor already set.
15705 * @return style the theme style in use, defaults to "default". If the
15706 * object does not have a cursor set, then NULL is returned.
15710 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15713 * Set if the cursor set should be searched on the theme or should use
15714 * the provided by the engine, only.
15716 * @note before you set if should look on theme you should define a cursor
15717 * with elm_object_cursor_set(). By default it will only look for cursors
15718 * provided by the engine.
15720 * @param obj an object with cursor already set.
15721 * @param engine_only boolean to define it cursors should be looked only
15722 * between the provided by the engine or searched on widget's theme as well.
15726 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15729 * Get the cursor engine only usage for this object cursor.
15731 * @param obj an object with cursor already set.
15732 * @return engine_only boolean to define it cursors should be
15733 * looked only between the provided by the engine or searched on
15734 * widget's theme as well. If the object does not have a cursor
15735 * set, then EINA_FALSE is returned.
15739 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15742 * Get the configured cursor engine only usage
15744 * This gets the globally configured exclusive usage of engine cursors.
15746 * @return 1 if only engine cursors should be used
15749 EAPI int elm_cursor_engine_only_get(void);
15752 * Set the configured cursor engine only usage
15754 * This sets the globally configured exclusive usage of engine cursors.
15755 * It won't affect cursors set before changing this value.
15757 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15758 * look for them on theme before.
15759 * @return EINA_TRUE if value is valid and setted (0 or 1)
15762 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
15769 * @defgroup Menu Menu
15771 * @image html img/widget/menu/preview-00.png
15772 * @image latex img/widget/menu/preview-00.eps
15774 * A menu is a list of items displayed above its parent. When the menu is
15775 * showing its parent is darkened. Each item can have a sub-menu. The menu
15776 * object can be used to display a menu on a right click event, in a toolbar,
15779 * Signals that you can add callbacks for are:
15780 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15781 * event_info is NULL.
15783 * @see @ref tutorial_menu
15786 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15788 * @brief Add a new menu to the parent
15790 * @param parent The parent object.
15791 * @return The new object or NULL if it cannot be created.
15793 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15795 * @brief Set the parent for the given menu widget
15797 * @param obj The menu object.
15798 * @param parent The new parent.
15800 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15802 * @brief Get the parent for the given menu widget
15804 * @param obj The menu object.
15805 * @return The parent.
15807 * @see elm_menu_parent_set()
15809 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15811 * @brief Move the menu to a new position
15813 * @param obj The menu object.
15814 * @param x The new position.
15815 * @param y The new position.
15817 * Sets the top-left position of the menu to (@p x,@p y).
15819 * @note @p x and @p y coordinates are relative to parent.
15821 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15823 * @brief Close a opened menu
15825 * @param obj the menu object
15828 * Hides the menu and all it's sub-menus.
15830 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15832 * @brief Returns a list of @p item's items.
15834 * @param obj The menu object
15835 * @return An Eina_List* of @p item's items
15837 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15839 * @brief Get the Evas_Object of an Elm_Menu_Item
15841 * @param item The menu item object.
15842 * @return The edje object containing the swallowed content
15844 * @warning Don't manipulate this object!
15846 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15848 * @brief Add an item at the end of the given menu widget
15850 * @param obj The menu object.
15851 * @param parent The parent menu item (optional)
15852 * @param icon A icon display on the item. The icon will be destryed by the menu.
15853 * @param label The label of the item.
15854 * @param func Function called when the user select the item.
15855 * @param data Data sent by the callback.
15856 * @return Returns the new item.
15858 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);
15860 * @brief Add an object swallowed in an item at the end of the given menu
15863 * @param obj The menu object.
15864 * @param parent The parent menu item (optional)
15865 * @param subobj The object to swallow
15866 * @param func Function called when the user select the item.
15867 * @param data Data sent by the callback.
15868 * @return Returns the new item.
15870 * Add an evas object as an item to the menu.
15872 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);
15874 * @brief Set the label of a menu item
15876 * @param item The menu item object.
15877 * @param label The label to set for @p item
15879 * @warning Don't use this funcion on items created with
15880 * elm_menu_item_add_object() or elm_menu_item_separator_add().
15882 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15884 * @brief Get the label of a menu item
15886 * @param item The menu item object.
15887 * @return The label of @p item
15889 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15891 * @brief Set the icon of a menu item to the standard icon with name @p icon
15893 * @param item The menu item object.
15894 * @param icon The icon object to set for the content of @p item
15896 * Once this icon is set, any previously set icon will be deleted.
15898 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
15900 * @brief Get the string representation from the icon of a menu item
15902 * @param item The menu item object.
15903 * @return The string representation of @p item's icon or NULL
15905 * @see elm_menu_item_object_icon_name_set()
15907 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15909 * @brief Set the content object of a menu item
15911 * @param item The menu item object
15912 * @param The content object or NULL
15913 * @return EINA_TRUE on success, else EINA_FALSE
15915 * Use this function to change the object swallowed by a menu item, deleting
15916 * any previously swallowed object.
15918 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
15920 * @brief Get the content object of a menu item
15922 * @param item The menu item object
15923 * @return The content object or NULL
15924 * @note If @p item was added with elm_menu_item_add_object, this
15925 * function will return the object passed, else it will return the
15928 * @see elm_menu_item_object_content_set()
15930 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15932 EINA_DEPRECATED extern inline void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2)
15934 elm_menu_item_object_icon_name_set(item, icon);
15937 EINA_DEPRECATED extern inline Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1)
15939 return elm_menu_item_object_content_get(item);
15942 EINA_DEPRECATED extern inline const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1)
15944 return elm_menu_item_object_icon_name_get(item);
15948 * @brief Set the selected state of @p item.
15950 * @param item The menu item object.
15951 * @param selected The selected/unselected state of the item
15953 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15955 * @brief Get the selected state of @p item.
15957 * @param item The menu item object.
15958 * @return The selected/unselected state of the item
15960 * @see elm_menu_item_selected_set()
15962 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15964 * @brief Set the disabled state of @p item.
15966 * @param item The menu item object.
15967 * @param disabled The enabled/disabled state of the item
15969 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15971 * @brief Get the disabled state of @p item.
15973 * @param item The menu item object.
15974 * @return The enabled/disabled state of the item
15976 * @see elm_menu_item_disabled_set()
15978 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15980 * @brief Add a separator item to menu @p obj under @p parent.
15982 * @param obj The menu object
15983 * @param parent The item to add the separator under
15984 * @return The created item or NULL on failure
15986 * This is item is a @ref Separator.
15988 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
15990 * @brief Returns whether @p item is a separator.
15992 * @param item The item to check
15993 * @return If true, @p item is a separator
15995 * @see elm_menu_item_separator_add()
15997 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15999 * @brief Deletes an item from the menu.
16001 * @param item The item to delete.
16003 * @see elm_menu_item_add()
16005 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16007 * @brief Set the function called when a menu item is deleted.
16009 * @param item The item to set the callback on
16010 * @param func The function called
16012 * @see elm_menu_item_add()
16013 * @see elm_menu_item_del()
16015 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16017 * @brief Returns the data associated with menu item @p item.
16019 * @param item The item
16020 * @return The data associated with @p item or NULL if none was set.
16022 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
16024 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16026 * @brief Sets the data to be associated with menu item @p item.
16028 * @param item The item
16029 * @param data The data to be associated with @p item
16031 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
16033 * @brief Returns a list of @p item's subitems.
16035 * @param item The item
16036 * @return An Eina_List* of @p item's subitems
16038 * @see elm_menu_add()
16040 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16041 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16042 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16043 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16044 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16045 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16046 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16053 * @defgroup List List
16054 * @ingroup Elementary
16056 * @image html img/widget/list/preview-00.png
16057 * @image latex img/widget/list/preview-00.eps width=\textwidth
16059 * @image html img/list.png
16060 * @image latex img/list.eps width=\textwidth
16062 * A list widget is a container whose children are displayed vertically or
16063 * horizontally, in order, and can be selected.
16064 * The list can accept only one or multiple items selection. Also has many
16065 * modes of items displaying.
16067 * A list is a very simple type of list widget. For more robust
16068 * lists, @ref Genlist should probably be used.
16070 * Smart callbacks one can listen to:
16071 * - @c "activated" - The user has double-clicked or pressed
16072 * (enter|return|spacebar) on an item. The @c event_info parameter
16073 * is the item that was activated.
16074 * - @c "clicked,double" - The user has double-clicked an item.
16075 * The @c event_info parameter is the item that was double-clicked.
16076 * - "selected" - when the user selected an item
16077 * - "unselected" - when the user unselected an item
16078 * - "longpressed" - an item in the list is long-pressed
16079 * - "edge,top" - the list is scrolled until the top edge
16080 * - "edge,bottom" - the list is scrolled until the bottom edge
16081 * - "edge,left" - the list is scrolled until the left edge
16082 * - "edge,right" - the list is scrolled until the right edge
16083 * - "language,changed" - the program's language changed
16085 * Available styles for it:
16088 * List of examples:
16089 * @li @ref list_example_01
16090 * @li @ref list_example_02
16091 * @li @ref list_example_03
16100 * @enum _Elm_List_Mode
16101 * @typedef Elm_List_Mode
16103 * Set list's resize behavior, transverse axis scroll and
16104 * items cropping. See each mode's description for more details.
16106 * @note Default value is #ELM_LIST_SCROLL.
16108 * Values <b> don't </b> work as bitmask, only one can be choosen.
16110 * @see elm_list_mode_set()
16111 * @see elm_list_mode_get()
16115 typedef enum _Elm_List_Mode
16117 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. */
16118 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). */
16119 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. */
16120 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. */
16121 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16124 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(). */
16127 * Add a new list widget to the given parent Elementary
16128 * (container) object.
16130 * @param parent The parent object.
16131 * @return a new list widget handle or @c NULL, on errors.
16133 * This function inserts a new list widget on the canvas.
16137 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16142 * @param obj The list object
16144 * @note Call before running show() on the list object.
16145 * @warning If not called, it won't display the list properly.
16148 * li = elm_list_add(win);
16149 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16150 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16152 * evas_object_show(li);
16157 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16160 * Enable or disable multiple items selection on the list object.
16162 * @param obj The list object
16163 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16166 * Disabled by default. If disabled, the user can select a single item of
16167 * the list each time. Selected items are highlighted on list.
16168 * If enabled, many items can be selected.
16170 * If a selected item is selected again, it will be unselected.
16172 * @see elm_list_multi_select_get()
16176 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16179 * Get a value whether multiple items selection is enabled or not.
16181 * @see elm_list_multi_select_set() for details.
16183 * @param obj The list object.
16184 * @return @c EINA_TRUE means multiple items selection is enabled.
16185 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16186 * @c EINA_FALSE is returned.
16190 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16193 * Set which mode to use for the list object.
16195 * @param obj The list object
16196 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16197 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16199 * Set list's resize behavior, transverse axis scroll and
16200 * items cropping. See each mode's description for more details.
16202 * @note Default value is #ELM_LIST_SCROLL.
16204 * Only one can be set, if a previous one was set, it will be changed
16205 * by the new mode set. Bitmask won't work as well.
16207 * @see elm_list_mode_get()
16211 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16214 * Get the mode the list is at.
16216 * @param obj The list object
16217 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16218 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16220 * @note see elm_list_mode_set() for more information.
16224 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16227 * Enable or disable horizontal mode on the list object.
16229 * @param obj The list object.
16230 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16231 * disable it, i.e., to enable vertical mode.
16233 * @note Vertical mode is set by default.
16235 * On horizontal mode items are displayed on list from left to right,
16236 * instead of from top to bottom. Also, the list will scroll horizontally.
16237 * Each item will presents left icon on top and right icon, or end, at
16240 * @see elm_list_horizontal_get()
16244 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16247 * Get a value whether horizontal mode is enabled or not.
16249 * @param obj The list object.
16250 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16251 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16252 * @c EINA_FALSE is returned.
16254 * @see elm_list_horizontal_set() for details.
16258 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16261 * Enable or disable always select mode on the list object.
16263 * @param obj The list object
16264 * @param always_select @c EINA_TRUE to enable always select mode or
16265 * @c EINA_FALSE to disable it.
16267 * @note Always select mode is disabled by default.
16269 * Default behavior of list items is to only call its callback function
16270 * the first time it's pressed, i.e., when it is selected. If a selected
16271 * item is pressed again, and multi-select is disabled, it won't call
16272 * this function (if multi-select is enabled it will unselect the item).
16274 * If always select is enabled, it will call the callback function
16275 * everytime a item is pressed, so it will call when the item is selected,
16276 * and again when a selected item is pressed.
16278 * @see elm_list_always_select_mode_get()
16279 * @see elm_list_multi_select_set()
16283 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16286 * Get a value whether always select mode is enabled or not, meaning that
16287 * an item will always call its callback function, even if already selected.
16289 * @param obj The list object
16290 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16291 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16292 * @c EINA_FALSE is returned.
16294 * @see elm_list_always_select_mode_set() for details.
16298 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16301 * Set bouncing behaviour when the scrolled content reaches an edge.
16303 * Tell the internal scroller object whether it should bounce or not
16304 * when it reaches the respective edges for each axis.
16306 * @param obj The list object
16307 * @param h_bounce Whether to bounce or not in the horizontal axis.
16308 * @param v_bounce Whether to bounce or not in the vertical axis.
16310 * @see elm_scroller_bounce_set()
16314 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16317 * Get the bouncing behaviour of the internal scroller.
16319 * Get whether the internal scroller should bounce when the edge of each
16320 * axis is reached scrolling.
16322 * @param obj The list object.
16323 * @param h_bounce Pointer where to store the bounce state of the horizontal
16325 * @param v_bounce Pointer where to store the bounce state of the vertical
16328 * @see elm_scroller_bounce_get()
16329 * @see elm_list_bounce_set()
16333 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16336 * Set the scrollbar policy.
16338 * @param obj The list object
16339 * @param policy_h Horizontal scrollbar policy.
16340 * @param policy_v Vertical scrollbar policy.
16342 * This sets the scrollbar visibility policy for the given scroller.
16343 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16344 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16345 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16346 * This applies respectively for the horizontal and vertical scrollbars.
16348 * The both are disabled by default, i.e., are set to
16349 * #ELM_SCROLLER_POLICY_OFF.
16353 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16356 * Get the scrollbar policy.
16358 * @see elm_list_scroller_policy_get() for details.
16360 * @param obj The list object.
16361 * @param policy_h Pointer where to store horizontal scrollbar policy.
16362 * @param policy_v Pointer where to store vertical scrollbar policy.
16366 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);
16369 * Append a new item to the list object.
16371 * @param obj The list object.
16372 * @param label The label of the list item.
16373 * @param icon The icon object to use for the left side of the item. An
16374 * icon can be any Evas object, but usually it is an icon created
16375 * with elm_icon_add().
16376 * @param end The icon object to use for the right side of the item. An
16377 * icon can be any Evas object.
16378 * @param func The function to call when the item is clicked.
16379 * @param data The data to associate with the item for related callbacks.
16381 * @return The created item or @c NULL upon failure.
16383 * A new item will be created and appended to the list, i.e., will
16384 * be set as @b last item.
16386 * Items created with this method can be deleted with
16387 * elm_list_item_del().
16389 * Associated @p data can be properly freed when item is deleted if a
16390 * callback function is set with elm_list_item_del_cb_set().
16392 * If a function is passed as argument, it will be called everytime this item
16393 * is selected, i.e., the user clicks over an unselected item.
16394 * If always select is enabled it will call this function every time
16395 * user clicks over an item (already selected or not).
16396 * If such function isn't needed, just passing
16397 * @c NULL as @p func is enough. The same should be done for @p data.
16399 * Simple example (with no function callback or data associated):
16401 * li = elm_list_add(win);
16402 * ic = elm_icon_add(win);
16403 * elm_icon_file_set(ic, "path/to/image", NULL);
16404 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16405 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16407 * evas_object_show(li);
16410 * @see elm_list_always_select_mode_set()
16411 * @see elm_list_item_del()
16412 * @see elm_list_item_del_cb_set()
16413 * @see elm_list_clear()
16414 * @see elm_icon_add()
16418 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);
16421 * Prepend a new item to the list object.
16423 * @param obj The list object.
16424 * @param label The label of the list item.
16425 * @param icon The icon object to use for the left side of the item. An
16426 * icon can be any Evas object, but usually it is an icon created
16427 * with elm_icon_add().
16428 * @param end The icon object to use for the right side of the item. An
16429 * icon can be any Evas object.
16430 * @param func The function to call when the item is clicked.
16431 * @param data The data to associate with the item for related callbacks.
16433 * @return The created item or @c NULL upon failure.
16435 * A new item will be created and prepended to the list, i.e., will
16436 * be set as @b first item.
16438 * Items created with this method can be deleted with
16439 * elm_list_item_del().
16441 * Associated @p data can be properly freed when item is deleted if a
16442 * callback function is set with elm_list_item_del_cb_set().
16444 * If a function is passed as argument, it will be called everytime this item
16445 * is selected, i.e., the user clicks over an unselected item.
16446 * If always select is enabled it will call this function every time
16447 * user clicks over an item (already selected or not).
16448 * If such function isn't needed, just passing
16449 * @c NULL as @p func is enough. The same should be done for @p data.
16451 * @see elm_list_item_append() for a simple code example.
16452 * @see elm_list_always_select_mode_set()
16453 * @see elm_list_item_del()
16454 * @see elm_list_item_del_cb_set()
16455 * @see elm_list_clear()
16456 * @see elm_icon_add()
16460 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);
16463 * Insert a new item into the list object before item @p before.
16465 * @param obj The list object.
16466 * @param before The list item to insert before.
16467 * @param label The label of the list item.
16468 * @param icon The icon object to use for the left side of the item. An
16469 * icon can be any Evas object, but usually it is an icon created
16470 * with elm_icon_add().
16471 * @param end The icon object to use for the right side of the item. An
16472 * icon can be any Evas object.
16473 * @param func The function to call when the item is clicked.
16474 * @param data The data to associate with the item for related callbacks.
16476 * @return The created item or @c NULL upon failure.
16478 * A new item will be created and added to the list. Its position in
16479 * this list will be just before item @p before.
16481 * Items created with this method can be deleted with
16482 * elm_list_item_del().
16484 * Associated @p data can be properly freed when item is deleted if a
16485 * callback function is set with elm_list_item_del_cb_set().
16487 * If a function is passed as argument, it will be called everytime this item
16488 * is selected, i.e., the user clicks over an unselected item.
16489 * If always select is enabled it will call this function every time
16490 * user clicks over an item (already selected or not).
16491 * If such function isn't needed, just passing
16492 * @c NULL as @p func is enough. The same should be done for @p data.
16494 * @see elm_list_item_append() for a simple code example.
16495 * @see elm_list_always_select_mode_set()
16496 * @see elm_list_item_del()
16497 * @see elm_list_item_del_cb_set()
16498 * @see elm_list_clear()
16499 * @see elm_icon_add()
16503 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);
16506 * Insert a new item into the list object after item @p after.
16508 * @param obj The list object.
16509 * @param after The list item to insert after.
16510 * @param label The label of the list item.
16511 * @param icon The icon object to use for the left side of the item. An
16512 * icon can be any Evas object, but usually it is an icon created
16513 * with elm_icon_add().
16514 * @param end The icon object to use for the right side of the item. An
16515 * icon can be any Evas object.
16516 * @param func The function to call when the item is clicked.
16517 * @param data The data to associate with the item for related callbacks.
16519 * @return The created item or @c NULL upon failure.
16521 * A new item will be created and added to the list. Its position in
16522 * this list will be just after item @p after.
16524 * Items created with this method can be deleted with
16525 * elm_list_item_del().
16527 * Associated @p data can be properly freed when item is deleted if a
16528 * callback function is set with elm_list_item_del_cb_set().
16530 * If a function is passed as argument, it will be called everytime this item
16531 * is selected, i.e., the user clicks over an unselected item.
16532 * If always select is enabled it will call this function every time
16533 * user clicks over an item (already selected or not).
16534 * If such function isn't needed, just passing
16535 * @c NULL as @p func is enough. The same should be done for @p data.
16537 * @see elm_list_item_append() for a simple code example.
16538 * @see elm_list_always_select_mode_set()
16539 * @see elm_list_item_del()
16540 * @see elm_list_item_del_cb_set()
16541 * @see elm_list_clear()
16542 * @see elm_icon_add()
16546 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);
16549 * Insert a new item into the sorted list object.
16551 * @param obj The list object.
16552 * @param label The label of the list item.
16553 * @param icon The icon object to use for the left side of the item. An
16554 * icon can be any Evas object, but usually it is an icon created
16555 * with elm_icon_add().
16556 * @param end The icon object to use for the right side of the item. An
16557 * icon can be any Evas object.
16558 * @param func The function to call when the item is clicked.
16559 * @param data The data to associate with the item for related callbacks.
16560 * @param cmp_func The comparing function to be used to sort list
16561 * items <b>by #Elm_List_Item item handles</b>. This function will
16562 * receive two items and compare them, returning a non-negative integer
16563 * if the second item should be place after the first, or negative value
16564 * if should be placed before.
16566 * @return The created item or @c NULL upon failure.
16568 * @note This function inserts values into a list object assuming it was
16569 * sorted and the result will be sorted.
16571 * A new item will be created and added to the list. Its position in
16572 * this list will be found comparing the new item with previously inserted
16573 * items using function @p cmp_func.
16575 * Items created with this method can be deleted with
16576 * elm_list_item_del().
16578 * Associated @p data can be properly freed when item is deleted if a
16579 * callback function is set with elm_list_item_del_cb_set().
16581 * If a function is passed as argument, it will be called everytime this item
16582 * is selected, i.e., the user clicks over an unselected item.
16583 * If always select is enabled it will call this function every time
16584 * user clicks over an item (already selected or not).
16585 * If such function isn't needed, just passing
16586 * @c NULL as @p func is enough. The same should be done for @p data.
16588 * @see elm_list_item_append() for a simple code example.
16589 * @see elm_list_always_select_mode_set()
16590 * @see elm_list_item_del()
16591 * @see elm_list_item_del_cb_set()
16592 * @see elm_list_clear()
16593 * @see elm_icon_add()
16597 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);
16600 * Remove all list's items.
16602 * @param obj The list object
16604 * @see elm_list_item_del()
16605 * @see elm_list_item_append()
16609 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16612 * Get a list of all the list items.
16614 * @param obj The list object
16615 * @return An @c Eina_List of list items, #Elm_List_Item,
16616 * or @c NULL on failure.
16618 * @see elm_list_item_append()
16619 * @see elm_list_item_del()
16620 * @see elm_list_clear()
16624 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16627 * Get the selected item.
16629 * @param obj The list object.
16630 * @return The selected list item.
16632 * The selected item can be unselected with function
16633 * elm_list_item_selected_set().
16635 * The selected item always will be highlighted on list.
16637 * @see elm_list_selected_items_get()
16641 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16644 * Return a list of the currently selected list items.
16646 * @param obj The list object.
16647 * @return An @c Eina_List of list items, #Elm_List_Item,
16648 * or @c NULL on failure.
16650 * Multiple items can be selected if multi select is enabled. It can be
16651 * done with elm_list_multi_select_set().
16653 * @see elm_list_selected_item_get()
16654 * @see elm_list_multi_select_set()
16658 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16661 * Set the selected state of an item.
16663 * @param item The list item
16664 * @param selected The selected state
16666 * This sets the selected state of the given item @p it.
16667 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16669 * If a new item is selected the previosly selected will be unselected,
16670 * unless multiple selection is enabled with elm_list_multi_select_set().
16671 * Previoulsy selected item can be get with function
16672 * elm_list_selected_item_get().
16674 * Selected items will be highlighted.
16676 * @see elm_list_item_selected_get()
16677 * @see elm_list_selected_item_get()
16678 * @see elm_list_multi_select_set()
16682 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16685 * Get whether the @p item is selected or not.
16687 * @param item The list item.
16688 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16689 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16691 * @see elm_list_selected_item_set() for details.
16692 * @see elm_list_item_selected_get()
16696 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16699 * Set or unset item as a separator.
16701 * @param it The list item.
16702 * @param setting @c EINA_TRUE to set item @p it as separator or
16703 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16705 * Items aren't set as separator by default.
16707 * If set as separator it will display separator theme, so won't display
16710 * @see elm_list_item_separator_get()
16714 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16717 * Get a value whether item is a separator or not.
16719 * @see elm_list_item_separator_set() for details.
16721 * @param it The list item.
16722 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16723 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16727 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16730 * Show @p item in the list view.
16732 * @param item The list item to be shown.
16734 * It won't animate list until item is visible. If such behavior is wanted,
16735 * use elm_list_bring_in() intead.
16739 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16742 * Bring in the given item to list view.
16744 * @param item The item.
16746 * This causes list to jump to the given item @p item and show it
16747 * (by scrolling), if it is not fully visible.
16749 * This may use animation to do so and take a period of time.
16751 * If animation isn't wanted, elm_list_item_show() can be used.
16755 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16758 * Delete them item from the list.
16760 * @param item The item of list to be deleted.
16762 * If deleting all list items is required, elm_list_clear()
16763 * should be used instead of getting items list and deleting each one.
16765 * @see elm_list_clear()
16766 * @see elm_list_item_append()
16767 * @see elm_list_item_del_cb_set()
16771 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16774 * Set the function called when a list item is freed.
16776 * @param item The item to set the callback on
16777 * @param func The function called
16779 * If there is a @p func, then it will be called prior item's memory release.
16780 * That will be called with the following arguments:
16782 * @li item's Evas object;
16785 * This way, a data associated to a list item could be properly freed.
16789 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16792 * Get the data associated to the item.
16794 * @param item The list item
16795 * @return The data associated to @p item
16797 * The return value is a pointer to data associated to @p item when it was
16798 * created, with function elm_list_item_append() or similar. If no data
16799 * was passed as argument, it will return @c NULL.
16801 * @see elm_list_item_append()
16805 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16808 * Get the left side icon associated to the item.
16810 * @param item The list item
16811 * @return The left side icon associated to @p item
16813 * The return value is a pointer to the icon associated to @p item when
16815 * created, with function elm_list_item_append() or similar, or later
16816 * with function elm_list_item_icon_set(). If no icon
16817 * was passed as argument, it will return @c NULL.
16819 * @see elm_list_item_append()
16820 * @see elm_list_item_icon_set()
16824 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16827 * Set the left side icon associated to the item.
16829 * @param item The list item
16830 * @param icon The left side icon object to associate with @p item
16832 * The icon object to use at left side of the item. An
16833 * icon can be any Evas object, but usually it is an icon created
16834 * with elm_icon_add().
16836 * Once the icon object is set, a previously set one will be deleted.
16837 * @warning Setting the same icon for two items will cause the icon to
16838 * dissapear from the first item.
16840 * If an icon was passed as argument on item creation, with function
16841 * elm_list_item_append() or similar, it will be already
16842 * associated to the item.
16844 * @see elm_list_item_append()
16845 * @see elm_list_item_icon_get()
16849 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16852 * Get the right side icon associated to the item.
16854 * @param item The list item
16855 * @return The right side icon associated to @p item
16857 * The return value is a pointer to the icon associated to @p item when
16859 * created, with function elm_list_item_append() or similar, or later
16860 * with function elm_list_item_icon_set(). If no icon
16861 * was passed as argument, it will return @c NULL.
16863 * @see elm_list_item_append()
16864 * @see elm_list_item_icon_set()
16868 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16871 * Set the right side icon associated to the item.
16873 * @param item The list item
16874 * @param end The right side icon object to associate with @p item
16876 * The icon object to use at right side of the item. An
16877 * icon can be any Evas object, but usually it is an icon created
16878 * with elm_icon_add().
16880 * Once the icon object is set, a previously set one will be deleted.
16881 * @warning Setting the same icon for two items will cause the icon to
16882 * dissapear from the first item.
16884 * If an icon was passed as argument on item creation, with function
16885 * elm_list_item_append() or similar, it will be already
16886 * associated to the item.
16888 * @see elm_list_item_append()
16889 * @see elm_list_item_end_get()
16893 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
16894 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16897 * Gets the base object of the item.
16899 * @param item The list item
16900 * @return The base object associated with @p item
16902 * Base object is the @c Evas_Object that represents that item.
16906 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16909 * Get the label of item.
16911 * @param item The item of list.
16912 * @return The label of item.
16914 * The return value is a pointer to the label associated to @p item when
16915 * it was created, with function elm_list_item_append(), or later
16916 * with function elm_list_item_label_set. If no label
16917 * was passed as argument, it will return @c NULL.
16919 * @see elm_list_item_label_set() for more details.
16920 * @see elm_list_item_append()
16924 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16927 * Set the label of item.
16929 * @param item The item of list.
16930 * @param text The label of item.
16932 * The label to be displayed by the item.
16933 * Label will be placed between left and right side icons (if set).
16935 * If a label was passed as argument on item creation, with function
16936 * elm_list_item_append() or similar, it will be already
16937 * displayed by the item.
16939 * @see elm_list_item_label_get()
16940 * @see elm_list_item_append()
16944 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16948 * Get the item before @p it in list.
16950 * @param it The list item.
16951 * @return The item before @p it, or @c NULL if none or on failure.
16953 * @note If it is the first item, @c NULL will be returned.
16955 * @see elm_list_item_append()
16956 * @see elm_list_items_get()
16960 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16963 * Get the item after @p it in list.
16965 * @param it The list item.
16966 * @return The item after @p it, or @c NULL if none or on failure.
16968 * @note If it is the last item, @c NULL will be returned.
16970 * @see elm_list_item_append()
16971 * @see elm_list_items_get()
16975 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16978 * Sets the disabled/enabled state of a list item.
16980 * @param it The item.
16981 * @param disabled The disabled state.
16983 * A disabled item cannot be selected or unselected. It will also
16984 * change its appearance (generally greyed out). This sets the
16985 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
16990 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16993 * Get a value whether list item is disabled or not.
16995 * @param it The item.
16996 * @return The disabled state.
16998 * @see elm_list_item_disabled_set() for more details.
17002 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17005 * Set the text to be shown in a given list item's tooltips.
17007 * @param item Target item.
17008 * @param text The text to set in the content.
17010 * Setup the text as tooltip to object. The item can have only one tooltip,
17011 * so any previous tooltip data - set with this function or
17012 * elm_list_item_tooltip_content_cb_set() - is removed.
17014 * @see elm_object_tooltip_text_set() for more details.
17018 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17022 * @brief Disable size restrictions on an object's tooltip
17023 * @param item The tooltip's anchor object
17024 * @param disable If EINA_TRUE, size restrictions are disabled
17025 * @return EINA_FALSE on failure, EINA_TRUE on success
17027 * This function allows a tooltip to expand beyond its parant window's canvas.
17028 * It will instead be limited only by the size of the display.
17030 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17032 * @brief Retrieve size restriction state of an object's tooltip
17033 * @param obj The tooltip's anchor object
17034 * @return If EINA_TRUE, size restrictions are disabled
17036 * This function returns whether a tooltip is allowed to expand beyond
17037 * its parant window's canvas.
17038 * It will instead be limited only by the size of the display.
17040 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17043 * Set the content to be shown in the tooltip item.
17045 * Setup the tooltip to item. The item can have only one tooltip,
17046 * so any previous tooltip data is removed. @p func(with @p data) will
17047 * be called every time that need show the tooltip and it should
17048 * return a valid Evas_Object. This object is then managed fully by
17049 * tooltip system and is deleted when the tooltip is gone.
17051 * @param item the list item being attached a tooltip.
17052 * @param func the function used to create the tooltip contents.
17053 * @param data what to provide to @a func as callback data/context.
17054 * @param del_cb called when data is not needed anymore, either when
17055 * another callback replaces @a func, the tooltip is unset with
17056 * elm_list_item_tooltip_unset() or the owner @a item
17057 * dies. This callback receives as the first parameter the
17058 * given @a data, and @c event_info is the item.
17060 * @see elm_object_tooltip_content_cb_set() for more details.
17064 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);
17067 * Unset tooltip from item.
17069 * @param item list item to remove previously set tooltip.
17071 * Remove tooltip from item. The callback provided as del_cb to
17072 * elm_list_item_tooltip_content_cb_set() will be called to notify
17073 * it is not used anymore.
17075 * @see elm_object_tooltip_unset() for more details.
17076 * @see elm_list_item_tooltip_content_cb_set()
17080 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17083 * Sets a different style for this item tooltip.
17085 * @note before you set a style you should define a tooltip with
17086 * elm_list_item_tooltip_content_cb_set() or
17087 * elm_list_item_tooltip_text_set()
17089 * @param item list item with tooltip already set.
17090 * @param style the theme style to use (default, transparent, ...)
17092 * @see elm_object_tooltip_style_set() for more details.
17096 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17099 * Get the style for this item tooltip.
17101 * @param item list item with tooltip already set.
17102 * @return style the theme style in use, defaults to "default". If the
17103 * object does not have a tooltip set, then NULL is returned.
17105 * @see elm_object_tooltip_style_get() for more details.
17106 * @see elm_list_item_tooltip_style_set()
17110 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17113 * Set the type of mouse pointer/cursor decoration to be shown,
17114 * when the mouse pointer is over the given list widget item
17116 * @param item list item to customize cursor on
17117 * @param cursor the cursor type's name
17119 * This function works analogously as elm_object_cursor_set(), but
17120 * here the cursor's changing area is restricted to the item's
17121 * area, and not the whole widget's. Note that that item cursors
17122 * have precedence over widget cursors, so that a mouse over an
17123 * item with custom cursor set will always show @b that cursor.
17125 * If this function is called twice for an object, a previously set
17126 * cursor will be unset on the second call.
17128 * @see elm_object_cursor_set()
17129 * @see elm_list_item_cursor_get()
17130 * @see elm_list_item_cursor_unset()
17134 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17137 * Get the type of mouse pointer/cursor decoration set to be shown,
17138 * when the mouse pointer is over the given list widget item
17140 * @param item list item with custom cursor set
17141 * @return the cursor type's name or @c NULL, if no custom cursors
17142 * were set to @p item (and on errors)
17144 * @see elm_object_cursor_get()
17145 * @see elm_list_item_cursor_set()
17146 * @see elm_list_item_cursor_unset()
17150 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17153 * Unset any custom mouse pointer/cursor decoration set to be
17154 * shown, when the mouse pointer is over the given list widget
17155 * item, thus making it show the @b default cursor again.
17157 * @param item a list item
17159 * Use this call to undo any custom settings on this item's cursor
17160 * decoration, bringing it back to defaults (no custom style set).
17162 * @see elm_object_cursor_unset()
17163 * @see elm_list_item_cursor_set()
17167 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17170 * Set a different @b style for a given custom cursor set for a
17173 * @param item list item with custom cursor set
17174 * @param style the <b>theme style</b> to use (e.g. @c "default",
17175 * @c "transparent", etc)
17177 * This function only makes sense when one is using custom mouse
17178 * cursor decorations <b>defined in a theme file</b>, which can have,
17179 * given a cursor name/type, <b>alternate styles</b> on it. It
17180 * works analogously as elm_object_cursor_style_set(), but here
17181 * applyed only to list item objects.
17183 * @warning Before you set a cursor style you should have definen a
17184 * custom cursor previously on the item, with
17185 * elm_list_item_cursor_set()
17187 * @see elm_list_item_cursor_engine_only_set()
17188 * @see elm_list_item_cursor_style_get()
17192 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17195 * Get the current @b style set for a given list item's custom
17198 * @param item list item with custom cursor set.
17199 * @return style the cursor style in use. If the object does not
17200 * have a cursor set, then @c NULL is returned.
17202 * @see elm_list_item_cursor_style_set() for more details
17206 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17209 * Set if the (custom)cursor for a given list item should be
17210 * searched in its theme, also, or should only rely on the
17211 * rendering engine.
17213 * @param item item with custom (custom) cursor already set on
17214 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17215 * only on those provided by the rendering engine, @c EINA_FALSE to
17216 * have them searched on the widget's theme, as well.
17218 * @note This call is of use only if you've set a custom cursor
17219 * for list items, with elm_list_item_cursor_set().
17221 * @note By default, cursors will only be looked for between those
17222 * provided by the rendering engine.
17226 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17229 * Get if the (custom) cursor for a given list item is being
17230 * searched in its theme, also, or is only relying on the rendering
17233 * @param item a list item
17234 * @return @c EINA_TRUE, if cursors are being looked for only on
17235 * those provided by the rendering engine, @c EINA_FALSE if they
17236 * are being searched on the widget's theme, as well.
17238 * @see elm_list_item_cursor_engine_only_set(), for more details
17242 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17249 * @defgroup Slider Slider
17250 * @ingroup Elementary
17252 * @image html img/widget/slider/preview-00.png
17253 * @image latex img/widget/slider/preview-00.eps width=\textwidth
17255 * The slider adds a dragable āsliderā widget for selecting the value of
17256 * something within a range.
17258 * A slider can be horizontal or vertical. It can contain an Icon and has a
17259 * primary label as well as a units label (that is formatted with floating
17260 * point values and thus accepts a printf-style format string, like
17261 * ā%1.2f unitsā. There is also an indicator string that may be somewhere
17262 * else (like on the slider itself) that also accepts a format string like
17263 * units. Label, Icon Unit and Indicator strings/objects are optional.
17265 * A slider may be inverted which means values invert, with high vales being
17266 * on the left or top and low values on the right or bottom (as opposed to
17267 * normally being low on the left or top and high on the bottom and right).
17269 * The slider should have its minimum and maximum values set by the
17270 * application with elm_slider_min_max_set() and value should also be set by
17271 * the application before use with elm_slider_value_set(). The span of the
17272 * slider is its length (horizontally or vertically). This will be scaled by
17273 * the object or applications scaling factor. At any point code can query the
17274 * slider for its value with elm_slider_value_get().
17276 * Smart callbacks one can listen to:
17277 * - "changed" - Whenever the slider value is changed by the user.
17278 * - "slider,drag,start" - dragging the slider indicator around has started.
17279 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17280 * - "delay,changed" - A short time after the value is changed by the user.
17281 * This will be called only when the user stops dragging for
17282 * a very short period or when they release their
17283 * finger/mouse, so it avoids possibly expensive reactions to
17284 * the value change.
17286 * Available styles for it:
17289 * Default contents parts of the slider widget that you can use for are:
17290 * @li "elm.swallow.icon" - A icon of the slider
17291 * @li "elm.swallow.end" - A end part content of the slider
17293 * Here is an example on its usage:
17294 * @li @ref slider_example
17297 #define ELM_SLIDER_CONTENT_ICON "elm.swallow.icon"
17298 #define ELM_SLIDER_CONTENT_END "elm.swallow.end"
17301 * @addtogroup Slider
17306 * Add a new slider widget to the given parent Elementary
17307 * (container) object.
17309 * @param parent The parent object.
17310 * @return a new slider widget handle or @c NULL, on errors.
17312 * This function inserts a new slider widget on the canvas.
17316 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17319 * Set the label of a given slider widget
17321 * @param obj The progress bar object
17322 * @param label The text label string, in UTF-8
17325 * @deprecated use elm_object_text_set() instead.
17327 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17330 * Get the label of a given slider widget
17332 * @param obj The progressbar object
17333 * @return The text label string, in UTF-8
17336 * @deprecated use elm_object_text_get() instead.
17338 EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17341 * Set the icon object of the slider object.
17343 * @param obj The slider object.
17344 * @param icon The icon object.
17346 * On horizontal mode, icon is placed at left, and on vertical mode,
17349 * @note Once the icon object is set, a previously set one will be deleted.
17350 * If you want to keep that old content object, use the
17351 * elm_slider_icon_unset() function.
17353 * @warning If the object being set does not have minimum size hints set,
17354 * it won't get properly displayed.
17357 * @deprecated use elm_object_content_set() instead.
17359 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17362 * Unset an icon set on a given slider widget.
17364 * @param obj The slider object.
17365 * @return The icon object that was being used, if any was set, or
17366 * @c NULL, otherwise (and on errors).
17368 * On horizontal mode, icon is placed at left, and on vertical mode,
17371 * This call will unparent and return the icon object which was set
17372 * for this widget, previously, on success.
17374 * @see elm_slider_icon_set() for more details
17375 * @see elm_slider_icon_get()
17376 * @deprecated use elm_object_content_unset() instead.
17380 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17383 * Retrieve the icon object set for a given slider widget.
17385 * @param obj The slider object.
17386 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17387 * otherwise (and on errors).
17389 * On horizontal mode, icon is placed at left, and on vertical mode,
17392 * @see elm_slider_icon_set() for more details
17393 * @see elm_slider_icon_unset()
17397 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17400 * Set the end object of the slider object.
17402 * @param obj The slider object.
17403 * @param end The end object.
17405 * On horizontal mode, end is placed at left, and on vertical mode,
17406 * placed at bottom.
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_end_unset() function.
17412 * @warning If the object being set does not have minimum size hints set,
17413 * it won't get properly displayed.
17417 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17420 * Unset an end object set on a given slider widget.
17422 * @param obj The slider object.
17423 * @return The end object that was being used, if any was set, or
17424 * @c NULL, otherwise (and on errors).
17426 * On horizontal mode, end is placed at left, and on vertical mode,
17427 * placed at bottom.
17429 * This call will unparent and return the icon object which was set
17430 * for this widget, previously, on success.
17432 * @see elm_slider_end_set() for more details.
17433 * @see elm_slider_end_get()
17437 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17440 * Retrieve the end object set for a given slider widget.
17442 * @param obj The slider object.
17443 * @return The end object's handle, if @p obj had one set, or @c NULL,
17444 * otherwise (and on errors).
17446 * On horizontal mode, icon is placed at right, and on vertical mode,
17447 * placed at bottom.
17449 * @see elm_slider_end_set() for more details.
17450 * @see elm_slider_end_unset()
17454 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17457 * Set the (exact) length of the bar region of a given slider widget.
17459 * @param obj The slider object.
17460 * @param size The length of the slider's bar region.
17462 * This sets the minimum width (when in horizontal mode) or height
17463 * (when in vertical mode) of the actual bar area of the slider
17464 * @p obj. This in turn affects the object's minimum size. Use
17465 * this when you're not setting other size hints expanding on the
17466 * given direction (like weight and alignment hints) and you would
17467 * like it to have a specific size.
17469 * @note Icon, end, label, indicator and unit text around @p obj
17470 * will require their
17471 * own space, which will make @p obj to require more the @p size,
17474 * @see elm_slider_span_size_get()
17478 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17481 * Get the length set for the bar region of a given slider widget
17483 * @param obj The slider object.
17484 * @return The length of the slider's bar region.
17486 * If that size was not set previously, with
17487 * elm_slider_span_size_set(), this call will return @c 0.
17491 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17494 * Set the format string for the unit label.
17496 * @param obj The slider object.
17497 * @param format The format string for the unit display.
17499 * Unit label is displayed all the time, if set, after slider's bar.
17500 * In horizontal mode, at right and in vertical mode, at bottom.
17502 * If @c NULL, unit label won't be visible. If not it sets the format
17503 * string for the label text. To the label text is provided a floating point
17504 * value, so the label text can display up to 1 floating point value.
17505 * Note that this is optional.
17507 * Use a format string such as "%1.2f meters" for example, and it will
17508 * display values like: "3.14 meters" for a value equal to 3.14159.
17510 * Default is unit label disabled.
17512 * @see elm_slider_indicator_format_get()
17516 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17519 * Get the unit label format of the slider.
17521 * @param obj The slider object.
17522 * @return The unit label format string in UTF-8.
17524 * Unit label is displayed all the time, if set, after slider's bar.
17525 * In horizontal mode, at right and in vertical mode, at bottom.
17527 * @see elm_slider_unit_format_set() for more
17528 * information on how this works.
17532 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17535 * Set the format string for the indicator label.
17537 * @param obj The slider object.
17538 * @param indicator The format string for the indicator display.
17540 * The slider may display its value somewhere else then unit label,
17541 * for example, above the slider knob that is dragged around. This function
17542 * sets the format string used for this.
17544 * If @c NULL, indicator label won't be visible. If not it sets the format
17545 * string for the label text. To the label text is provided a floating point
17546 * value, so the label text can display up to 1 floating point value.
17547 * Note that this is optional.
17549 * Use a format string such as "%1.2f meters" for example, and it will
17550 * display values like: "3.14 meters" for a value equal to 3.14159.
17552 * Default is indicator label disabled.
17554 * @see elm_slider_indicator_format_get()
17558 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17561 * Get the indicator label format of the slider.
17563 * @param obj The slider object.
17564 * @return The indicator label format string in UTF-8.
17566 * The slider may display its value somewhere else then unit label,
17567 * for example, above the slider knob that is dragged around. This function
17568 * gets the format string used for this.
17570 * @see elm_slider_indicator_format_set() for more
17571 * information on how this works.
17575 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17578 * Set the format function pointer for the indicator label
17580 * @param obj The slider object.
17581 * @param func The indicator format function.
17582 * @param free_func The freeing function for the format string.
17584 * Set the callback function to format the indicator string.
17586 * @see elm_slider_indicator_format_set() for more info on how this works.
17590 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);
17593 * Set the format function pointer for the units label
17595 * @param obj The slider object.
17596 * @param func The units format function.
17597 * @param free_func The freeing function for the format string.
17599 * Set the callback function to format the indicator string.
17601 * @see elm_slider_units_format_set() for more info on how this works.
17605 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);
17608 * Set the orientation of a given slider widget.
17610 * @param obj The slider object.
17611 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17612 * @b horizontal, @c EINA_FALSE to make it @b vertical.
17614 * Use this function to change how your slider is to be
17615 * disposed: vertically or horizontally.
17617 * By default it's displayed horizontally.
17619 * @see elm_slider_horizontal_get()
17623 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17626 * Retrieve the orientation of a given slider widget
17628 * @param obj The slider object.
17629 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17630 * @c EINA_FALSE if it's @b vertical (and on errors).
17632 * @see elm_slider_horizontal_set() for more details.
17636 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17639 * Set the minimum and maximum values for the slider.
17641 * @param obj The slider object.
17642 * @param min The minimum value.
17643 * @param max The maximum value.
17645 * Define the allowed range of values to be selected by the user.
17647 * If actual value is less than @p min, it will be updated to @p min. If it
17648 * is bigger then @p max, will be updated to @p max. Actual value can be
17649 * get with elm_slider_value_get().
17651 * By default, min is equal to 0.0, and max is equal to 1.0.
17653 * @warning Maximum must be greater than minimum, otherwise behavior
17656 * @see elm_slider_min_max_get()
17660 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17663 * Get the minimum and maximum values of the slider.
17665 * @param obj The slider object.
17666 * @param min Pointer where to store the minimum value.
17667 * @param max Pointer where to store the maximum value.
17669 * @note If only one value is needed, the other pointer can be passed
17672 * @see elm_slider_min_max_set() for details.
17676 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17679 * Set the value the slider displays.
17681 * @param obj The slider object.
17682 * @param val The value to be displayed.
17684 * Value will be presented on the unit label following format specified with
17685 * elm_slider_unit_format_set() and on indicator with
17686 * elm_slider_indicator_format_set().
17688 * @warning The value must to be between min and max values. This values
17689 * are set by elm_slider_min_max_set().
17691 * @see elm_slider_value_get()
17692 * @see elm_slider_unit_format_set()
17693 * @see elm_slider_indicator_format_set()
17694 * @see elm_slider_min_max_set()
17698 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17701 * Get the value displayed by the spinner.
17703 * @param obj The spinner object.
17704 * @return The value displayed.
17706 * @see elm_spinner_value_set() for details.
17710 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17713 * Invert a given slider widget's displaying values order
17715 * @param obj The slider object.
17716 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17717 * @c EINA_FALSE to bring it back to default, non-inverted values.
17719 * A slider may be @b inverted, in which state it gets its
17720 * values inverted, with high vales being on the left or top and
17721 * low values on the right or bottom, as opposed to normally have
17722 * the low values on the former and high values on the latter,
17723 * respectively, for horizontal and vertical modes.
17725 * @see elm_slider_inverted_get()
17729 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17732 * Get whether a given slider widget's displaying values are
17735 * @param obj The slider object.
17736 * @return @c EINA_TRUE, if @p obj has inverted values,
17737 * @c EINA_FALSE otherwise (and on errors).
17739 * @see elm_slider_inverted_set() for more details.
17743 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17746 * Set whether to enlarge slider indicator (augmented knob) or not.
17748 * @param obj The slider object.
17749 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17750 * let the knob always at default size.
17752 * By default, indicator will be bigger while dragged by the user.
17754 * @warning It won't display values set with
17755 * elm_slider_indicator_format_set() if you disable indicator.
17759 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17762 * Get whether a given slider widget's enlarging indicator or not.
17764 * @param obj The slider object.
17765 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17766 * @c EINA_FALSE otherwise (and on errors).
17768 * @see elm_slider_indicator_show_set() for details.
17772 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17779 * @addtogroup Actionslider Actionslider
17781 * @image html img/widget/actionslider/preview-00.png
17782 * @image latex img/widget/actionslider/preview-00.eps
17784 * An actionslider is a switcher for 2 or 3 labels with customizable magnet
17785 * properties. The user drags and releases the indicator, to choose a label.
17787 * Labels occupy the following positions.
17792 * Positions can be enabled or disabled.
17794 * Magnets can be set on the above positions.
17796 * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
17798 * @note By default all positions are set as enabled.
17800 * Signals that you can add callbacks for are:
17802 * "selected" - when user selects an enabled position (the label is passed
17805 * "pos_changed" - when the indicator reaches any of the positions("left",
17806 * "right" or "center").
17808 * See an example of actionslider usage @ref actionslider_example_page "here"
17812 typedef enum _Elm_Actionslider_Indicator_Pos
17814 ELM_ACTIONSLIDER_INDICATOR_NONE,
17815 ELM_ACTIONSLIDER_INDICATOR_LEFT,
17816 ELM_ACTIONSLIDER_INDICATOR_RIGHT,
17817 ELM_ACTIONSLIDER_INDICATOR_CENTER
17818 } Elm_Actionslider_Indicator_Pos;
17820 typedef enum _Elm_Actionslider_Magnet_Pos
17822 ELM_ACTIONSLIDER_MAGNET_NONE = 0,
17823 ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
17824 ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
17825 ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
17826 ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
17827 ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
17828 } Elm_Actionslider_Magnet_Pos;
17830 typedef enum _Elm_Actionslider_Label_Pos
17832 ELM_ACTIONSLIDER_LABEL_LEFT,
17833 ELM_ACTIONSLIDER_LABEL_RIGHT,
17834 ELM_ACTIONSLIDER_LABEL_CENTER,
17835 ELM_ACTIONSLIDER_LABEL_BUTTON
17836 } Elm_Actionslider_Label_Pos;
17838 /* smart callbacks called:
17839 * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
17843 * Add a new actionslider to the parent.
17845 * @param parent The parent object
17846 * @return The new actionslider object or NULL if it cannot be created
17848 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17851 * Set actionslider label.
17853 * @param[in] obj The actionslider object
17854 * @param[in] pos The position of the label.
17855 * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
17856 * @param label The label which is going to be set.
17858 EAPI void elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
17860 * Get actionslider labels.
17862 * @param obj The actionslider object
17863 * @param left_label A char** to place the left_label of @p obj into.
17864 * @param center_label A char** to place the center_label of @p obj into.
17865 * @param right_label A char** to place the right_label of @p obj into.
17867 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);
17869 * Get actionslider selected label.
17871 * @param obj The actionslider object
17872 * @return The selected label
17874 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17876 * Set actionslider indicator position.
17878 * @param obj The actionslider object.
17879 * @param pos The position of the indicator.
17881 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
17883 * Get actionslider indicator position.
17885 * @param obj The actionslider object.
17886 * @return The position of the indicator.
17888 EAPI Elm_Actionslider_Indicator_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17890 * Set actionslider magnet position. To make multiple positions magnets @c or
17891 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
17893 * @param obj The actionslider object.
17894 * @param pos Bit mask indicating the magnet positions.
17896 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
17898 * Get actionslider magnet position.
17900 * @param obj The actionslider object.
17901 * @return The positions with magnet property.
17903 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17905 * Set actionslider enabled position. To set multiple positions as enabled @c or
17906 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
17908 * @note All the positions are enabled by default.
17910 * @param obj The actionslider object.
17911 * @param pos Bit mask indicating the enabled positions.
17913 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
17915 * Get actionslider enabled position.
17917 * @param obj The actionslider object.
17918 * @return The enabled positions.
17920 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17922 * Set the label used on the indicator.
17924 * @param obj The actionslider object
17925 * @param label The label to be set on the indicator.
17926 * @deprecated use elm_object_text_set() instead.
17928 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17930 * Get the label used on the indicator object.
17932 * @param obj The actionslider object
17933 * @return The indicator label
17934 * @deprecated use elm_object_text_get() instead.
17936 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
17939 * Hold actionslider object movement.
17941 * @param[in] obj The actionslider object
17942 * @param[in] flag Actionslider hold/release
17943 * (EINA_TURE = hold/EIN_FALSE = release)
17945 * @ingroup Actionslider
17947 EAPI void elm_actionslider_hold(Evas_Object *obj, Eina_Bool flag) EINA_ARG_NONNULL(1);
17955 * @defgroup Genlist Genlist
17957 * @image html img/widget/genlist/preview-00.png
17958 * @image latex img/widget/genlist/preview-00.eps
17959 * @image html img/genlist.png
17960 * @image latex img/genlist.eps
17962 * This widget aims to have more expansive list than the simple list in
17963 * Elementary that could have more flexible items and allow many more entries
17964 * while still being fast and low on memory usage. At the same time it was
17965 * also made to be able to do tree structures. But the price to pay is more
17966 * complexity when it comes to usage. If all you want is a simple list with
17967 * icons and a single label, use the normal @ref List object.
17969 * Genlist has a fairly large API, mostly because it's relatively complex,
17970 * trying to be both expansive, powerful and efficient. First we will begin
17971 * an overview on the theory behind genlist.
17973 * @section Genlist_Item_Class Genlist item classes - creating items
17975 * In order to have the ability to add and delete items on the fly, genlist
17976 * implements a class (callback) system where the application provides a
17977 * structure with information about that type of item (genlist may contain
17978 * multiple different items with different classes, states and styles).
17979 * Genlist will call the functions in this struct (methods) when an item is
17980 * "realized" (i.e., created dynamically, while the user is scrolling the
17981 * grid). All objects will simply be deleted when no longer needed with
17982 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
17983 * following members:
17984 * - @c item_style - This is a constant string and simply defines the name
17985 * of the item style. It @b must be specified and the default should be @c
17988 * - @c func - A struct with pointers to functions that will be called when
17989 * an item is going to be actually created. All of them receive a @c data
17990 * parameter that will point to the same data passed to
17991 * elm_genlist_item_append() and related item creation functions, and a @c
17992 * obj parameter that points to the genlist object itself.
17994 * The function pointers inside @c func are @c label_get, @c icon_get, @c
17995 * state_get and @c del. The 3 first functions also receive a @c part
17996 * parameter described below. A brief description of these functions follows:
17998 * - @c label_get - The @c part parameter is the name string of one of the
17999 * existing text parts in the Edje group implementing the item's theme.
18000 * This function @b must return a strdup'()ed string, as the caller will
18001 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
18002 * - @c content_get - The @c part parameter is the name string of one of the
18003 * existing (content) swallow parts in the Edje group implementing the item's
18004 * theme. It must return @c NULL, when no content is desired, or a valid
18005 * object handle, otherwise. The object will be deleted by the genlist on
18006 * its deletion or when the item is "unrealized". See
18007 * #Elm_Genlist_Item_Icon_Get_Cb.
18008 * - @c func.state_get - The @c part parameter is the name string of one of
18009 * the state parts in the Edje group implementing the item's theme. Return
18010 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
18011 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
18012 * and @c "elm" as "emission" and "source" arguments, respectively, when
18013 * the state is true (the default is false), where @c XXX is the name of
18014 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
18015 * - @c func.del - This is intended for use when genlist items are deleted,
18016 * so any data attached to the item (e.g. its data parameter on creation)
18017 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
18019 * available item styles:
18021 * - default_style - The text part is a textblock
18023 * @image html img/widget/genlist/preview-04.png
18024 * @image latex img/widget/genlist/preview-04.eps
18028 * @image html img/widget/genlist/preview-01.png
18029 * @image latex img/widget/genlist/preview-01.eps
18031 * - icon_top_text_bottom
18033 * @image html img/widget/genlist/preview-02.png
18034 * @image latex img/widget/genlist/preview-02.eps
18038 * @image html img/widget/genlist/preview-03.png
18039 * @image latex img/widget/genlist/preview-03.eps
18041 * @section Genlist_Items Structure of items
18043 * An item in a genlist can have 0 or more text labels (they can be regular
18044 * text or textblock Evas objects - that's up to the style to determine), 0
18045 * or more contents (which are simply objects swallowed into the genlist item's
18046 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18047 * behavior left to the user to define. The Edje part names for each of
18048 * these properties will be looked up, in the theme file for the genlist,
18049 * under the Edje (string) data items named @c "labels", @c "contents" and @c
18050 * "states", respectively. For each of those properties, if more than one
18051 * part is provided, they must have names listed separated by spaces in the
18052 * data fields. For the default genlist item theme, we have @b one label
18053 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18054 * "elm.swallow.end") and @b no state parts.
18056 * A genlist item may be at one of several styles. Elementary provides one
18057 * by default - "default", but this can be extended by system or application
18058 * custom themes/overlays/extensions (see @ref Theme "themes" for more
18061 * @section Genlist_Manipulation Editing and Navigating
18063 * Items can be added by several calls. All of them return a @ref
18064 * Elm_Genlist_Item handle that is an internal member inside the genlist.
18065 * They all take a data parameter that is meant to be used for a handle to
18066 * the applications internal data (eg the struct with the original item
18067 * data). The parent parameter is the parent genlist item this belongs to if
18068 * it is a tree or an indexed group, and NULL if there is no parent. The
18069 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18070 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18071 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18072 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
18073 * is set then this item is group index item that is displayed at the top
18074 * until the next group comes. The func parameter is a convenience callback
18075 * that is called when the item is selected and the data parameter will be
18076 * the func_data parameter, obj be the genlist object and event_info will be
18077 * the genlist item.
18079 * elm_genlist_item_append() adds an item to the end of the list, or if
18080 * there is a parent, to the end of all the child items of the parent.
18081 * elm_genlist_item_prepend() is the same but adds to the beginning of
18082 * the list or children list. elm_genlist_item_insert_before() inserts at
18083 * item before another item and elm_genlist_item_insert_after() inserts after
18084 * the indicated item.
18086 * The application can clear the list with elm_genlist_clear() which deletes
18087 * all the items in the list and elm_genlist_item_del() will delete a specific
18088 * item. elm_genlist_item_subitems_clear() will clear all items that are
18089 * children of the indicated parent item.
18091 * To help inspect list items you can jump to the item at the top of the list
18092 * with elm_genlist_first_item_get() which will return the item pointer, and
18093 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18094 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18095 * and previous items respectively relative to the indicated item. Using
18096 * these calls you can walk the entire item list/tree. Note that as a tree
18097 * the items are flattened in the list, so elm_genlist_item_parent_get() will
18098 * let you know which item is the parent (and thus know how to skip them if
18101 * @section Genlist_Muti_Selection Multi-selection
18103 * If the application wants multiple items to be able to be selected,
18104 * elm_genlist_multi_select_set() can enable this. If the list is
18105 * single-selection only (the default), then elm_genlist_selected_item_get()
18106 * will return the selected item, if any, or NULL I none is selected. If the
18107 * list is multi-select then elm_genlist_selected_items_get() will return a
18108 * list (that is only valid as long as no items are modified (added, deleted,
18109 * selected or unselected)).
18111 * @section Genlist_Usage_Hints Usage hints
18113 * There are also convenience functions. elm_genlist_item_genlist_get() will
18114 * return the genlist object the item belongs to. elm_genlist_item_show()
18115 * will make the scroller scroll to show that specific item so its visible.
18116 * elm_genlist_item_data_get() returns the data pointer set by the item
18117 * creation functions.
18119 * If an item changes (state of boolean changes, label or contents change),
18120 * then use elm_genlist_item_update() to have genlist update the item with
18121 * the new state. Genlist will re-realize the item thus call the functions
18122 * in the _Elm_Genlist_Item_Class for that item.
18124 * To programmatically (un)select an item use elm_genlist_item_selected_set().
18125 * To get its selected state use elm_genlist_item_selected_get(). Similarly
18126 * to expand/contract an item and get its expanded state, use
18127 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18128 * again to make an item disabled (unable to be selected and appear
18129 * differently) use elm_genlist_item_disabled_set() to set this and
18130 * elm_genlist_item_disabled_get() to get the disabled state.
18132 * In general to indicate how the genlist should expand items horizontally to
18133 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18134 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18135 * mode means that if items are too wide to fit, the scroller will scroll
18136 * horizontally. Otherwise items are expanded to fill the width of the
18137 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18138 * to the viewport width and limited to that size. This can be combined with
18139 * a different style that uses edjes' ellipsis feature (cutting text off like
18142 * Items will only call their selection func and callback when first becoming
18143 * selected. Any further clicks will do nothing, unless you enable always
18144 * select with elm_genlist_always_select_mode_set(). This means even if
18145 * selected, every click will make the selected callbacks be called.
18146 * elm_genlist_no_select_mode_set() will turn off the ability to select
18147 * items entirely and they will neither appear selected nor call selected
18148 * callback functions.
18150 * Remember that you can create new styles and add your own theme augmentation
18151 * per application with elm_theme_extension_add(). If you absolutely must
18152 * have a specific style that overrides any theme the user or system sets up
18153 * you can use elm_theme_overlay_add() to add such a file.
18155 * @section Genlist_Implementation Implementation
18157 * Evas tracks every object you create. Every time it processes an event
18158 * (mouse move, down, up etc.) it needs to walk through objects and find out
18159 * what event that affects. Even worse every time it renders display updates,
18160 * in order to just calculate what to re-draw, it needs to walk through many
18161 * many many objects. Thus, the more objects you keep active, the more
18162 * overhead Evas has in just doing its work. It is advisable to keep your
18163 * active objects to the minimum working set you need. Also remember that
18164 * object creation and deletion carries an overhead, so there is a
18165 * middle-ground, which is not easily determined. But don't keep massive lists
18166 * of objects you can't see or use. Genlist does this with list objects. It
18167 * creates and destroys them dynamically as you scroll around. It groups them
18168 * into blocks so it can determine the visibility etc. of a whole block at
18169 * once as opposed to having to walk the whole list. This 2-level list allows
18170 * for very large numbers of items to be in the list (tests have used up to
18171 * 2,000,000 items). Also genlist employs a queue for adding items. As items
18172 * may be different sizes, every item added needs to be calculated as to its
18173 * size and thus this presents a lot of overhead on populating the list, this
18174 * genlist employs a queue. Any item added is queued and spooled off over
18175 * time, actually appearing some time later, so if your list has many members
18176 * you may find it takes a while for them to all appear, with your process
18177 * consuming a lot of CPU while it is busy spooling.
18179 * Genlist also implements a tree structure, but it does so with callbacks to
18180 * the application, with the application filling in tree structures when
18181 * requested (allowing for efficient building of a very deep tree that could
18182 * even be used for file-management). See the above smart signal callbacks for
18185 * @section Genlist_Smart_Events Genlist smart events
18187 * Signals that you can add callbacks for are:
18188 * - @c "activated" - The user has double-clicked or pressed
18189 * (enter|return|spacebar) on an item. The @c event_info parameter is the
18190 * item that was activated.
18191 * - @c "clicked,double" - The user has double-clicked an item. The @c
18192 * event_info parameter is the item that was double-clicked.
18193 * - @c "selected" - This is called when a user has made an item selected.
18194 * The event_info parameter is the genlist item that was selected.
18195 * - @c "unselected" - This is called when a user has made an item
18196 * unselected. The event_info parameter is the genlist item that was
18198 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18199 * called and the item is now meant to be expanded. The event_info
18200 * parameter is the genlist item that was indicated to expand. It is the
18201 * job of this callback to then fill in the child items.
18202 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18203 * called and the item is now meant to be contracted. The event_info
18204 * parameter is the genlist item that was indicated to contract. It is the
18205 * job of this callback to then delete the child items.
18206 * - @c "expand,request" - This is called when a user has indicated they want
18207 * to expand a tree branch item. The callback should decide if the item can
18208 * expand (has any children) and then call elm_genlist_item_expanded_set()
18209 * appropriately to set the state. The event_info parameter is the genlist
18210 * item that was indicated to expand.
18211 * - @c "contract,request" - This is called when a user has indicated they
18212 * want to contract a tree branch item. The callback should decide if the
18213 * item can contract (has any children) and then call
18214 * elm_genlist_item_expanded_set() appropriately to set the state. The
18215 * event_info parameter is the genlist item that was indicated to contract.
18216 * - @c "realized" - This is called when the item in the list is created as a
18217 * real evas object. event_info parameter is the genlist item that was
18218 * created. The object may be deleted at any time, so it is up to the
18219 * caller to not use the object pointer from elm_genlist_item_object_get()
18220 * in a way where it may point to freed objects.
18221 * - @c "unrealized" - This is called just before an item is unrealized.
18222 * After this call content objects provided will be deleted and the item
18223 * object itself delete or be put into a floating cache.
18224 * - @c "drag,start,up" - This is called when the item in the list has been
18225 * dragged (not scrolled) up.
18226 * - @c "drag,start,down" - This is called when the item in the list has been
18227 * dragged (not scrolled) down.
18228 * - @c "drag,start,left" - This is called when the item in the list has been
18229 * dragged (not scrolled) left.
18230 * - @c "drag,start,right" - This is called when the item in the list has
18231 * been dragged (not scrolled) right.
18232 * - @c "drag,stop" - This is called when the item in the list has stopped
18234 * - @c "drag" - This is called when the item in the list is being dragged.
18235 * - @c "longpressed" - This is called when the item is pressed for a certain
18236 * amount of time. By default it's 1 second.
18237 * - @c "scroll,anim,start" - This is called when scrolling animation has
18239 * - @c "scroll,anim,stop" - This is called when scrolling animation has
18241 * - @c "scroll,drag,start" - This is called when dragging the content has
18243 * - @c "scroll,drag,stop" - This is called when dragging the content has
18245 * - @c "edge,top" - This is called when the genlist is scrolled until
18247 * - @c "edge,bottom" - This is called when the genlist is scrolled
18248 * until the bottom edge.
18249 * - @c "edge,left" - This is called when the genlist is scrolled
18250 * until the left edge.
18251 * - @c "edge,right" - This is called when the genlist is scrolled
18252 * until the right edge.
18253 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18255 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18257 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18259 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18261 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18262 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
18263 * multi-touch pinched in.
18264 * - @c "swipe" - This is called when the genlist is swiped.
18265 * - @c "moved" - This is called when a genlist item is moved.
18266 * - @c "language,changed" - This is called when the program's language is
18269 * @section Genlist_Examples Examples
18271 * Here is a list of examples that use the genlist, trying to show some of
18272 * its capabilities:
18273 * - @ref genlist_example_01
18274 * - @ref genlist_example_02
18275 * - @ref genlist_example_03
18276 * - @ref genlist_example_04
18277 * - @ref genlist_example_05
18281 * @addtogroup Genlist
18286 * @enum _Elm_Genlist_Item_Flags
18287 * @typedef Elm_Genlist_Item_Flags
18289 * Defines if the item is of any special type (has subitems or it's the
18290 * index of a group), or is just a simple item.
18294 typedef enum _Elm_Genlist_Item_Flags
18296 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18297 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18298 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18299 } Elm_Genlist_Item_Flags;
18300 typedef enum _Elm_Genlist_Item_Field_Flags
18302 ELM_GENLIST_ITEM_FIELD_ALL = 0,
18303 ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
18304 ELM_GENLIST_ITEM_FIELD_ICON = (1 << 1),
18305 ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
18306 } Elm_Genlist_Item_Field_Flags;
18307 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
18308 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18309 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
18310 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
18311 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
18312 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
18313 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj);
18314 typedef void (*GenlistItemMovedFunc) ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
18317 * @struct _Elm_Genlist_Item_Class
18319 * Genlist item class definition structs.
18321 * This struct contains the style and fetching functions that will define the
18322 * contents of each item.
18324 * @see @ref Genlist_Item_Class
18326 struct _Elm_Genlist_Item_Class
18328 const char *item_style;
18330 GenlistItemLabelGetFunc label_get;
18331 GenlistItemIconGetFunc icon_get;
18332 GenlistItemStateGetFunc state_get;
18333 GenlistItemDelFunc del;
18334 GenlistItemMovedFunc moved;
18336 const char *edit_item_style;
18337 const char *mode_item_style;
18339 #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18341 * Add a new genlist widget to the given parent Elementary
18342 * (container) object
18344 * @param parent The parent object
18345 * @return a new genlist widget handle or @c NULL, on errors
18347 * This function inserts a new genlist widget on the canvas.
18349 * @see elm_genlist_item_append()
18350 * @see elm_genlist_item_del()
18351 * @see elm_genlist_clear()
18355 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18357 * Remove all items from a given genlist widget.
18359 * @param obj The genlist object
18361 * This removes (and deletes) all items in @p obj, leaving it empty.
18363 * @see elm_genlist_item_del(), to remove just one item.
18367 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18369 * Enable or disable multi-selection in the genlist
18371 * @param obj The genlist object
18372 * @param multi Multi-select enable/disable. Default is disabled.
18374 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18375 * the list. This allows more than 1 item to be selected. To retrieve the list
18376 * of selected items, use elm_genlist_selected_items_get().
18378 * @see elm_genlist_selected_items_get()
18379 * @see elm_genlist_multi_select_get()
18383 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18385 * Gets if multi-selection in genlist is enabled or disabled.
18387 * @param obj The genlist object
18388 * @return Multi-select enabled/disabled
18389 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18391 * @see elm_genlist_multi_select_set()
18395 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18397 * This sets the horizontal stretching mode.
18399 * @param obj The genlist object
18400 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18402 * This sets the mode used for sizing items horizontally. Valid modes
18403 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18404 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18405 * the scroller will scroll horizontally. Otherwise items are expanded
18406 * to fill the width of the viewport of the scroller. If it is
18407 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18408 * limited to that size.
18410 * @see elm_genlist_horizontal_get()
18414 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18416 * Gets the horizontal stretching mode.
18418 * @param obj The genlist object
18419 * @return The mode to use
18420 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18422 * @see elm_genlist_horizontal_set()
18426 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18428 * Set the always select mode.
18430 * @param obj The genlist object
18431 * @param always_select The always select mode (@c EINA_TRUE = on, @c
18432 * EINA_FALSE = off). Default is @c EINA_FALSE.
18434 * Items will only call their selection func and callback when first
18435 * becoming selected. Any further clicks will do nothing, unless you
18436 * enable always select with elm_genlist_always_select_mode_set().
18437 * This means that, even if selected, every click will make the selected
18438 * callbacks be called.
18440 * @see elm_genlist_always_select_mode_get()
18444 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18446 * Get the always select mode.
18448 * @param obj The genlist object
18449 * @return The always select mode
18450 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18452 * @see elm_genlist_always_select_mode_set()
18456 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18458 * Enable/disable the no select mode.
18460 * @param obj The genlist object
18461 * @param no_select The no select mode
18462 * (EINA_TRUE = on, EINA_FALSE = off)
18464 * This will turn off the ability to select items entirely and they
18465 * will neither appear selected nor call selected callback functions.
18467 * @see elm_genlist_no_select_mode_get()
18471 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18473 * Gets whether the no select mode is enabled.
18475 * @param obj The genlist object
18476 * @return The no select mode
18477 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18479 * @see elm_genlist_no_select_mode_set()
18483 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18485 * Enable/disable compress mode.
18487 * @param obj The genlist object
18488 * @param compress The compress mode
18489 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18491 * This will enable the compress mode where items are "compressed"
18492 * horizontally to fit the genlist scrollable viewport width. This is
18493 * special for genlist. Do not rely on
18494 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18495 * work as genlist needs to handle it specially.
18497 * @see elm_genlist_compress_mode_get()
18501 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18503 * Get whether the compress mode is enabled.
18505 * @param obj The genlist object
18506 * @return The compress mode
18507 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18509 * @see elm_genlist_compress_mode_set()
18513 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18515 * Enable/disable height-for-width mode.
18517 * @param obj The genlist object
18518 * @param setting The height-for-width mode (@c EINA_TRUE = on,
18519 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18521 * With height-for-width mode the item width will be fixed (restricted
18522 * to a minimum of) to the list width when calculating its size in
18523 * order to allow the height to be calculated based on it. This allows,
18524 * for instance, text block to wrap lines if the Edje part is
18525 * configured with "text.min: 0 1".
18527 * @note This mode will make list resize slower as it will have to
18528 * recalculate every item height again whenever the list width
18531 * @note When height-for-width mode is enabled, it also enables
18532 * compress mode (see elm_genlist_compress_mode_set()) and
18533 * disables homogeneous (see elm_genlist_homogeneous_set()).
18537 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18539 * Get whether the height-for-width mode is enabled.
18541 * @param obj The genlist object
18542 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18547 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18549 * Enable/disable horizontal and vertical bouncing effect.
18551 * @param obj The genlist object
18552 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18553 * EINA_FALSE = off). Default is @c EINA_FALSE.
18554 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18555 * EINA_FALSE = off). Default is @c EINA_TRUE.
18557 * This will enable or disable the scroller bouncing effect for the
18558 * genlist. See elm_scroller_bounce_set() for details.
18560 * @see elm_scroller_bounce_set()
18561 * @see elm_genlist_bounce_get()
18565 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18567 * Get whether the horizontal and vertical bouncing effect is enabled.
18569 * @param obj The genlist object
18570 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18572 * @param v_bounce Pointer to a bool to receive if the bounce vertically
18575 * @see elm_genlist_bounce_set()
18579 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18581 * Enable/disable homogenous mode.
18583 * @param obj The genlist object
18584 * @param homogeneous Assume the items within the genlist are of the
18585 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18588 * This will enable the homogeneous mode where items are of the same
18589 * height and width so that genlist may do the lazy-loading at its
18590 * maximum (which increases the performance for scrolling the list). This
18591 * implies 'compressed' mode.
18593 * @see elm_genlist_compress_mode_set()
18594 * @see elm_genlist_homogeneous_get()
18598 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18600 * Get whether the homogenous mode is enabled.
18602 * @param obj The genlist object
18603 * @return Assume the items within the genlist are of the same height
18604 * and width (EINA_TRUE = on, EINA_FALSE = off)
18606 * @see elm_genlist_homogeneous_set()
18610 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18612 * Set the maximum number of items within an item block
18614 * @param obj The genlist object
18615 * @param n Maximum number of items within an item block. Default is 32.
18617 * This will configure the block count to tune to the target with
18618 * particular performance matrix.
18620 * A block of objects will be used to reduce the number of operations due to
18621 * many objects in the screen. It can determine the visibility, or if the
18622 * object has changed, it theme needs to be updated, etc. doing this kind of
18623 * calculation to the entire block, instead of per object.
18625 * The default value for the block count is enough for most lists, so unless
18626 * you know you will have a lot of objects visible in the screen at the same
18627 * time, don't try to change this.
18629 * @see elm_genlist_block_count_get()
18630 * @see @ref Genlist_Implementation
18634 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18636 * Get the maximum number of items within an item block
18638 * @param obj The genlist object
18639 * @return Maximum number of items within an item block
18641 * @see elm_genlist_block_count_set()
18645 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18647 * Set the timeout in seconds for the longpress event.
18649 * @param obj The genlist object
18650 * @param timeout timeout in seconds. Default is 1.
18652 * This option will change how long it takes to send an event "longpressed"
18653 * after the mouse down signal is sent to the list. If this event occurs, no
18654 * "clicked" event will be sent.
18656 * @see elm_genlist_longpress_timeout_set()
18660 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18662 * Get the timeout in seconds for the longpress event.
18664 * @param obj The genlist object
18665 * @return timeout in seconds
18667 * @see elm_genlist_longpress_timeout_get()
18671 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18673 * Append a new item in a given genlist widget.
18675 * @param obj The genlist object
18676 * @param itc The item class for the item
18677 * @param data The item data
18678 * @param parent The parent item, or NULL if none
18679 * @param flags Item flags
18680 * @param func Convenience function called when the item is selected
18681 * @param func_data Data passed to @p func above.
18682 * @return A handle to the item added or @c NULL if not possible
18684 * This adds the given item to the end of the list or the end of
18685 * the children list if the @p parent is given.
18687 * @see elm_genlist_item_prepend()
18688 * @see elm_genlist_item_insert_before()
18689 * @see elm_genlist_item_insert_after()
18690 * @see elm_genlist_item_del()
18694 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);
18696 * Prepend a new item in a given genlist widget.
18698 * @param obj The genlist object
18699 * @param itc The item class for the item
18700 * @param data The item data
18701 * @param parent The parent item, or NULL if none
18702 * @param flags Item flags
18703 * @param func Convenience function called when the item is selected
18704 * @param func_data Data passed to @p func above.
18705 * @return A handle to the item added or NULL if not possible
18707 * This adds an item to the beginning of the list or beginning of the
18708 * children of the parent if given.
18710 * @see elm_genlist_item_append()
18711 * @see elm_genlist_item_insert_before()
18712 * @see elm_genlist_item_insert_after()
18713 * @see elm_genlist_item_del()
18717 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);
18719 * Insert an item before another in a genlist widget
18721 * @param obj The genlist object
18722 * @param itc The item class for the item
18723 * @param data The item data
18724 * @param before The item to place this new one before.
18725 * @param flags Item flags
18726 * @param func Convenience function called when the item is selected
18727 * @param func_data Data passed to @p func above.
18728 * @return A handle to the item added or @c NULL if not possible
18730 * This inserts an item before another in the list. It will be in the
18731 * same tree level or group as the item it is inserted before.
18733 * @see elm_genlist_item_append()
18734 * @see elm_genlist_item_prepend()
18735 * @see elm_genlist_item_insert_after()
18736 * @see elm_genlist_item_del()
18740 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);
18742 * Insert an item after another in a genlist widget
18744 * @param obj The genlist object
18745 * @param itc The item class for the item
18746 * @param data The item data
18747 * @param after The item to place this new one after.
18748 * @param flags Item flags
18749 * @param func Convenience function called when the item is selected
18750 * @param func_data Data passed to @p func above.
18751 * @return A handle to the item added or @c NULL if not possible
18753 * This inserts an item after another in the list. It will be in the
18754 * same tree level or group as the item it is inserted after.
18756 * @see elm_genlist_item_append()
18757 * @see elm_genlist_item_prepend()
18758 * @see elm_genlist_item_insert_before()
18759 * @see elm_genlist_item_del()
18763 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);
18765 * Insert a new item into the sorted genlist object
18767 * @param obj The genlist object
18768 * @param itc The item class for the item
18769 * @param data The item data
18770 * @param parent The parent item, or NULL if none
18771 * @param flags Item flags
18772 * @param comp The function called for the sort
18773 * @param func Convenience function called when item selected
18774 * @param func_data Data passed to @p func above.
18775 * @return A handle to the item added or NULL if not possible
18779 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);
18780 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);
18781 /* operations to retrieve existing items */
18783 * Get the selectd item in the genlist.
18785 * @param obj The genlist object
18786 * @return The selected item, or NULL if none is selected.
18788 * This gets the selected item in the list (if multi-selection is enabled, only
18789 * the item that was first selected in the list is returned - which is not very
18790 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18793 * If no item is selected, NULL is returned.
18795 * @see elm_genlist_selected_items_get()
18799 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18801 * Get a list of selected items in the genlist.
18803 * @param obj The genlist object
18804 * @return The list of selected items, or NULL if none are selected.
18806 * It returns a list of the selected items. This list pointer is only valid so
18807 * long as the selection doesn't change (no items are selected or unselected, or
18808 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18809 * pointers. The order of the items in this list is the order which they were
18810 * selected, i.e. the first item in this list is the first item that was
18811 * selected, and so on.
18813 * @note If not in multi-select mode, consider using function
18814 * elm_genlist_selected_item_get() instead.
18816 * @see elm_genlist_multi_select_set()
18817 * @see elm_genlist_selected_item_get()
18821 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18823 * Get the mode item style of items in the genlist
18824 * @param obj The genlist object
18825 * @return The mode item style string, or NULL if none is specified
18827 * This is a constant string and simply defines the name of the
18828 * style that will be used for mode animations. It can be
18829 * @c NULL if you don't plan to use Genlist mode. See
18830 * elm_genlist_item_mode_set() for more info.
18834 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18836 * Set the mode item style of items in the genlist
18837 * @param obj The genlist object
18838 * @param style The mode item style string, or NULL if none is desired
18840 * This is a constant string and simply defines the name of the
18841 * style that will be used for mode animations. It can be
18842 * @c NULL if you don't plan to use Genlist mode. See
18843 * elm_genlist_item_mode_set() for more info.
18847 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
18849 * Get a list of realized items in genlist
18851 * @param obj The genlist object
18852 * @return The list of realized items, nor NULL if none are realized.
18854 * This returns a list of the realized items in the genlist. The list
18855 * contains Elm_Genlist_Item pointers. The list must be freed by the
18856 * caller when done with eina_list_free(). The item pointers in the
18857 * list are only valid so long as those items are not deleted or the
18858 * genlist is not deleted.
18860 * @see elm_genlist_realized_items_update()
18864 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18866 * Get the item that is at the x, y canvas coords.
18868 * @param obj The gelinst object.
18869 * @param x The input x coordinate
18870 * @param y The input y coordinate
18871 * @param posret The position relative to the item returned here
18872 * @return The item at the coordinates or NULL if none
18874 * This returns the item at the given coordinates (which are canvas
18875 * relative, not object-relative). If an item is at that coordinate,
18876 * that item handle is returned, and if @p posret is not NULL, the
18877 * integer pointed to is set to a value of -1, 0 or 1, depending if
18878 * the coordinate is on the upper portion of that item (-1), on the
18879 * middle section (0) or on the lower part (1). If NULL is returned as
18880 * an item (no item found there), then posret may indicate -1 or 1
18881 * based if the coordinate is above or below all items respectively in
18886 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);
18888 * Get the first item in the genlist
18890 * This returns the first item in the list.
18892 * @param obj The genlist object
18893 * @return The first item, or NULL if none
18897 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18899 * Get the last item in the genlist
18901 * This returns the last item in the list.
18903 * @return The last item, or NULL if none
18907 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18909 * Set the scrollbar policy
18911 * @param obj The genlist object
18912 * @param policy_h Horizontal scrollbar policy.
18913 * @param policy_v Vertical scrollbar policy.
18915 * This sets the scrollbar visibility policy for the given genlist
18916 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
18917 * made visible if it is needed, and otherwise kept hidden.
18918 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
18919 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
18920 * respectively for the horizontal and vertical scrollbars. Default is
18921 * #ELM_SMART_SCROLLER_POLICY_AUTO
18923 * @see elm_genlist_scroller_policy_get()
18927 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
18929 * Get the scrollbar policy
18931 * @param obj The genlist object
18932 * @param policy_h Pointer to store the horizontal scrollbar policy.
18933 * @param policy_v Pointer to store the vertical scrollbar policy.
18935 * @see elm_genlist_scroller_policy_set()
18939 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);
18941 * Get the @b next item in a genlist widget's internal list of items,
18942 * given a handle to one of those items.
18944 * @param item The genlist item to fetch next from
18945 * @return The item after @p item, or @c NULL if there's none (and
18948 * This returns the item placed after the @p item, on the container
18951 * @see elm_genlist_item_prev_get()
18955 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18957 * Get the @b previous item in a genlist widget's internal list of items,
18958 * given a handle to one of those items.
18960 * @param item The genlist item to fetch previous from
18961 * @return The item before @p item, or @c NULL if there's none (and
18964 * This returns the item placed before the @p item, on the container
18967 * @see elm_genlist_item_next_get()
18971 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18973 * Get the genlist object's handle which contains a given genlist
18976 * @param item The item to fetch the container from
18977 * @return The genlist (parent) object
18979 * This returns the genlist object itself that an item belongs to.
18983 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18985 * Get the parent item of the given item
18987 * @param it The item
18988 * @return The parent of the item or @c NULL if it has no parent.
18990 * This returns the item that was specified as parent of the item @p it on
18991 * elm_genlist_item_append() and insertion related functions.
18995 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18997 * Remove all sub-items (children) of the given item
18999 * @param it The item
19001 * This removes all items that are children (and their descendants) of the
19002 * given item @p it.
19004 * @see elm_genlist_clear()
19005 * @see elm_genlist_item_del()
19009 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19011 * Set whether a given genlist item is selected or not
19013 * @param it The item
19014 * @param selected Use @c EINA_TRUE, to make it selected, @c
19015 * EINA_FALSE to make it unselected
19017 * This sets the selected state of an item. If multi selection is
19018 * not enabled on the containing genlist and @p selected is @c
19019 * EINA_TRUE, any other previously selected items will get
19020 * unselected in favor of this new one.
19022 * @see elm_genlist_item_selected_get()
19026 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
19028 * Get whether a given genlist item is selected or not
19030 * @param it The item
19031 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
19033 * @see elm_genlist_item_selected_set() for more details
19037 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19039 * Sets the expanded state of an item.
19041 * @param it The item
19042 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
19044 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19047 * The theme will respond to this change visually, and a signal "expanded" or
19048 * "contracted" will be sent from the genlist with a pointer to the item that
19049 * has been expanded/contracted.
19051 * Calling this function won't show or hide any child of this item (if it is
19052 * a parent). You must manually delete and create them on the callbacks fo
19053 * the "expanded" or "contracted" signals.
19055 * @see elm_genlist_item_expanded_get()
19059 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19061 * Get the expanded state of an item
19063 * @param it The item
19064 * @return The expanded state
19066 * This gets the expanded state of an item.
19068 * @see elm_genlist_item_expanded_set()
19072 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19074 * Get the depth of expanded item
19076 * @param it The genlist item object
19077 * @return The depth of expanded item
19081 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19083 * Set whether a given genlist item is disabled or not.
19085 * @param it The item
19086 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19087 * to enable it back.
19089 * A disabled item cannot be selected or unselected. It will also
19090 * change its appearance, to signal the user it's disabled.
19092 * @see elm_genlist_item_disabled_get()
19096 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19098 * Get whether a given genlist item is disabled or not.
19100 * @param it The item
19101 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19104 * @see elm_genlist_item_disabled_set() for more details
19108 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19110 * Sets the display only state of an item.
19112 * @param it The item
19113 * @param display_only @c EINA_TRUE if the item is display only, @c
19114 * EINA_FALSE otherwise.
19116 * A display only item cannot be selected or unselected. It is for
19117 * display only and not selecting or otherwise clicking, dragging
19118 * etc. by the user, thus finger size rules will not be applied to
19121 * It's good to set group index items to display only state.
19123 * @see elm_genlist_item_display_only_get()
19127 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19129 * Get the display only state of an item
19131 * @param it The item
19132 * @return @c EINA_TRUE if the item is display only, @c
19133 * EINA_FALSE otherwise.
19135 * @see elm_genlist_item_display_only_set()
19139 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19141 * Show the portion of a genlist's internal list containing a given
19142 * item, immediately.
19144 * @param it The item to display
19146 * This causes genlist to jump to the given item @p it and show it (by
19147 * immediately scrolling to that position), if it is not fully visible.
19149 * @see elm_genlist_item_bring_in()
19150 * @see elm_genlist_item_top_show()
19151 * @see elm_genlist_item_middle_show()
19155 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19157 * Animatedly bring in, to the visible are of a genlist, a given
19160 * @param it The item to display
19162 * This causes genlist to jump to the given item @p it and show it (by
19163 * animatedly scrolling), if it is not fully visible. This may use animation
19164 * to do so and take a period of time
19166 * @see elm_genlist_item_show()
19167 * @see elm_genlist_item_top_bring_in()
19168 * @see elm_genlist_item_middle_bring_in()
19172 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19174 * Show the portion of a genlist's internal list containing a given
19175 * item, immediately.
19177 * @param it The item to display
19179 * This causes genlist to jump to the given item @p it and show it (by
19180 * immediately scrolling to that position), if it is not fully visible.
19182 * The item will be positioned at the top of the genlist viewport.
19184 * @see elm_genlist_item_show()
19185 * @see elm_genlist_item_top_bring_in()
19189 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19191 * Animatedly bring in, to the visible are of a genlist, a given
19194 * @param it The item
19196 * This causes genlist to jump to the given item @p it and show it (by
19197 * animatedly scrolling), if it is not fully visible. This may use animation
19198 * to do so and take a period of time
19200 * The item will be positioned at the top of the genlist viewport.
19202 * @see elm_genlist_item_bring_in()
19203 * @see elm_genlist_item_top_show()
19207 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19209 * Show the portion of a genlist's internal list containing a given
19210 * item, immediately.
19212 * @param it The item to display
19214 * This causes genlist to jump to the given item @p it and show it (by
19215 * immediately scrolling to that position), if it is not fully visible.
19217 * The item will be positioned at the middle of the genlist viewport.
19219 * @see elm_genlist_item_show()
19220 * @see elm_genlist_item_middle_bring_in()
19224 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19226 * Animatedly bring in, to the visible are of a genlist, a given
19229 * @param it The item
19231 * This causes genlist to jump to the given item @p it and show it (by
19232 * animatedly scrolling), if it is not fully visible. This may use animation
19233 * to do so and take a period of time
19235 * The item will be positioned at the middle of the genlist viewport.
19237 * @see elm_genlist_item_bring_in()
19238 * @see elm_genlist_item_middle_show()
19242 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19244 * Remove a genlist item from the its parent, deleting it.
19246 * @param item The item to be removed.
19247 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19249 * @see elm_genlist_clear(), to remove all items in a genlist at
19254 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19256 * Return the data associated to a given genlist item
19258 * @param item The genlist item.
19259 * @return the data associated to this item.
19261 * This returns the @c data value passed on the
19262 * elm_genlist_item_append() and related item addition calls.
19264 * @see elm_genlist_item_append()
19265 * @see elm_genlist_item_data_set()
19269 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19271 * Set the data associated to a given genlist item
19273 * @param item The genlist item
19274 * @param data The new data pointer to set on it
19276 * This @b overrides the @c data value passed on the
19277 * elm_genlist_item_append() and related item addition calls. This
19278 * function @b won't call elm_genlist_item_update() automatically,
19279 * so you'd issue it afterwards if you want to hove the item
19280 * updated to reflect the that new data.
19282 * @see elm_genlist_item_data_get()
19286 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19288 * Tells genlist to "orphan" icons fetchs by the item class
19290 * @param it The item
19292 * This instructs genlist to release references to icons in the item,
19293 * meaning that they will no longer be managed by genlist and are
19294 * floating "orphans" that can be re-used elsewhere if the user wants
19299 EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19300 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19302 * Get the real Evas object created to implement the view of a
19303 * given genlist item
19305 * @param item The genlist item.
19306 * @return the Evas object implementing this item's view.
19308 * This returns the actual Evas object used to implement the
19309 * specified genlist item's view. This may be @c NULL, as it may
19310 * not have been created or may have been deleted, at any time, by
19311 * the genlist. <b>Do not modify this object</b> (move, resize,
19312 * show, hide, etc.), as the genlist is controlling it. This
19313 * function is for querying, emitting custom signals or hooking
19314 * lower level callbacks for events on that object. Do not delete
19315 * this object under any circumstances.
19317 * @see elm_genlist_item_data_get()
19321 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19323 * Update the contents of an item
19325 * @param it The item
19327 * This updates an item by calling all the item class functions again
19328 * to get the icons, labels and states. Use this when the original
19329 * item data has changed and the changes are desired to be reflected.
19331 * Use elm_genlist_realized_items_update() to update all already realized
19334 * @see elm_genlist_realized_items_update()
19338 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19339 EAPI void elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
19341 * Update the item class of an item
19343 * @param it The item
19344 * @param itc The item class for the item
19346 * This sets another class fo the item, changing the way that it is
19347 * displayed. After changing the item class, elm_genlist_item_update() is
19348 * called on the item @p it.
19352 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19353 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19355 * Set the text to be shown in a given genlist item's tooltips.
19357 * @param item The genlist item
19358 * @param text The text to set in the content
19360 * This call will setup the text to be used as tooltip to that item
19361 * (analogous to elm_object_tooltip_text_set(), but being item
19362 * tooltips with higher precedence than object tooltips). It can
19363 * have only one tooltip at a time, so any previous tooltip data
19364 * will get removed.
19366 * In order to set an icon or something else as a tooltip, look at
19367 * elm_genlist_item_tooltip_content_cb_set().
19371 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19373 * Set the content to be shown in a given genlist item's tooltips
19375 * @param item The genlist item.
19376 * @param func The function returning the tooltip contents.
19377 * @param data What to provide to @a func as callback data/context.
19378 * @param del_cb Called when data is not needed anymore, either when
19379 * another callback replaces @p func, the tooltip is unset with
19380 * elm_genlist_item_tooltip_unset() or the owner @p item
19381 * dies. This callback receives as its first parameter the
19382 * given @p data, being @c event_info the item handle.
19384 * This call will setup the tooltip's contents to @p item
19385 * (analogous to elm_object_tooltip_content_cb_set(), but being
19386 * item tooltips with higher precedence than object tooltips). It
19387 * can have only one tooltip at a time, so any previous tooltip
19388 * content will get removed. @p func (with @p data) will be called
19389 * every time Elementary needs to show the tooltip and it should
19390 * return a valid Evas object, which will be fully managed by the
19391 * tooltip system, getting deleted when the tooltip is gone.
19393 * In order to set just a text as a tooltip, look at
19394 * elm_genlist_item_tooltip_text_set().
19398 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);
19400 * Unset a tooltip from a given genlist item
19402 * @param item genlist item to remove a previously set tooltip from.
19404 * This call removes any tooltip set on @p item. The callback
19405 * provided as @c del_cb to
19406 * elm_genlist_item_tooltip_content_cb_set() will be called to
19407 * notify it is not used anymore (and have resources cleaned, if
19410 * @see elm_genlist_item_tooltip_content_cb_set()
19414 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19416 * Set a different @b style for a given genlist item's tooltip.
19418 * @param item genlist item with tooltip set
19419 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19420 * "default", @c "transparent", etc)
19422 * Tooltips can have <b>alternate styles</b> to be displayed on,
19423 * which are defined by the theme set on Elementary. This function
19424 * works analogously as elm_object_tooltip_style_set(), but here
19425 * applied only to genlist item objects. The default style for
19426 * tooltips is @c "default".
19428 * @note before you set a style you should define a tooltip with
19429 * elm_genlist_item_tooltip_content_cb_set() or
19430 * elm_genlist_item_tooltip_text_set()
19432 * @see elm_genlist_item_tooltip_style_get()
19436 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19438 * Get the style set a given genlist item's tooltip.
19440 * @param item genlist item with tooltip already set on.
19441 * @return style the theme style in use, which defaults to
19442 * "default". If the object does not have a tooltip set,
19443 * then @c NULL is returned.
19445 * @see elm_genlist_item_tooltip_style_set() for more details
19449 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19451 * Set the type of mouse pointer/cursor decoration to be shown,
19452 * when the mouse pointer is over the given genlist widget item
19454 * @param item genlist item to customize cursor on
19455 * @param cursor the cursor type's name
19457 * This function works analogously as elm_object_cursor_set(), but
19458 * here the cursor's changing area is restricted to the item's
19459 * area, and not the whole widget's. Note that that item cursors
19460 * have precedence over widget cursors, so that a mouse over @p
19461 * item will always show cursor @p type.
19463 * If this function is called twice for an object, a previously set
19464 * cursor will be unset on the second call.
19466 * @see elm_object_cursor_set()
19467 * @see elm_genlist_item_cursor_get()
19468 * @see elm_genlist_item_cursor_unset()
19472 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19474 * Get the type of mouse pointer/cursor decoration set to be shown,
19475 * when the mouse pointer is over the given genlist widget item
19477 * @param item genlist item with custom cursor set
19478 * @return the cursor type's name or @c NULL, if no custom cursors
19479 * were set to @p item (and on errors)
19481 * @see elm_object_cursor_get()
19482 * @see elm_genlist_item_cursor_set() for more details
19483 * @see elm_genlist_item_cursor_unset()
19487 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19489 * Unset any custom mouse pointer/cursor decoration set to be
19490 * shown, when the mouse pointer is over the given genlist widget
19491 * item, thus making it show the @b default cursor again.
19493 * @param item a genlist item
19495 * Use this call to undo any custom settings on this item's cursor
19496 * decoration, bringing it back to defaults (no custom style set).
19498 * @see elm_object_cursor_unset()
19499 * @see elm_genlist_item_cursor_set() for more details
19503 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19505 * Set a different @b style for a given custom cursor set for a
19508 * @param item genlist item with custom cursor set
19509 * @param style the <b>theme style</b> to use (e.g. @c "default",
19510 * @c "transparent", etc)
19512 * This function only makes sense when one is using custom mouse
19513 * cursor decorations <b>defined in a theme file</b> , which can
19514 * have, given a cursor name/type, <b>alternate styles</b> on
19515 * it. It works analogously as elm_object_cursor_style_set(), but
19516 * here applied only to genlist item objects.
19518 * @warning Before you set a cursor style you should have defined a
19519 * custom cursor previously on the item, with
19520 * elm_genlist_item_cursor_set()
19522 * @see elm_genlist_item_cursor_engine_only_set()
19523 * @see elm_genlist_item_cursor_style_get()
19527 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19529 * Get the current @b style set for a given genlist item's custom
19532 * @param item genlist item with custom cursor set.
19533 * @return style the cursor style in use. If the object does not
19534 * have a cursor set, then @c NULL is returned.
19536 * @see elm_genlist_item_cursor_style_set() for more details
19540 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19542 * Set if the (custom) cursor for a given genlist item should be
19543 * searched in its theme, also, or should only rely on the
19544 * rendering engine.
19546 * @param item item with custom (custom) cursor already set on
19547 * @param engine_only Use @c EINA_TRUE to have cursors looked for
19548 * only on those provided by the rendering engine, @c EINA_FALSE to
19549 * have them searched on the widget's theme, as well.
19551 * @note This call is of use only if you've set a custom cursor
19552 * for genlist items, with elm_genlist_item_cursor_set().
19554 * @note By default, cursors will only be looked for between those
19555 * provided by the rendering engine.
19559 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19561 * Get if the (custom) cursor for a given genlist item is being
19562 * searched in its theme, also, or is only relying on the rendering
19565 * @param item a genlist item
19566 * @return @c EINA_TRUE, if cursors are being looked for only on
19567 * those provided by the rendering engine, @c EINA_FALSE if they
19568 * are being searched on the widget's theme, as well.
19570 * @see elm_genlist_item_cursor_engine_only_set(), for more details
19574 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19576 * Update the contents of all realized items.
19578 * @param obj The genlist object.
19580 * This updates all realized items by calling all the item class functions again
19581 * to get the icons, labels and states. Use this when the original
19582 * item data has changed and the changes are desired to be reflected.
19584 * To update just one item, use elm_genlist_item_update().
19586 * @see elm_genlist_realized_items_get()
19587 * @see elm_genlist_item_update()
19591 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19593 * Activate a genlist mode on an item
19595 * @param item The genlist item
19596 * @param mode Mode name
19597 * @param mode_set Boolean to define set or unset mode.
19599 * A genlist mode is a different way of selecting an item. Once a mode is
19600 * activated on an item, any other selected item is immediately unselected.
19601 * This feature provides an easy way of implementing a new kind of animation
19602 * for selecting an item, without having to entirely rewrite the item style
19603 * theme. However, the elm_genlist_selected_* API can't be used to get what
19604 * item is activate for a mode.
19606 * The current item style will still be used, but applying a genlist mode to
19607 * an item will select it using a different kind of animation.
19609 * The current active item for a mode can be found by
19610 * elm_genlist_mode_item_get().
19612 * The characteristics of genlist mode are:
19613 * - Only one mode can be active at any time, and for only one item.
19614 * - Genlist handles deactivating other items when one item is activated.
19615 * - A mode is defined in the genlist theme (edc), and more modes can easily
19617 * - A mode style and the genlist item style are different things. They
19618 * can be combined to provide a default style to the item, with some kind
19619 * of animation for that item when the mode is activated.
19621 * When a mode is activated on an item, a new view for that item is created.
19622 * The theme of this mode defines the animation that will be used to transit
19623 * the item from the old view to the new view. This second (new) view will be
19624 * active for that item while the mode is active on the item, and will be
19625 * destroyed after the mode is totally deactivated from that item.
19627 * @see elm_genlist_mode_get()
19628 * @see elm_genlist_mode_item_get()
19632 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19634 * Get the last (or current) genlist mode used.
19636 * @param obj The genlist object
19638 * This function just returns the name of the last used genlist mode. It will
19639 * be the current mode if it's still active.
19641 * @see elm_genlist_item_mode_set()
19642 * @see elm_genlist_mode_item_get()
19646 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19648 * Get active genlist mode item
19650 * @param obj The genlist object
19651 * @return The active item for that current mode. Or @c NULL if no item is
19652 * activated with any mode.
19654 * This function returns the item that was activated with a mode, by the
19655 * function elm_genlist_item_mode_set().
19657 * @see elm_genlist_item_mode_set()
19658 * @see elm_genlist_mode_get()
19662 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19667 * @param obj The genlist object
19668 * @param reorder_mode The reorder mode
19669 * (EINA_TRUE = on, EINA_FALSE = off)
19673 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19676 * Get the reorder mode
19678 * @param obj The genlist object
19679 * @return The reorder mode
19680 * (EINA_TRUE = on, EINA_FALSE = off)
19684 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19686 EAPI void elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
19687 EAPI Eina_Bool elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19688 EAPI void elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
19689 EAPI Eina_Bool elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19690 EAPI void elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
19691 EAPI void elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
19692 EAPI void elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19693 EAPI void elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19694 EAPI void elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19695 EAPI Eina_Bool elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19702 * @defgroup Check Check
19704 * @image html img/widget/check/preview-00.png
19705 * @image latex img/widget/check/preview-00.eps
19706 * @image html img/widget/check/preview-01.png
19707 * @image latex img/widget/check/preview-01.eps
19708 * @image html img/widget/check/preview-02.png
19709 * @image latex img/widget/check/preview-02.eps
19711 * @brief The check widget allows for toggling a value between true and
19714 * Check objects are a lot like radio objects in layout and functionality
19715 * except they do not work as a group, but independently and only toggle the
19716 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19717 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19718 * returns the current state. For convenience, like the radio objects, you
19719 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19720 * for it to modify.
19722 * Signals that you can add callbacks for are:
19723 * "changed" - This is called whenever the user changes the state of one of
19724 * the check object(event_info is NULL).
19726 * Default contents parts of the check widget that you can use for are:
19727 * @li "elm.swallow.content" - A icon of the check
19729 * Default text parts of the check widget that you can use for are:
19730 * @li "elm.text" - Label of the check
19732 * @ref tutorial_check should give you a firm grasp of how to use this widget
19737 * @brief Add a new Check object
19739 * @param parent The parent object
19740 * @return The new object or NULL if it cannot be created
19742 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19744 * @brief Set the text label of the check object
19746 * @param obj The check object
19747 * @param label The text label string in UTF-8
19749 * @deprecated use elm_object_text_set() instead.
19751 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19753 * @brief Get the text label of the check object
19755 * @param obj The check object
19756 * @return The text label string in UTF-8
19758 * @deprecated use elm_object_text_get() instead.
19760 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19762 * @brief Set the icon object of the check object
19764 * @param obj The check object
19765 * @param icon The icon object
19767 * Once the icon object is set, a previously set one will be deleted.
19768 * If you want to keep that old content object, use the
19769 * elm_object_content_unset() function.
19771 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19773 * @brief Get the icon object of the check object
19775 * @param obj The check object
19776 * @return The icon object
19778 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19780 * @brief Unset the icon used for the check object
19782 * @param obj The check object
19783 * @return The icon object that was being used
19785 * Unparent and return the icon object which was set for this widget.
19787 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19789 * @brief Set the on/off state of the check object
19791 * @param obj The check object
19792 * @param state The state to use (1 == on, 0 == off)
19794 * This sets the state of the check. If set
19795 * with elm_check_state_pointer_set() the state of that variable is also
19796 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19798 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19800 * @brief Get the state of the check object
19802 * @param obj The check object
19803 * @return The boolean state
19805 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19807 * @brief Set a convenience pointer to a boolean to change
19809 * @param obj The check object
19810 * @param statep Pointer to the boolean to modify
19812 * This sets a pointer to a boolean, that, in addition to the check objects
19813 * state will also be modified directly. To stop setting the object pointed
19814 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19815 * then when this is called, the check objects state will also be modified to
19816 * reflect the value of the boolean @p statep points to, just like calling
19817 * elm_check_state_set().
19819 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19825 * @defgroup Radio Radio
19827 * @image html img/widget/radio/preview-00.png
19828 * @image latex img/widget/radio/preview-00.eps
19830 * @brief Radio is a widget that allows for 1 or more options to be displayed
19831 * and have the user choose only 1 of them.
19833 * A radio object contains an indicator, an optional Label and an optional
19834 * icon object. While it's possible to have a group of only one radio they,
19835 * are normally used in groups of 2 or more. To add a radio to a group use
19836 * elm_radio_group_add(). The radio object(s) will select from one of a set
19837 * of integer values, so any value they are configuring needs to be mapped to
19838 * a set of integers. To configure what value that radio object represents,
19839 * use elm_radio_state_value_set() to set the integer it represents. To set
19840 * the value the whole group(which one is currently selected) is to indicate
19841 * use elm_radio_value_set() on any group member, and to get the groups value
19842 * use elm_radio_value_get(). For convenience the radio objects are also able
19843 * to directly set an integer(int) to the value that is selected. To specify
19844 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
19845 * The radio objects will modify this directly. That implies the pointer must
19846 * point to valid memory for as long as the radio objects exist.
19848 * Signals that you can add callbacks for are:
19849 * @li changed - This is called whenever the user changes the state of one of
19850 * the radio objects within the group of radio objects that work together.
19852 * Default contents parts of the radio widget that you can use for are:
19853 * @li "elm.swallow.content" - A icon of the radio
19855 * @ref tutorial_radio show most of this API in action.
19859 * @brief Add a new radio to the parent
19861 * @param parent The parent object
19862 * @return The new object or NULL if it cannot be created
19864 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19866 * @brief Set the text label of the radio object
19868 * @param obj The radio object
19869 * @param label The text label string in UTF-8
19871 * @deprecated use elm_object_text_set() instead.
19873 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19875 * @brief Get the text label of the radio object
19877 * @param obj The radio object
19878 * @return The text label string in UTF-8
19880 * @deprecated use elm_object_text_set() instead.
19882 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19884 * @brief Set the icon object of the radio object
19886 * @param obj The radio object
19887 * @param icon The icon object
19889 * Once the icon object is set, a previously set one will be deleted. If you
19890 * want to keep that old content object, use the elm_radio_icon_unset()
19893 * @deprecated use elm_object_content_set() instead.
19895 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19897 * @brief Get the icon object of the radio object
19899 * @param obj The radio object
19900 * @return The icon object
19902 * @see elm_radio_icon_set()
19904 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19906 * @brief Unset the icon used for the radio object
19908 * @param obj The radio object
19909 * @return The icon object that was being used
19911 * Unparent and return the icon object which was set for this widget.
19913 * @see elm_radio_icon_set()
19914 * @deprecated use elm_object_content_unset() instead.
19916 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19918 * @brief Add this radio to a group of other radio objects
19920 * @param obj The radio object
19921 * @param group Any object whose group the @p obj is to join.
19923 * Radio objects work in groups. Each member should have a different integer
19924 * value assigned. In order to have them work as a group, they need to know
19925 * about each other. This adds the given radio object to the group of which
19926 * the group object indicated is a member.
19928 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
19930 * @brief Set the integer value that this radio object represents
19932 * @param obj The radio object
19933 * @param value The value to use if this radio object is selected
19935 * This sets the value of the radio.
19937 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19939 * @brief Get the integer value that this radio object represents
19941 * @param obj The radio object
19942 * @return The value used if this radio object is selected
19944 * This gets the value of the radio.
19946 * @see elm_radio_value_set()
19948 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19950 * @brief Set the value of the radio.
19952 * @param obj The radio object
19953 * @param value The value to use for the group
19955 * This sets the value of the radio group and will also set the value if
19956 * pointed to, to the value supplied, but will not call any callbacks.
19958 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19960 * @brief Get the state of the radio object
19962 * @param obj The radio object
19963 * @return The integer state
19965 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19967 * @brief Set a convenience pointer to a integer to change
19969 * @param obj The radio object
19970 * @param valuep Pointer to the integer to modify
19972 * This sets a pointer to a integer, that, in addition to the radio objects
19973 * state will also be modified directly. To stop setting the object pointed
19974 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
19975 * when this is called, the radio objects state will also be modified to
19976 * reflect the value of the integer valuep points to, just like calling
19977 * elm_radio_value_set().
19979 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
19985 * @defgroup Pager Pager
19987 * @image html img/widget/pager/preview-00.png
19988 * @image latex img/widget/pager/preview-00.eps
19990 * @brief Widget that allows flipping between 1 or more āpagesā of objects.
19992 * The flipping between āpagesā of objects is animated. All content in pager
19993 * is kept in a stack, the last content to be added will be on the top of the
19994 * stack(be visible).
19996 * Objects can be pushed or popped from the stack or deleted as normal.
19997 * Pushes and pops will animate (and a pop will delete the object once the
19998 * animation is finished). Any object already in the pager can be promoted to
19999 * the top(from its current stacking position) through the use of
20000 * elm_pager_content_promote(). Objects are pushed to the top with
20001 * elm_pager_content_push() and when the top item is no longer wanted, simply
20002 * pop it with elm_pager_content_pop() and it will also be deleted. If an
20003 * object is no longer needed and is not the top item, just delete it as
20004 * normal. You can query which objects are the top and bottom with
20005 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20007 * Signals that you can add callbacks for are:
20008 * "hide,finished" - when the previous page is hided
20010 * This widget has the following styles available:
20013 * @li fade_translucide
20014 * @li fade_invisible
20015 * @note This styles affect only the flipping animations, the appearance when
20016 * not animating is unaffected by styles.
20018 * @ref tutorial_pager gives a good overview of the usage of the API.
20022 * Add a new pager to the parent
20024 * @param parent The parent object
20025 * @return The new object or NULL if it cannot be created
20029 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20031 * @brief Push an object to the top of the pager stack (and show it).
20033 * @param obj The pager object
20034 * @param content The object to push
20036 * The object pushed becomes a child of the pager, it will be controlled and
20037 * deleted when the pager is deleted.
20039 * @note If the content is already in the stack use
20040 * elm_pager_content_promote().
20041 * @warning Using this function on @p content already in the stack results in
20042 * undefined behavior.
20044 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20046 * @brief Pop the object that is on top of the stack
20048 * @param obj The pager object
20050 * This pops the object that is on the top(visible) of the pager, makes it
20051 * disappear, then deletes the object. The object that was underneath it on
20052 * the stack will become visible.
20054 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20056 * @brief Moves an object already in the pager stack to the top of the stack.
20058 * @param obj The pager object
20059 * @param content The object to promote
20061 * This will take the @p content and move it to the top of the stack as
20062 * if it had been pushed there.
20064 * @note If the content isn't already in the stack use
20065 * elm_pager_content_push().
20066 * @warning Using this function on @p content not already in the stack
20067 * results in undefined behavior.
20069 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20071 * @brief Return the object at the bottom of the pager stack
20073 * @param obj The pager object
20074 * @return The bottom object or NULL if none
20076 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20078 * @brief Return the object at the top of the pager stack
20080 * @param obj The pager object
20081 * @return The top object or NULL if none
20083 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20085 EAPI void elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
20086 EINA_DEPRECATED EAPI void elm_pager_animation_disabled_set(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
20093 * @defgroup Slideshow Slideshow
20095 * @image html img/widget/slideshow/preview-00.png
20096 * @image latex img/widget/slideshow/preview-00.eps
20098 * This widget, as the name indicates, is a pre-made image
20099 * slideshow panel, with API functions acting on (child) image
20100 * items presentation. Between those actions, are:
20101 * - advance to next/previous image
20102 * - select the style of image transition animation
20103 * - set the exhibition time for each image
20104 * - start/stop the slideshow
20106 * The transition animations are defined in the widget's theme,
20107 * consequently new animations can be added without having to
20108 * update the widget's code.
20110 * @section Slideshow_Items Slideshow items
20112 * For slideshow items, just like for @ref Genlist "genlist" ones,
20113 * the user defines a @b classes, specifying functions that will be
20114 * called on the item's creation and deletion times.
20116 * The #Elm_Slideshow_Item_Class structure contains the following
20119 * - @c func.get - When an item is displayed, this function is
20120 * called, and it's where one should create the item object, de
20121 * facto. For example, the object can be a pure Evas image object
20122 * or an Elementary @ref Photocam "photocam" widget. See
20123 * #SlideshowItemGetFunc.
20124 * - @c func.del - When an item is no more displayed, this function
20125 * is called, where the user must delete any data associated to
20126 * the item. See #SlideshowItemDelFunc.
20128 * @section Slideshow_Caching Slideshow caching
20130 * The slideshow provides facilities to have items adjacent to the
20131 * one being displayed <b>already "realized"</b> (i.e. loaded) for
20132 * you, so that the system does not have to decode image data
20133 * anymore at the time it has to actually switch images on its
20134 * viewport. The user is able to set the numbers of items to be
20135 * cached @b before and @b after the current item, in the widget's
20138 * Smart events one can add callbacks for are:
20140 * - @c "changed" - when the slideshow switches its view to a new
20143 * List of examples for the slideshow widget:
20144 * @li @ref slideshow_example
20148 * @addtogroup Slideshow
20152 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20153 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20154 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
20155 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20156 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20159 * @struct _Elm_Slideshow_Item_Class
20161 * Slideshow item class definition. See @ref Slideshow_Items for
20164 struct _Elm_Slideshow_Item_Class
20166 struct _Elm_Slideshow_Item_Class_Func
20168 SlideshowItemGetFunc get;
20169 SlideshowItemDelFunc del;
20171 }; /**< #Elm_Slideshow_Item_Class member definitions */
20174 * Add a new slideshow widget to the given parent Elementary
20175 * (container) object
20177 * @param parent The parent object
20178 * @return A new slideshow widget handle or @c NULL, on errors
20180 * This function inserts a new slideshow widget on the canvas.
20182 * @ingroup Slideshow
20184 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20187 * Add (append) a new item in a given slideshow widget.
20189 * @param obj The slideshow object
20190 * @param itc The item class for the item
20191 * @param data The item's data
20192 * @return A handle to the item added or @c NULL, on errors
20194 * Add a new item to @p obj's internal list of items, appending it.
20195 * The item's class must contain the function really fetching the
20196 * image object to show for this item, which could be an Evas image
20197 * object or an Elementary photo, for example. The @p data
20198 * parameter is going to be passed to both class functions of the
20201 * @see #Elm_Slideshow_Item_Class
20202 * @see elm_slideshow_item_sorted_insert()
20204 * @ingroup Slideshow
20206 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20209 * Insert a new item into the given slideshow widget, using the @p func
20210 * function to sort items (by item handles).
20212 * @param obj The slideshow object
20213 * @param itc The item class for the item
20214 * @param data The item's data
20215 * @param func The comparing function to be used to sort slideshow
20216 * items <b>by #Elm_Slideshow_Item item handles</b>
20217 * @return Returns The slideshow item handle, on success, or
20218 * @c NULL, on errors
20220 * Add a new item to @p obj's internal list of items, in a position
20221 * determined by the @p func comparing function. The item's class
20222 * must contain the function really fetching the image object to
20223 * show for this item, which could be an Evas image object or an
20224 * Elementary photo, for example. The @p data parameter is going to
20225 * be passed to both class functions of the item.
20227 * @see #Elm_Slideshow_Item_Class
20228 * @see elm_slideshow_item_add()
20230 * @ingroup Slideshow
20232 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);
20235 * Display a given slideshow widget's item, programmatically.
20237 * @param obj The slideshow object
20238 * @param item The item to display on @p obj's viewport
20240 * The change between the current item and @p item will use the
20241 * transition @p obj is set to use (@see
20242 * elm_slideshow_transition_set()).
20244 * @ingroup Slideshow
20246 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20249 * Slide to the @b next item, in a given slideshow widget
20251 * @param obj The slideshow object
20253 * The sliding animation @p obj is set to use will be the
20254 * transition effect used, after this call is issued.
20256 * @note If the end of the slideshow's internal list of items is
20257 * reached, it'll wrap around to the list's beginning, again.
20259 * @ingroup Slideshow
20261 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20264 * Slide to the @b previous item, in a given slideshow widget
20266 * @param obj The slideshow object
20268 * The sliding animation @p obj is set to use will be the
20269 * transition effect used, after this call is issued.
20271 * @note If the beginning of the slideshow's internal list of items
20272 * is reached, it'll wrap around to the list's end, again.
20274 * @ingroup Slideshow
20276 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20279 * Returns the list of sliding transition/effect names available, for a
20280 * given slideshow widget.
20282 * @param obj The slideshow object
20283 * @return The list of transitions (list of @b stringshared strings
20286 * The transitions, which come from @p obj's theme, must be an EDC
20287 * data item named @c "transitions" on the theme file, with (prefix)
20288 * names of EDC programs actually implementing them.
20290 * The available transitions for slideshows on the default theme are:
20291 * - @c "fade" - the current item fades out, while the new one
20292 * fades in to the slideshow's viewport.
20293 * - @c "black_fade" - the current item fades to black, and just
20294 * then, the new item will fade in.
20295 * - @c "horizontal" - the current item slides horizontally, until
20296 * it gets out of the slideshow's viewport, while the new item
20297 * comes from the left to take its place.
20298 * - @c "vertical" - the current item slides vertically, until it
20299 * gets out of the slideshow's viewport, while the new item comes
20300 * from the bottom to take its place.
20301 * - @c "square" - the new item starts to appear from the middle of
20302 * the current one, but with a tiny size, growing until its
20303 * target (full) size and covering the old one.
20305 * @warning The stringshared strings get no new references
20306 * exclusive to the user grabbing the list, here, so if you'd like
20307 * to use them out of this call's context, you'd better @c
20308 * eina_stringshare_ref() them.
20310 * @see elm_slideshow_transition_set()
20312 * @ingroup Slideshow
20314 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20317 * Set the current slide transition/effect in use for a given
20320 * @param obj The slideshow object
20321 * @param transition The new transition's name string
20323 * If @p transition is implemented in @p obj's theme (i.e., is
20324 * contained in the list returned by
20325 * elm_slideshow_transitions_get()), this new sliding effect will
20326 * be used on the widget.
20328 * @see elm_slideshow_transitions_get() for more details
20330 * @ingroup Slideshow
20332 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20335 * Get the current slide transition/effect in use for a given
20338 * @param obj The slideshow object
20339 * @return The current transition's name
20341 * @see elm_slideshow_transition_set() for more details
20343 * @ingroup Slideshow
20345 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20348 * Set the interval between each image transition on a given
20349 * slideshow widget, <b>and start the slideshow, itself</b>
20351 * @param obj The slideshow object
20352 * @param timeout The new displaying timeout for images
20354 * After this call, the slideshow widget will start cycling its
20355 * view, sequentially and automatically, with the images of the
20356 * items it has. The time between each new image displayed is going
20357 * to be @p timeout, in @b seconds. If a different timeout was set
20358 * previously and an slideshow was in progress, it will continue
20359 * with the new time between transitions, after this call.
20361 * @note A value less than or equal to 0 on @p timeout will disable
20362 * the widget's internal timer, thus halting any slideshow which
20363 * could be happening on @p obj.
20365 * @see elm_slideshow_timeout_get()
20367 * @ingroup Slideshow
20369 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20372 * Get the interval set for image transitions on a given slideshow
20375 * @param obj The slideshow object
20376 * @return Returns the timeout set on it
20378 * @see elm_slideshow_timeout_set() for more details
20380 * @ingroup Slideshow
20382 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20385 * Set if, after a slideshow is started, for a given slideshow
20386 * widget, its items should be displayed cyclically or not.
20388 * @param obj The slideshow object
20389 * @param loop Use @c EINA_TRUE to make it cycle through items or
20390 * @c EINA_FALSE for it to stop at the end of @p obj's internal
20393 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20394 * ignore what is set by this functions, i.e., they'll @b always
20395 * cycle through items. This affects only the "automatic"
20396 * slideshow, as set by elm_slideshow_timeout_set().
20398 * @see elm_slideshow_loop_get()
20400 * @ingroup Slideshow
20402 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20405 * Get if, after a slideshow is started, for a given slideshow
20406 * widget, its items are to be displayed cyclically or not.
20408 * @param obj The slideshow object
20409 * @return @c EINA_TRUE, if the items in @p obj will be cycled
20410 * through or @c EINA_FALSE, otherwise
20412 * @see elm_slideshow_loop_set() for more details
20414 * @ingroup Slideshow
20416 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20419 * Remove all items from a given slideshow widget
20421 * @param obj The slideshow object
20423 * This removes (and deletes) all items in @p obj, leaving it
20426 * @see elm_slideshow_item_del(), to remove just one item.
20428 * @ingroup Slideshow
20430 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20433 * Get the internal list of items in a given slideshow widget.
20435 * @param obj The slideshow object
20436 * @return The list of items (#Elm_Slideshow_Item as data) or
20437 * @c NULL on errors.
20439 * This list is @b not to be modified in any way and must not be
20440 * freed. Use the list members with functions like
20441 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20443 * @warning This list is only valid until @p obj object's internal
20444 * items list is changed. It should be fetched again with another
20445 * call to this function when changes happen.
20447 * @ingroup Slideshow
20449 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20452 * Delete a given item from a slideshow widget.
20454 * @param item The slideshow item
20456 * @ingroup Slideshow
20458 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20461 * Return the data associated with a given slideshow item
20463 * @param item The slideshow item
20464 * @return Returns the data associated to this item
20466 * @ingroup Slideshow
20468 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20471 * Returns the currently displayed item, in a given slideshow widget
20473 * @param obj The slideshow object
20474 * @return A handle to the item being displayed in @p obj or
20475 * @c NULL, if none is (and on errors)
20477 * @ingroup Slideshow
20479 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20482 * Get the real Evas object created to implement the view of a
20483 * given slideshow item
20485 * @param item The slideshow item.
20486 * @return the Evas object implementing this item's view.
20488 * This returns the actual Evas object used to implement the
20489 * specified slideshow item's view. This may be @c NULL, as it may
20490 * not have been created or may have been deleted, at any time, by
20491 * the slideshow. <b>Do not modify this object</b> (move, resize,
20492 * show, hide, etc.), as the slideshow is controlling it. This
20493 * function is for querying, emitting custom signals or hooking
20494 * lower level callbacks for events on that object. Do not delete
20495 * this object under any circumstances.
20497 * @see elm_slideshow_item_data_get()
20499 * @ingroup Slideshow
20501 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20504 * Get the the item, in a given slideshow widget, placed at
20505 * position @p nth, in its internal items list
20507 * @param obj The slideshow object
20508 * @param nth The number of the item to grab a handle to (0 being
20510 * @return The item stored in @p obj at position @p nth or @c NULL,
20511 * if there's no item with that index (and on errors)
20513 * @ingroup Slideshow
20515 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20518 * Set the current slide layout in use for a given slideshow widget
20520 * @param obj The slideshow object
20521 * @param layout The new layout's name string
20523 * If @p layout is implemented in @p obj's theme (i.e., is contained
20524 * in the list returned by elm_slideshow_layouts_get()), this new
20525 * images layout will be used on the widget.
20527 * @see elm_slideshow_layouts_get() for more details
20529 * @ingroup Slideshow
20531 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20534 * Get the current slide layout in use for a given slideshow widget
20536 * @param obj The slideshow object
20537 * @return The current layout's name
20539 * @see elm_slideshow_layout_set() for more details
20541 * @ingroup Slideshow
20543 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20546 * Returns the list of @b layout names available, for a given
20547 * slideshow widget.
20549 * @param obj The slideshow object
20550 * @return The list of layouts (list of @b stringshared strings
20553 * Slideshow layouts will change how the widget is to dispose each
20554 * image item in its viewport, with regard to cropping, scaling,
20557 * The layouts, which come from @p obj's theme, must be an EDC
20558 * data item name @c "layouts" on the theme file, with (prefix)
20559 * names of EDC programs actually implementing them.
20561 * The available layouts for slideshows on the default theme are:
20562 * - @c "fullscreen" - item images with original aspect, scaled to
20563 * touch top and down slideshow borders or, if the image's heigh
20564 * is not enough, left and right slideshow borders.
20565 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20566 * one, but always leaving 10% of the slideshow's dimensions of
20567 * distance between the item image's borders and the slideshow
20568 * borders, for each axis.
20570 * @warning The stringshared strings get no new references
20571 * exclusive to the user grabbing the list, here, so if you'd like
20572 * to use them out of this call's context, you'd better @c
20573 * eina_stringshare_ref() them.
20575 * @see elm_slideshow_layout_set()
20577 * @ingroup Slideshow
20579 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20582 * Set the number of items to cache, on a given slideshow widget,
20583 * <b>before the current item</b>
20585 * @param obj The slideshow object
20586 * @param count Number of items to cache before the current one
20588 * The default value for this property is @c 2. See
20589 * @ref Slideshow_Caching "slideshow caching" for more details.
20591 * @see elm_slideshow_cache_before_get()
20593 * @ingroup Slideshow
20595 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20598 * Retrieve the number of items to cache, on a given slideshow widget,
20599 * <b>before the current item</b>
20601 * @param obj The slideshow object
20602 * @return The number of items set to be cached before the current one
20604 * @see elm_slideshow_cache_before_set() for more details
20606 * @ingroup Slideshow
20608 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20611 * Set the number of items to cache, on a given slideshow widget,
20612 * <b>after the current item</b>
20614 * @param obj The slideshow object
20615 * @param count Number of items to cache after the current one
20617 * The default value for this property is @c 2. See
20618 * @ref Slideshow_Caching "slideshow caching" for more details.
20620 * @see elm_slideshow_cache_after_get()
20622 * @ingroup Slideshow
20624 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20627 * Retrieve the number of items to cache, on a given slideshow widget,
20628 * <b>after the current item</b>
20630 * @param obj The slideshow object
20631 * @return The number of items set to be cached after the current one
20633 * @see elm_slideshow_cache_after_set() for more details
20635 * @ingroup Slideshow
20637 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20640 * Get the number of items stored in a given slideshow widget
20642 * @param obj The slideshow object
20643 * @return The number of items on @p obj, at the moment of this call
20645 * @ingroup Slideshow
20647 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20654 * @defgroup Fileselector File Selector
20656 * @image html img/widget/fileselector/preview-00.png
20657 * @image latex img/widget/fileselector/preview-00.eps
20659 * A file selector is a widget that allows a user to navigate
20660 * through a file system, reporting file selections back via its
20663 * It contains shortcut buttons for home directory (@c ~) and to
20664 * jump one directory upwards (..), as well as cancel/ok buttons to
20665 * confirm/cancel a given selection. After either one of those two
20666 * former actions, the file selector will issue its @c "done" smart
20669 * There's a text entry on it, too, showing the name of the current
20670 * selection. There's the possibility of making it editable, so it
20671 * is useful on file saving dialogs on applications, where one
20672 * gives a file name to save contents to, in a given directory in
20673 * the system. This custom file name will be reported on the @c
20674 * "done" smart callback (explained in sequence).
20676 * Finally, it has a view to display file system items into in two
20681 * If Elementary is built with support of the Ethumb thumbnailing
20682 * library, the second form of view will display preview thumbnails
20683 * of files which it supports.
20685 * Smart callbacks one can register to:
20687 * - @c "selected" - the user has clicked on a file (when not in
20688 * folders-only mode) or directory (when in folders-only mode)
20689 * - @c "directory,open" - the list has been populated with new
20690 * content (@c event_info is a pointer to the directory's
20691 * path, a @b stringshared string)
20692 * - @c "done" - the user has clicked on the "ok" or "cancel"
20693 * buttons (@c event_info is a pointer to the selection's
20694 * path, a @b stringshared string)
20696 * Here is an example on its usage:
20697 * @li @ref fileselector_example
20701 * @addtogroup Fileselector
20706 * Defines how a file selector widget is to layout its contents
20707 * (file system entries).
20709 typedef enum _Elm_Fileselector_Mode
20711 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20712 ELM_FILESELECTOR_GRID, /**< layout as a grid */
20713 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20714 } Elm_Fileselector_Mode;
20717 * Add a new file selector widget to the given parent Elementary
20718 * (container) object
20720 * @param parent The parent object
20721 * @return a new file selector widget handle or @c NULL, on errors
20723 * This function inserts a new file selector widget on the canvas.
20725 * @ingroup Fileselector
20727 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20730 * Enable/disable the file name entry box where the user can type
20731 * in a name for a file, in a given file selector widget
20733 * @param obj The file selector object
20734 * @param is_save @c EINA_TRUE to make the file selector a "saving
20735 * dialog", @c EINA_FALSE otherwise
20737 * Having the entry editable is useful on file saving dialogs on
20738 * applications, where one gives a file name to save contents to,
20739 * in a given directory in the system. This custom file name will
20740 * be reported on the @c "done" smart callback.
20742 * @see elm_fileselector_is_save_get()
20744 * @ingroup Fileselector
20746 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20749 * Get whether the given file selector is in "saving dialog" mode
20751 * @param obj The file selector object
20752 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20753 * mode, @c EINA_FALSE otherwise (and on errors)
20755 * @see elm_fileselector_is_save_set() for more details
20757 * @ingroup Fileselector
20759 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20762 * Enable/disable folder-only view for a given file selector widget
20764 * @param obj The file selector object
20765 * @param only @c EINA_TRUE to make @p obj only display
20766 * directories, @c EINA_FALSE to make files to be displayed in it
20769 * If enabled, the widget's view will only display folder items,
20772 * @see elm_fileselector_folder_only_get()
20774 * @ingroup Fileselector
20776 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20779 * Get whether folder-only view is set for a given file selector
20782 * @param obj The file selector object
20783 * @return only @c EINA_TRUE if @p obj is only displaying
20784 * directories, @c EINA_FALSE if files are being displayed in it
20785 * too (and on errors)
20787 * @see elm_fileselector_folder_only_get()
20789 * @ingroup Fileselector
20791 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20794 * Enable/disable the "ok" and "cancel" buttons on a given file
20797 * @param obj The file selector object
20798 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
20800 * @note A file selector without those buttons will never emit the
20801 * @c "done" smart event, and is only usable if one is just hooking
20802 * to the other two events.
20804 * @see elm_fileselector_buttons_ok_cancel_get()
20806 * @ingroup Fileselector
20808 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
20811 * Get whether the "ok" and "cancel" buttons on a given file
20812 * selector widget are being shown.
20814 * @param obj The file selector object
20815 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
20816 * otherwise (and on errors)
20818 * @see elm_fileselector_buttons_ok_cancel_set() for more details
20820 * @ingroup Fileselector
20822 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20825 * Enable/disable a tree view in the given file selector widget,
20826 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
20828 * @param obj The file selector object
20829 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
20832 * In a tree view, arrows are created on the sides of directories,
20833 * allowing them to expand in place.
20835 * @note If it's in other mode, the changes made by this function
20836 * will only be visible when one switches back to "list" mode.
20838 * @see elm_fileselector_expandable_get()
20840 * @ingroup Fileselector
20842 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
20845 * Get whether tree view is enabled for the given file selector
20848 * @param obj The file selector object
20849 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
20850 * otherwise (and or errors)
20852 * @see elm_fileselector_expandable_set() for more details
20854 * @ingroup Fileselector
20856 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20859 * Set, programmatically, the @b directory that a given file
20860 * selector widget will display contents from
20862 * @param obj The file selector object
20863 * @param path The path to display in @p obj
20865 * This will change the @b directory that @p obj is displaying. It
20866 * will also clear the text entry area on the @p obj object, which
20867 * displays select files' names.
20869 * @see elm_fileselector_path_get()
20871 * @ingroup Fileselector
20873 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20876 * Get the parent directory's path that a given file selector
20877 * widget is displaying
20879 * @param obj The file selector object
20880 * @return The (full) path of the directory the file selector is
20881 * displaying, a @b stringshared string
20883 * @see elm_fileselector_path_set()
20885 * @ingroup Fileselector
20887 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20890 * Set, programmatically, the currently selected file/directory in
20891 * the given file selector widget
20893 * @param obj The file selector object
20894 * @param path The (full) path to a file or directory
20895 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
20896 * latter case occurs if the directory or file pointed to do not
20899 * @see elm_fileselector_selected_get()
20901 * @ingroup Fileselector
20903 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20906 * Get the currently selected item's (full) path, in the given file
20909 * @param obj The file selector object
20910 * @return The absolute path of the selected item, a @b
20911 * stringshared string
20913 * @note Custom editions on @p obj object's text entry, if made,
20914 * will appear on the return string of this function, naturally.
20916 * @see elm_fileselector_selected_set() for more details
20918 * @ingroup Fileselector
20920 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20923 * Set the mode in which a given file selector widget will display
20924 * (layout) file system entries in its view
20926 * @param obj The file selector object
20927 * @param mode The mode of the fileselector, being it one of
20928 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
20929 * first one, naturally, will display the files in a list. The
20930 * latter will make the widget to display its entries in a grid
20933 * @note By using elm_fileselector_expandable_set(), the user may
20934 * trigger a tree view for that list.
20936 * @note If Elementary is built with support of the Ethumb
20937 * thumbnailing library, the second form of view will display
20938 * preview thumbnails of files which it supports. You must have
20939 * elm_need_ethumb() called in your Elementary for thumbnailing to
20942 * @see elm_fileselector_expandable_set().
20943 * @see elm_fileselector_mode_get().
20945 * @ingroup Fileselector
20947 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
20950 * Get the mode in which a given file selector widget is displaying
20951 * (layouting) file system entries in its view
20953 * @param obj The fileselector object
20954 * @return The mode in which the fileselector is at
20956 * @see elm_fileselector_mode_set() for more details
20958 * @ingroup Fileselector
20960 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20967 * @defgroup Progressbar Progress bar
20969 * The progress bar is a widget for visually representing the
20970 * progress status of a given job/task.
20972 * A progress bar may be horizontal or vertical. It may display an
20973 * icon besides it, as well as primary and @b units labels. The
20974 * former is meant to label the widget as a whole, while the
20975 * latter, which is formatted with floating point values (and thus
20976 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
20977 * units"</c>), is meant to label the widget's <b>progress
20978 * value</b>. Label, icon and unit strings/objects are @b optional
20979 * for progress bars.
20981 * A progress bar may be @b inverted, in which state it gets its
20982 * values inverted, with high values being on the left or top and
20983 * low values on the right or bottom, as opposed to normally have
20984 * the low values on the former and high values on the latter,
20985 * respectively, for horizontal and vertical modes.
20987 * The @b span of the progress, as set by
20988 * elm_progressbar_span_size_set(), is its length (horizontally or
20989 * vertically), unless one puts size hints on the widget to expand
20990 * on desired directions, by any container. That length will be
20991 * scaled by the object or applications scaling factor. At any
20992 * point code can query the progress bar for its value with
20993 * elm_progressbar_value_get().
20995 * Available widget styles for progress bars:
20997 * - @c "wheel" (simple style, no text, no progression, only
20998 * "pulse" effect is available)
21000 * Default contents parts of the progressbar widget that you can use for are:
21001 * @li "elm.swallow.content" - A icon of the progressbar
21003 * Here is an example on its usage:
21004 * @li @ref progressbar_example
21008 * Add a new progress bar widget to the given parent Elementary
21009 * (container) object
21011 * @param parent The parent object
21012 * @return a new progress bar widget handle or @c NULL, on errors
21014 * This function inserts a new progress bar widget on the canvas.
21016 * @ingroup Progressbar
21018 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21021 * Set whether a given progress bar widget is at "pulsing mode" or
21024 * @param obj The progress bar object
21025 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21026 * @c EINA_FALSE to put it back to its default one
21028 * By default, progress bars will display values from the low to
21029 * high value boundaries. There are, though, contexts in which the
21030 * state of progression of a given task is @b unknown. For those,
21031 * one can set a progress bar widget to a "pulsing state", to give
21032 * the user an idea that some computation is being held, but
21033 * without exact progress values. In the default theme it will
21034 * animate its bar with the contents filling in constantly and back
21035 * to non-filled, in a loop. To start and stop this pulsing
21036 * animation, one has to explicitly call elm_progressbar_pulse().
21038 * @see elm_progressbar_pulse_get()
21039 * @see elm_progressbar_pulse()
21041 * @ingroup Progressbar
21043 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21046 * Get whether a given progress bar widget is at "pulsing mode" or
21049 * @param obj The progress bar object
21050 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21051 * if it's in the default one (and on errors)
21053 * @ingroup Progressbar
21055 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21058 * Start/stop a given progress bar "pulsing" animation, if its
21061 * @param obj The progress bar object
21062 * @param state @c EINA_TRUE, to @b start the pulsing animation,
21063 * @c EINA_FALSE to @b stop it
21065 * @note This call won't do anything if @p obj is not under "pulsing mode".
21067 * @see elm_progressbar_pulse_set() for more details.
21069 * @ingroup Progressbar
21071 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21074 * Set the progress value (in percentage) on a given progress bar
21077 * @param obj The progress bar object
21078 * @param val The progress value (@b must be between @c 0.0 and @c
21081 * Use this call to set progress bar levels.
21083 * @note If you passes a value out of the specified range for @p
21084 * val, it will be interpreted as the @b closest of the @b boundary
21085 * values in the range.
21087 * @ingroup Progressbar
21089 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21092 * Get the progress value (in percentage) on a given progress bar
21095 * @param obj The progress bar object
21096 * @return The value of the progressbar
21098 * @see elm_progressbar_value_set() for more details
21100 * @ingroup Progressbar
21102 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21105 * Set the label of a given progress bar widget
21107 * @param obj The progress bar object
21108 * @param label The text label string, in UTF-8
21110 * @ingroup Progressbar
21111 * @deprecated use elm_object_text_set() instead.
21113 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21116 * Get the label of a given progress bar widget
21118 * @param obj The progressbar object
21119 * @return The text label string, in UTF-8
21121 * @ingroup Progressbar
21122 * @deprecated use elm_object_text_set() instead.
21124 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21127 * Set the icon object of a given progress bar widget
21129 * @param obj The progress bar object
21130 * @param icon The icon object
21132 * Use this call to decorate @p obj with an icon next to it.
21134 * @note Once the icon object is set, a previously set one will be
21135 * deleted. If you want to keep that old content object, use the
21136 * elm_progressbar_icon_unset() function.
21138 * @see elm_progressbar_icon_get()
21139 * @deprecated use elm_object_content_set() instead.
21141 * @ingroup Progressbar
21143 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21146 * Retrieve the icon object set for a given progress bar widget
21148 * @param obj The progress bar object
21149 * @return The icon object's handle, if @p obj had one set, or @c NULL,
21150 * otherwise (and on errors)
21152 * @see elm_progressbar_icon_set() for more details
21153 * @deprecated use elm_object_content_set() instead.
21155 * @ingroup Progressbar
21157 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21160 * Unset an icon set on a given progress bar widget
21162 * @param obj The progress bar object
21163 * @return The icon object that was being used, if any was set, or
21164 * @c NULL, otherwise (and on errors)
21166 * This call will unparent and return the icon object which was set
21167 * for this widget, previously, on success.
21169 * @see elm_progressbar_icon_set() for more details
21170 * @deprecated use elm_object_content_unset() instead.
21172 * @ingroup Progressbar
21174 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21177 * Set the (exact) length of the bar region of a given progress bar
21180 * @param obj The progress bar object
21181 * @param size The length of the progress bar's bar region
21183 * This sets the minimum width (when in horizontal mode) or height
21184 * (when in vertical mode) of the actual bar area of the progress
21185 * bar @p obj. This in turn affects the object's minimum size. Use
21186 * this when you're not setting other size hints expanding on the
21187 * given direction (like weight and alignment hints) and you would
21188 * like it to have a specific size.
21190 * @note Icon, label and unit text around @p obj will require their
21191 * own space, which will make @p obj to require more the @p size,
21194 * @see elm_progressbar_span_size_get()
21196 * @ingroup Progressbar
21198 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21201 * Get the length set for the bar region of a given progress bar
21204 * @param obj The progress bar object
21205 * @return The length of the progress bar's bar region
21207 * If that size was not set previously, with
21208 * elm_progressbar_span_size_set(), this call will return @c 0.
21210 * @ingroup Progressbar
21212 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21215 * Set the format string for a given progress bar widget's units
21218 * @param obj The progress bar object
21219 * @param format The format string for @p obj's units label
21221 * If @c NULL is passed on @p format, it will make @p obj's units
21222 * area to be hidden completely. If not, it'll set the <b>format
21223 * string</b> for the units label's @b text. The units label is
21224 * provided a floating point value, so the units text is up display
21225 * at most one floating point falue. Note that the units label is
21226 * optional. Use a format string such as "%1.2f meters" for
21229 * @note The default format string for a progress bar is an integer
21230 * percentage, as in @c "%.0f %%".
21232 * @see elm_progressbar_unit_format_get()
21234 * @ingroup Progressbar
21236 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21239 * Retrieve the format string set for a given progress bar widget's
21242 * @param obj The progress bar object
21243 * @return The format set string for @p obj's units label or
21244 * @c NULL, if none was set (and on errors)
21246 * @see elm_progressbar_unit_format_set() for more details
21248 * @ingroup Progressbar
21250 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21253 * Set the orientation of a given progress bar widget
21255 * @param obj The progress bar object
21256 * @param horizontal Use @c EINA_TRUE to make @p obj to be
21257 * @b horizontal, @c EINA_FALSE to make it @b vertical
21259 * Use this function to change how your progress bar is to be
21260 * disposed: vertically or horizontally.
21262 * @see elm_progressbar_horizontal_get()
21264 * @ingroup Progressbar
21266 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21269 * Retrieve the orientation of a given progress bar widget
21271 * @param obj The progress bar object
21272 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21273 * @c EINA_FALSE if it's @b vertical (and on errors)
21275 * @see elm_progressbar_horizontal_set() for more details
21277 * @ingroup Progressbar
21279 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21282 * Invert a given progress bar widget's displaying values order
21284 * @param obj The progress bar object
21285 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21286 * @c EINA_FALSE to bring it back to default, non-inverted values.
21288 * A progress bar may be @b inverted, in which state it gets its
21289 * values inverted, with high values being on the left or top and
21290 * low values on the right or bottom, as opposed to normally have
21291 * the low values on the former and high values on the latter,
21292 * respectively, for horizontal and vertical modes.
21294 * @see elm_progressbar_inverted_get()
21296 * @ingroup Progressbar
21298 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21301 * Get whether a given progress bar widget's displaying values are
21304 * @param obj The progress bar object
21305 * @return @c EINA_TRUE, if @p obj has inverted values,
21306 * @c EINA_FALSE otherwise (and on errors)
21308 * @see elm_progressbar_inverted_set() for more details
21310 * @ingroup Progressbar
21312 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21315 * @defgroup Separator Separator
21317 * @brief Separator is a very thin object used to separate other objects.
21319 * A separator can be vertical or horizontal.
21321 * @ref tutorial_separator is a good example of how to use a separator.
21325 * @brief Add a separator object to @p parent
21327 * @param parent The parent object
21329 * @return The separator object, or NULL upon failure
21331 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21333 * @brief Set the horizontal mode of a separator object
21335 * @param obj The separator object
21336 * @param horizontal If true, the separator is horizontal
21338 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21340 * @brief Get the horizontal mode of a separator object
21342 * @param obj The separator object
21343 * @return If true, the separator is horizontal
21345 * @see elm_separator_horizontal_set()
21347 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21353 * @defgroup Spinner Spinner
21354 * @ingroup Elementary
21356 * @image html img/widget/spinner/preview-00.png
21357 * @image latex img/widget/spinner/preview-00.eps
21359 * A spinner is a widget which allows the user to increase or decrease
21360 * numeric values using arrow buttons, or edit values directly, clicking
21361 * over it and typing the new value.
21363 * By default the spinner will not wrap and has a label
21364 * of "%.0f" (just showing the integer value of the double).
21366 * A spinner has a label that is formatted with floating
21367 * point values and thus accepts a printf-style format string, like
21368 * ā%1.2f unitsā.
21370 * It also allows specific values to be replaced by pre-defined labels.
21372 * Smart callbacks one can register to:
21374 * - "changed" - Whenever the spinner value is changed.
21375 * - "delay,changed" - A short time after the value is changed by the user.
21376 * This will be called only when the user stops dragging for a very short
21377 * period or when they release their finger/mouse, so it avoids possibly
21378 * expensive reactions to the value change.
21380 * Available styles for it:
21382 * - @c "vertical": up/down buttons at the right side and text left aligned.
21384 * Here is an example on its usage:
21385 * @ref spinner_example
21389 * @addtogroup Spinner
21394 * Add a new spinner widget to the given parent Elementary
21395 * (container) object.
21397 * @param parent The parent object.
21398 * @return a new spinner widget handle or @c NULL, on errors.
21400 * This function inserts a new spinner widget on the canvas.
21405 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21408 * Set the format string of the displayed label.
21410 * @param obj The spinner object.
21411 * @param fmt The format string for the label display.
21413 * If @c NULL, this sets the format to "%.0f". If not it sets the format
21414 * string for the label text. The label text is provided a floating point
21415 * value, so the label text can display up to 1 floating point value.
21416 * Note that this is optional.
21418 * Use a format string such as "%1.2f meters" for example, and it will
21419 * display values like: "3.14 meters" for a value equal to 3.14159.
21421 * Default is "%0.f".
21423 * @see elm_spinner_label_format_get()
21427 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21430 * Get the label format of the spinner.
21432 * @param obj The spinner object.
21433 * @return The text label format string in UTF-8.
21435 * @see elm_spinner_label_format_set() for details.
21439 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21442 * Set the minimum and maximum values for the spinner.
21444 * @param obj The spinner object.
21445 * @param min The minimum value.
21446 * @param max The maximum value.
21448 * Define the allowed range of values to be selected by the user.
21450 * If actual value is less than @p min, it will be updated to @p min. If it
21451 * is bigger then @p max, will be updated to @p max. Actual value can be
21452 * get with elm_spinner_value_get().
21454 * By default, min is equal to 0, and max is equal to 100.
21456 * @warning Maximum must be greater than minimum.
21458 * @see elm_spinner_min_max_get()
21462 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21465 * Get the minimum and maximum values of the spinner.
21467 * @param obj The spinner object.
21468 * @param min Pointer where to store the minimum value.
21469 * @param max Pointer where to store the maximum value.
21471 * @note If only one value is needed, the other pointer can be passed
21474 * @see elm_spinner_min_max_set() for details.
21478 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21481 * Set the step used to increment or decrement the spinner value.
21483 * @param obj The spinner object.
21484 * @param step The step value.
21486 * This value will be incremented or decremented to the displayed value.
21487 * It will be incremented while the user keep right or top arrow pressed,
21488 * and will be decremented while the user keep left or bottom arrow pressed.
21490 * The interval to increment / decrement can be set with
21491 * elm_spinner_interval_set().
21493 * By default step value is equal to 1.
21495 * @see elm_spinner_step_get()
21499 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21502 * Get the step used to increment or decrement the spinner value.
21504 * @param obj The spinner object.
21505 * @return The step value.
21507 * @see elm_spinner_step_get() for more details.
21511 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21514 * Set the value the spinner displays.
21516 * @param obj The spinner object.
21517 * @param val The value to be displayed.
21519 * Value will be presented on the label following format specified with
21520 * elm_spinner_format_set().
21522 * @warning The value must to be between min and max values. This values
21523 * are set by elm_spinner_min_max_set().
21525 * @see elm_spinner_value_get().
21526 * @see elm_spinner_format_set().
21527 * @see elm_spinner_min_max_set().
21531 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21534 * Get the value displayed by the spinner.
21536 * @param obj The spinner object.
21537 * @return The value displayed.
21539 * @see elm_spinner_value_set() for details.
21543 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21546 * Set whether the spinner should wrap when it reaches its
21547 * minimum or maximum value.
21549 * @param obj The spinner object.
21550 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21553 * Disabled by default. If disabled, when the user tries to increment the
21555 * but displayed value plus step value is bigger than maximum value,
21557 * won't allow it. The same happens when the user tries to decrement it,
21558 * but the value less step is less than minimum value.
21560 * When wrap is enabled, in such situations it will allow these changes,
21561 * but will get the value that would be less than minimum and subtracts
21562 * from maximum. Or add the value that would be more than maximum to
21566 * @li min value = 10
21567 * @li max value = 50
21568 * @li step value = 20
21569 * @li displayed value = 20
21571 * When the user decrement value (using left or bottom arrow), it will
21572 * displays @c 40, because max - (min - (displayed - step)) is
21573 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21575 * @see elm_spinner_wrap_get().
21579 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21582 * Get whether the spinner should wrap when it reaches its
21583 * minimum or maximum value.
21585 * @param obj The spinner object
21586 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21587 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21589 * @see elm_spinner_wrap_set() for details.
21593 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21596 * Set whether the spinner can be directly edited by the user or not.
21598 * @param obj The spinner object.
21599 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21600 * don't allow users to edit it directly.
21602 * Spinner objects can have edition @b disabled, in which state they will
21603 * be changed only by arrows.
21604 * Useful for contexts
21605 * where you don't want your users to interact with it writting the value.
21607 * when using special values, the user can see real value instead
21608 * of special label on edition.
21610 * It's enabled by default.
21612 * @see elm_spinner_editable_get()
21616 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21619 * Get whether the spinner can be directly edited by the user or not.
21621 * @param obj The spinner object.
21622 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21623 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21625 * @see elm_spinner_editable_set() for details.
21629 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21632 * Set a special string to display in the place of the numerical value.
21634 * @param obj The spinner object.
21635 * @param value The value to be replaced.
21636 * @param label The label to be used.
21638 * It's useful for cases when a user should select an item that is
21639 * better indicated by a label than a value. For example, weekdays or months.
21643 * sp = elm_spinner_add(win);
21644 * elm_spinner_min_max_set(sp, 1, 3);
21645 * elm_spinner_special_value_add(sp, 1, "January");
21646 * elm_spinner_special_value_add(sp, 2, "February");
21647 * elm_spinner_special_value_add(sp, 3, "March");
21648 * evas_object_show(sp);
21653 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21656 * Set the interval on time updates for an user mouse button hold
21657 * on spinner widgets' arrows.
21659 * @param obj The spinner object.
21660 * @param interval The (first) interval value in seconds.
21662 * This interval value is @b decreased while the user holds the
21663 * mouse pointer either incrementing or decrementing spinner's value.
21665 * This helps the user to get to a given value distant from the
21666 * current one easier/faster, as it will start to change quicker and
21667 * quicker on mouse button holds.
21669 * The calculation for the next change interval value, starting from
21670 * the one set with this call, is the previous interval divided by
21671 * @c 1.05, so it decreases a little bit.
21673 * The default starting interval value for automatic changes is
21676 * @see elm_spinner_interval_get()
21680 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21683 * Get the interval on time updates for an user mouse button hold
21684 * on spinner widgets' arrows.
21686 * @param obj The spinner object.
21687 * @return The (first) interval value, in seconds, set on it.
21689 * @see elm_spinner_interval_set() for more details.
21693 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21700 * @defgroup Index Index
21702 * @image html img/widget/index/preview-00.png
21703 * @image latex img/widget/index/preview-00.eps
21705 * An index widget gives you an index for fast access to whichever
21706 * group of other UI items one might have. It's a list of text
21707 * items (usually letters, for alphabetically ordered access).
21709 * Index widgets are by default hidden and just appear when the
21710 * user clicks over it's reserved area in the canvas. In its
21711 * default theme, it's an area one @ref Fingers "finger" wide on
21712 * the right side of the index widget's container.
21714 * When items on the index are selected, smart callbacks get
21715 * called, so that its user can make other container objects to
21716 * show a given area or child object depending on the index item
21717 * selected. You'd probably be using an index together with @ref
21718 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21721 * Smart events one can add callbacks for are:
21722 * - @c "changed" - When the selected index item changes. @c
21723 * event_info is the selected item's data pointer.
21724 * - @c "delay,changed" - When the selected index item changes, but
21725 * after a small idling period. @c event_info is the selected
21726 * item's data pointer.
21727 * - @c "selected" - When the user releases a mouse button and
21728 * selects an item. @c event_info is the selected item's data
21730 * - @c "level,up" - when the user moves a finger from the first
21731 * level to the second level
21732 * - @c "level,down" - when the user moves a finger from the second
21733 * level to the first level
21735 * The @c "delay,changed" event is so that it'll wait a small time
21736 * before actually reporting those events and, moreover, just the
21737 * last event happening on those time frames will actually be
21740 * Here are some examples on its usage:
21741 * @li @ref index_example_01
21742 * @li @ref index_example_02
21746 * @addtogroup Index
21750 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21753 * Add a new index widget to the given parent Elementary
21754 * (container) object
21756 * @param parent The parent object
21757 * @return a new index widget handle or @c NULL, on errors
21759 * This function inserts a new index widget on the canvas.
21763 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21766 * Set whether a given index widget is or not visible,
21769 * @param obj The index object
21770 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21772 * Not to be confused with visible as in @c evas_object_show() --
21773 * visible with regard to the widget's auto hiding feature.
21775 * @see elm_index_active_get()
21779 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21782 * Get whether a given index widget is currently visible or not.
21784 * @param obj The index object
21785 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21787 * @see elm_index_active_set() for more details
21791 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21794 * Set the items level for a given index widget.
21796 * @param obj The index object.
21797 * @param level @c 0 or @c 1, the currently implemented levels.
21799 * @see elm_index_item_level_get()
21803 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21806 * Get the items level set for a given index widget.
21808 * @param obj The index object.
21809 * @return @c 0 or @c 1, which are the levels @p obj might be at.
21811 * @see elm_index_item_level_set() for more information
21815 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21818 * Returns the last selected item's data, for a given index widget.
21820 * @param obj The index object.
21821 * @return The item @b data associated to the last selected item on
21822 * @p obj (or @c NULL, on errors).
21824 * @warning The returned value is @b not an #Elm_Index_Item item
21825 * handle, but the data associated to it (see the @c item parameter
21826 * in elm_index_item_append(), as an example).
21830 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21833 * Append a new item on a given index widget.
21835 * @param obj The index object.
21836 * @param letter Letter under which the item should be indexed
21837 * @param item The item data to set for the index's item
21839 * Despite the most common usage of the @p letter argument is for
21840 * single char strings, one could use arbitrary strings as index
21843 * @c item will be the pointer returned back on @c "changed", @c
21844 * "delay,changed" and @c "selected" smart events.
21848 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21851 * Prepend a new item on a given index widget.
21853 * @param obj The index object.
21854 * @param letter Letter under which the item should be indexed
21855 * @param item The item data to set for the index's item
21857 * Despite the most common usage of the @p letter argument is for
21858 * single char strings, one could use arbitrary strings as index
21861 * @c item will be the pointer returned back on @c "changed", @c
21862 * "delay,changed" and @c "selected" smart events.
21866 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21869 * Append a new item, on a given index widget, <b>after the item
21870 * having @p relative as data</b>.
21872 * @param obj The index object.
21873 * @param letter Letter under which the item should be indexed
21874 * @param item The item data to set for the index's item
21875 * @param relative The item data of the index item to be the
21876 * predecessor of this new one
21878 * Despite the most common usage of the @p letter argument is for
21879 * single char strings, one could use arbitrary strings as index
21882 * @c item will be the pointer returned back on @c "changed", @c
21883 * "delay,changed" and @c "selected" smart events.
21885 * @note If @p relative is @c NULL or if it's not found to be data
21886 * set on any previous item on @p obj, this function will behave as
21887 * elm_index_item_append().
21891 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21894 * Prepend a new item, on a given index widget, <b>after the item
21895 * having @p relative as data</b>.
21897 * @param obj The index object.
21898 * @param letter Letter under which the item should be indexed
21899 * @param item The item data to set for the index's item
21900 * @param relative The item data of the index item to be the
21901 * successor of this new one
21903 * Despite the most common usage of the @p letter argument is for
21904 * single char strings, one could use arbitrary strings as index
21907 * @c item will be the pointer returned back on @c "changed", @c
21908 * "delay,changed" and @c "selected" smart events.
21910 * @note If @p relative is @c NULL or if it's not found to be data
21911 * set on any previous item on @p obj, this function will behave as
21912 * elm_index_item_prepend().
21916 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21919 * Insert a new item into the given index widget, using @p cmp_func
21920 * function to sort items (by item handles).
21922 * @param obj The index object.
21923 * @param letter Letter under which the item should be indexed
21924 * @param item The item data to set for the index's item
21925 * @param cmp_func The comparing function to be used to sort index
21926 * items <b>by #Elm_Index_Item item handles</b>
21927 * @param cmp_data_func A @b fallback function to be called for the
21928 * sorting of index items <b>by item data</b>). It will be used
21929 * when @p cmp_func returns @c 0 (equality), which means an index
21930 * item with provided item data already exists. To decide which
21931 * data item should be pointed to by the index item in question, @p
21932 * cmp_data_func will be used. If @p cmp_data_func returns a
21933 * non-negative value, the previous index item data will be
21934 * replaced by the given @p item pointer. If the previous data need
21935 * to be freed, it should be done by the @p cmp_data_func function,
21936 * because all references to it will be lost. If this function is
21937 * not provided (@c NULL is given), index items will be @b
21938 * duplicated, if @p cmp_func returns @c 0.
21940 * Despite the most common usage of the @p letter argument is for
21941 * single char strings, one could use arbitrary strings as index
21944 * @c item will be the pointer returned back on @c "changed", @c
21945 * "delay,changed" and @c "selected" smart events.
21949 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);
21952 * Remove an item from a given index widget, <b>to be referenced by
21953 * it's data value</b>.
21955 * @param obj The index object
21956 * @param item The item's data pointer for the item to be removed
21959 * If a deletion callback is set, via elm_index_item_del_cb_set(),
21960 * that callback function will be called by this one.
21962 * @warning The item to be removed from @p obj will be found via
21963 * its item data pointer, and not by an #Elm_Index_Item handle.
21967 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21970 * Find a given index widget's item, <b>using item data</b>.
21972 * @param obj The index object
21973 * @param item The item data pointed to by the desired index item
21974 * @return The index item handle, if found, or @c NULL otherwise
21978 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21981 * Removes @b all items from a given index widget.
21983 * @param obj The index object.
21985 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
21986 * that callback function will be called for each item in @p obj.
21990 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21993 * Go to a given items level on a index widget
21995 * @param obj The index object
21996 * @param level The index level (one of @c 0 or @c 1)
22000 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22003 * Return the data associated with a given index widget item
22005 * @param it The index widget item handle
22006 * @return The data associated with @p it
22008 * @see elm_index_item_data_set()
22012 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22015 * Set the data associated with a given index widget item
22017 * @param it The index widget item handle
22018 * @param data The new data pointer to set to @p it
22020 * This sets new item data on @p it.
22022 * @warning The old data pointer won't be touched by this function, so
22023 * the user had better to free that old data himself/herself.
22027 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22030 * Set the function to be called when a given index widget item is freed.
22032 * @param it The item to set the callback on
22033 * @param func The function to call on the item's deletion
22035 * When called, @p func will have both @c data and @c event_info
22036 * arguments with the @p it item's data value and, naturally, the
22037 * @c obj argument with a handle to the parent index widget.
22041 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22044 * Get the letter (string) set on a given index widget item.
22046 * @param it The index item handle
22047 * @return The letter string set on @p it
22051 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22055 EAPI void elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
22062 * @defgroup Photocam Photocam
22064 * @image html img/widget/photocam/preview-00.png
22065 * @image latex img/widget/photocam/preview-00.eps
22067 * This is a widget specifically for displaying high-resolution digital
22068 * camera photos giving speedy feedback (fast load), low memory footprint
22069 * and zooming and panning as well as fitting logic. It is entirely focused
22070 * on jpeg images, and takes advantage of properties of the jpeg format (via
22071 * evas loader features in the jpeg loader).
22073 * Signals that you can add callbacks for are:
22074 * @li "clicked" - This is called when a user has clicked the photo without
22076 * @li "press" - This is called when a user has pressed down on the photo.
22077 * @li "longpressed" - This is called when a user has pressed down on the
22078 * photo for a long time without dragging around.
22079 * @li "clicked,double" - This is called when a user has double-clicked the
22081 * @li "load" - Photo load begins.
22082 * @li "loaded" - This is called when the image file load is complete for the
22083 * first view (low resolution blurry version).
22084 * @li "load,detail" - Photo detailed data load begins.
22085 * @li "loaded,detail" - This is called when the image file load is complete
22086 * for the detailed image data (full resolution needed).
22087 * @li "zoom,start" - Zoom animation started.
22088 * @li "zoom,stop" - Zoom animation stopped.
22089 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22090 * @li "scroll" - the content has been scrolled (moved)
22091 * @li "scroll,anim,start" - scrolling animation has started
22092 * @li "scroll,anim,stop" - scrolling animation has stopped
22093 * @li "scroll,drag,start" - dragging the contents around has started
22094 * @li "scroll,drag,stop" - dragging the contents around has stopped
22096 * @ref tutorial_photocam shows the API in action.
22100 * @brief Types of zoom available.
22102 typedef enum _Elm_Photocam_Zoom_Mode
22104 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
22105 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22106 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22107 ELM_PHOTOCAM_ZOOM_MODE_LAST
22108 } Elm_Photocam_Zoom_Mode;
22110 * @brief Add a new Photocam object
22112 * @param parent The parent object
22113 * @return The new object or NULL if it cannot be created
22115 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22117 * @brief Set the photo file to be shown
22119 * @param obj The photocam object
22120 * @param file The photo file
22121 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22123 * This sets (and shows) the specified file (with a relative or absolute
22124 * path) and will return a load error (same error that
22125 * evas_object_image_load_error_get() will return). The image will change and
22126 * adjust its size at this point and begin a background load process for this
22127 * photo that at some time in the future will be displayed at the full
22130 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22132 * @brief Returns the path of the current image file
22134 * @param obj The photocam object
22135 * @return Returns the path
22137 * @see elm_photocam_file_set()
22139 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22141 * @brief Set the zoom level of the photo
22143 * @param obj The photocam object
22144 * @param zoom The zoom level to set
22146 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22147 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22148 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22149 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22152 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22154 * @brief Get the zoom level of the photo
22156 * @param obj The photocam object
22157 * @return The current zoom level
22159 * This returns the current zoom level of the photocam object. Note that if
22160 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22161 * (which is the default), the zoom level may be changed at any time by the
22162 * photocam object itself to account for photo size and photocam viewpoer
22165 * @see elm_photocam_zoom_set()
22166 * @see elm_photocam_zoom_mode_set()
22168 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22170 * @brief Set the zoom mode
22172 * @param obj The photocam object
22173 * @param mode The desired mode
22175 * This sets the zoom mode to manual or one of several automatic levels.
22176 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22177 * elm_photocam_zoom_set() and will stay at that level until changed by code
22178 * or until zoom mode is changed. This is the default mode. The Automatic
22179 * modes will allow the photocam object to automatically adjust zoom mode
22180 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22181 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22182 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22183 * pixels within the frame are left unfilled.
22185 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22187 * @brief Get the zoom mode
22189 * @param obj The photocam object
22190 * @return The current zoom mode
22192 * This gets the current zoom mode of the photocam object.
22194 * @see elm_photocam_zoom_mode_set()
22196 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22198 * @brief Get the current image pixel width and height
22200 * @param obj The photocam object
22201 * @param w A pointer to the width return
22202 * @param h A pointer to the height return
22204 * This gets the current photo pixel width and height (for the original).
22205 * The size will be returned in the integers @p w and @p h that are pointed
22208 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22210 * @brief Get the area of the image that is currently shown
22213 * @param x A pointer to the X-coordinate of region
22214 * @param y A pointer to the Y-coordinate of region
22215 * @param w A pointer to the width
22216 * @param h A pointer to the height
22218 * @see elm_photocam_image_region_show()
22219 * @see elm_photocam_image_region_bring_in()
22221 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22223 * @brief Set the viewed portion of the image
22225 * @param obj The photocam object
22226 * @param x X-coordinate of region in image original pixels
22227 * @param y Y-coordinate of region in image original pixels
22228 * @param w Width of region in image original pixels
22229 * @param h Height of region in image original pixels
22231 * This shows the region of the image without using animation.
22233 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22235 * @brief Bring in the viewed portion of the image
22237 * @param obj The photocam object
22238 * @param x X-coordinate of region in image original pixels
22239 * @param y Y-coordinate of region in image original pixels
22240 * @param w Width of region in image original pixels
22241 * @param h Height of region in image original pixels
22243 * This shows the region of the image using animation.
22245 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22247 * @brief Set the paused state for photocam
22249 * @param obj The photocam object
22250 * @param paused The pause state to set
22252 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22253 * photocam. The default is off. This will stop zooming using animation on
22254 * zoom levels changes and change instantly. This will stop any existing
22255 * animations that are running.
22257 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22259 * @brief Get the paused state for photocam
22261 * @param obj The photocam object
22262 * @return The current paused state
22264 * This gets the current paused state for the photocam object.
22266 * @see elm_photocam_paused_set()
22268 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22270 * @brief Get the internal low-res image used for photocam
22272 * @param obj The photocam object
22273 * @return The internal image object handle, or NULL if none exists
22275 * This gets the internal image object inside photocam. Do not modify it. It
22276 * is for inspection only, and hooking callbacks to. Nothing else. It may be
22277 * deleted at any time as well.
22279 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22281 * @brief Set the photocam scrolling bouncing.
22283 * @param obj The photocam object
22284 * @param h_bounce bouncing for horizontal
22285 * @param v_bounce bouncing for vertical
22287 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22289 * @brief Get the photocam scrolling bouncing.
22291 * @param obj The photocam object
22292 * @param h_bounce bouncing for horizontal
22293 * @param v_bounce bouncing for vertical
22295 * @see elm_photocam_bounce_set()
22297 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22303 * @defgroup Map Map
22304 * @ingroup Elementary
22306 * @image html img/widget/map/preview-00.png
22307 * @image latex img/widget/map/preview-00.eps
22309 * This is a widget specifically for displaying a map. It uses basically
22310 * OpenStreetMap provider http://www.openstreetmap.org/,
22311 * but custom providers can be added.
22313 * It supports some basic but yet nice features:
22314 * @li zoom and scroll
22315 * @li markers with content to be displayed when user clicks over it
22316 * @li group of markers
22319 * Smart callbacks one can listen to:
22321 * - "clicked" - This is called when a user has clicked the map without
22323 * - "press" - This is called when a user has pressed down on the map.
22324 * - "longpressed" - This is called when a user has pressed down on the map
22325 * for a long time without dragging around.
22326 * - "clicked,double" - This is called when a user has double-clicked
22328 * - "load,detail" - Map detailed data load begins.
22329 * - "loaded,detail" - This is called when all currently visible parts of
22330 * the map are loaded.
22331 * - "zoom,start" - Zoom animation started.
22332 * - "zoom,stop" - Zoom animation stopped.
22333 * - "zoom,change" - Zoom changed when using an auto zoom mode.
22334 * - "scroll" - the content has been scrolled (moved).
22335 * - "scroll,anim,start" - scrolling animation has started.
22336 * - "scroll,anim,stop" - scrolling animation has stopped.
22337 * - "scroll,drag,start" - dragging the contents around has started.
22338 * - "scroll,drag,stop" - dragging the contents around has stopped.
22339 * - "downloaded" - This is called when all currently required map images
22341 * - "route,load" - This is called when route request begins.
22342 * - "route,loaded" - This is called when route request ends.
22343 * - "name,load" - This is called when name request begins.
22344 * - "name,loaded- This is called when name request ends.
22346 * Available style for map widget:
22349 * Available style for markers:
22354 * Available style for marker bubble:
22357 * List of examples:
22358 * @li @ref map_example_01
22359 * @li @ref map_example_02
22360 * @li @ref map_example_03
22369 * @enum _Elm_Map_Zoom_Mode
22370 * @typedef Elm_Map_Zoom_Mode
22372 * Set map's zoom behavior. It can be set to manual or automatic.
22374 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22376 * Values <b> don't </b> work as bitmask, only one can be choosen.
22378 * @note Valid sizes are 2^zoom, consequently the map may be smaller
22379 * than the scroller view.
22381 * @see elm_map_zoom_mode_set()
22382 * @see elm_map_zoom_mode_get()
22386 typedef enum _Elm_Map_Zoom_Mode
22388 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22389 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22390 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22391 ELM_MAP_ZOOM_MODE_LAST
22392 } Elm_Map_Zoom_Mode;
22395 * @enum _Elm_Map_Route_Sources
22396 * @typedef Elm_Map_Route_Sources
22398 * Set route service to be used. By default used source is
22399 * #ELM_MAP_ROUTE_SOURCE_YOURS.
22401 * @see elm_map_route_source_set()
22402 * @see elm_map_route_source_get()
22406 typedef enum _Elm_Map_Route_Sources
22408 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22409 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. */
22410 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22411 ELM_MAP_ROUTE_SOURCE_LAST
22412 } Elm_Map_Route_Sources;
22414 typedef enum _Elm_Map_Name_Sources
22416 ELM_MAP_NAME_SOURCE_NOMINATIM,
22417 ELM_MAP_NAME_SOURCE_LAST
22418 } Elm_Map_Name_Sources;
22421 * @enum _Elm_Map_Route_Type
22422 * @typedef Elm_Map_Route_Type
22424 * Set type of transport used on route.
22426 * @see elm_map_route_add()
22430 typedef enum _Elm_Map_Route_Type
22432 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22433 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22434 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22435 ELM_MAP_ROUTE_TYPE_LAST
22436 } Elm_Map_Route_Type;
22439 * @enum _Elm_Map_Route_Method
22440 * @typedef Elm_Map_Route_Method
22442 * Set the routing method, what should be priorized, time or distance.
22444 * @see elm_map_route_add()
22448 typedef enum _Elm_Map_Route_Method
22450 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22451 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22452 ELM_MAP_ROUTE_METHOD_LAST
22453 } Elm_Map_Route_Method;
22455 typedef enum _Elm_Map_Name_Method
22457 ELM_MAP_NAME_METHOD_SEARCH,
22458 ELM_MAP_NAME_METHOD_REVERSE,
22459 ELM_MAP_NAME_METHOD_LAST
22460 } Elm_Map_Name_Method;
22462 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(). */
22463 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(). */
22464 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(). */
22465 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(). */
22466 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
22467 typedef struct _Elm_Map_Track Elm_Map_Track;
22469 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. */
22470 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22471 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22472 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22474 typedef char *(*ElmMapModuleSourceFunc) (void);
22475 typedef int (*ElmMapModuleZoomMinFunc) (void);
22476 typedef int (*ElmMapModuleZoomMaxFunc) (void);
22477 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22478 typedef int (*ElmMapModuleRouteSourceFunc) (void);
22479 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22480 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22481 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22482 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22485 * Add a new map widget to the given parent Elementary (container) object.
22487 * @param parent The parent object.
22488 * @return a new map widget handle or @c NULL, on errors.
22490 * This function inserts a new map widget on the canvas.
22494 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22497 * Set the zoom level of the map.
22499 * @param obj The map object.
22500 * @param zoom The zoom level to set.
22502 * This sets the zoom level.
22504 * It will respect limits defined by elm_map_source_zoom_min_set() and
22505 * elm_map_source_zoom_max_set().
22507 * By default these values are 0 (world map) and 18 (maximum zoom).
22509 * This function should be used when zoom mode is set to
22510 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22511 * with elm_map_zoom_mode_set().
22513 * @see elm_map_zoom_mode_set().
22514 * @see elm_map_zoom_get().
22518 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22521 * Get the zoom level of the map.
22523 * @param obj The map object.
22524 * @return The current zoom level.
22526 * This returns the current zoom level of the map object.
22528 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22529 * (which is the default), the zoom level may be changed at any time by the
22530 * map object itself to account for map size and map viewport size.
22532 * @see elm_map_zoom_set() for details.
22536 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22539 * Set the zoom mode used by the map object.
22541 * @param obj The map object.
22542 * @param mode The zoom mode of the map, being it one of
22543 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22544 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22546 * This sets the zoom mode to manual or one of the automatic levels.
22547 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22548 * elm_map_zoom_set() and will stay at that level until changed by code
22549 * or until zoom mode is changed. This is the default mode.
22551 * The Automatic modes will allow the map object to automatically
22552 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22553 * adjust zoom so the map fits inside the scroll frame with no pixels
22554 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22555 * ensure no pixels within the frame are left unfilled. Do not forget that
22556 * the valid sizes are 2^zoom, consequently the map may be smaller than
22557 * the scroller view.
22559 * @see elm_map_zoom_set()
22563 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22566 * Get the zoom mode used by the map object.
22568 * @param obj The map object.
22569 * @return The zoom mode of the map, being it one of
22570 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22571 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22573 * This function returns the current zoom mode used by the map object.
22575 * @see elm_map_zoom_mode_set() for more details.
22579 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22582 * Get the current coordinates of the map.
22584 * @param obj The map object.
22585 * @param lon Pointer where to store longitude.
22586 * @param lat Pointer where to store latitude.
22588 * This gets the current center coordinates of the map object. It can be
22589 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22591 * @see elm_map_geo_region_bring_in()
22592 * @see elm_map_geo_region_show()
22596 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22599 * Animatedly bring in given coordinates to the center of the map.
22601 * @param obj The map object.
22602 * @param lon Longitude to center at.
22603 * @param lat Latitude to center at.
22605 * This causes map to jump to the given @p lat and @p lon coordinates
22606 * and show it (by scrolling) in the center of the viewport, if it is not
22607 * already centered. This will use animation to do so and take a period
22608 * of time to complete.
22610 * @see elm_map_geo_region_show() for a function to avoid animation.
22611 * @see elm_map_geo_region_get()
22615 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22618 * Show the given coordinates at the center of the map, @b immediately.
22620 * @param obj The map object.
22621 * @param lon Longitude to center at.
22622 * @param lat Latitude to center at.
22624 * This causes map to @b redraw its viewport's contents to the
22625 * region contining the given @p lat and @p lon, that will be moved to the
22626 * center of the map.
22628 * @see elm_map_geo_region_bring_in() for a function to move with animation.
22629 * @see elm_map_geo_region_get()
22633 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22636 * Pause or unpause the map.
22638 * @param obj The map object.
22639 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22642 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22645 * The default is off.
22647 * This will stop zooming using animation, changing zoom levels will
22648 * change instantly. This will stop any existing animations that are running.
22650 * @see elm_map_paused_get()
22654 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22657 * Get a value whether map is paused or not.
22659 * @param obj The map object.
22660 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22661 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22663 * This gets the current paused state for the map object.
22665 * @see elm_map_paused_set() for details.
22669 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22672 * Set to show markers during zoom level changes or not.
22674 * @param obj The map object.
22675 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22678 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22681 * The default is off.
22683 * This will stop zooming using animation, changing zoom levels will
22684 * change instantly. This will stop any existing animations that are running.
22686 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22689 * The default is off.
22691 * Enabling it will force the map to stop displaying the markers during
22692 * zoom level changes. Set to on if you have a large number of markers.
22694 * @see elm_map_paused_markers_get()
22698 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22701 * Get a value whether markers will be displayed on zoom level changes or not
22703 * @param obj The map object.
22704 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22705 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22707 * This gets the current markers paused state for the map object.
22709 * @see elm_map_paused_markers_set() for details.
22713 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22716 * Get the information of downloading status.
22718 * @param obj The map object.
22719 * @param try_num Pointer where to store number of tiles being downloaded.
22720 * @param finish_num Pointer where to store number of tiles successfully
22723 * This gets the current downloading status for the map object, the number
22724 * of tiles being downloaded and the number of tiles already downloaded.
22728 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22731 * Convert a pixel coordinate (x,y) into a geographic coordinate
22732 * (longitude, latitude).
22734 * @param obj The map object.
22735 * @param x the coordinate.
22736 * @param y the coordinate.
22737 * @param size the size in pixels of the map.
22738 * The map is a square and generally his size is : pow(2.0, zoom)*256.
22739 * @param lon Pointer where to store the longitude that correspond to x.
22740 * @param lat Pointer where to store the latitude that correspond to y.
22742 * @note Origin pixel point is the top left corner of the viewport.
22743 * Map zoom and size are taken on account.
22745 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22749 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);
22752 * Convert a geographic coordinate (longitude, latitude) into a pixel
22753 * coordinate (x, y).
22755 * @param obj The map object.
22756 * @param lon the longitude.
22757 * @param lat the latitude.
22758 * @param size the size in pixels of the map. The map is a square
22759 * and generally his size is : pow(2.0, zoom)*256.
22760 * @param x Pointer where to store the horizontal pixel coordinate that
22761 * correspond to the longitude.
22762 * @param y Pointer where to store the vertical pixel coordinate that
22763 * correspond to the latitude.
22765 * @note Origin pixel point is the top left corner of the viewport.
22766 * Map zoom and size are taken on account.
22768 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22772 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);
22775 * Convert a geographic coordinate (longitude, latitude) into a name
22778 * @param obj The map object.
22779 * @param lon the longitude.
22780 * @param lat the latitude.
22781 * @return name A #Elm_Map_Name handle for this coordinate.
22783 * To get the string for this address, elm_map_name_address_get()
22786 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
22790 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22793 * Convert a name (address) into a geographic coordinate
22794 * (longitude, latitude).
22796 * @param obj The map object.
22797 * @param name The address.
22798 * @return name A #Elm_Map_Name handle for this address.
22800 * To get the longitude and latitude, elm_map_name_region_get()
22803 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
22807 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
22810 * Convert a pixel coordinate into a rotated pixel coordinate.
22812 * @param obj The map object.
22813 * @param x horizontal coordinate of the point to rotate.
22814 * @param y vertical coordinate of the point to rotate.
22815 * @param cx rotation's center horizontal position.
22816 * @param cy rotation's center vertical position.
22817 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
22818 * @param xx Pointer where to store rotated x.
22819 * @param yy Pointer where to store rotated y.
22823 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);
22826 * Add a new marker to the map object.
22828 * @param obj The map object.
22829 * @param lon The longitude of the marker.
22830 * @param lat The latitude of the marker.
22831 * @param clas The class, to use when marker @b isn't grouped to others.
22832 * @param clas_group The class group, to use when marker is grouped to others
22833 * @param data The data passed to the callbacks.
22835 * @return The created marker or @c NULL upon failure.
22837 * A marker will be created and shown in a specific point of the map, defined
22838 * by @p lon and @p lat.
22840 * It will be displayed using style defined by @p class when this marker
22841 * is displayed alone (not grouped). A new class can be created with
22842 * elm_map_marker_class_new().
22844 * If the marker is grouped to other markers, it will be displayed with
22845 * style defined by @p class_group. Markers with the same group are grouped
22846 * if they are close. A new group class can be created with
22847 * elm_map_marker_group_class_new().
22849 * Markers created with this method can be deleted with
22850 * elm_map_marker_remove().
22852 * A marker can have associated content to be displayed by a bubble,
22853 * when a user click over it, as well as an icon. These objects will
22854 * be fetch using class' callback functions.
22856 * @see elm_map_marker_class_new()
22857 * @see elm_map_marker_group_class_new()
22858 * @see elm_map_marker_remove()
22862 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);
22865 * Set the maximum numbers of markers' content to be displayed in a group.
22867 * @param obj The map object.
22868 * @param max The maximum numbers of items displayed in a bubble.
22870 * A bubble will be displayed when the user clicks over the group,
22871 * and will place the content of markers that belong to this group
22874 * A group can have a long list of markers, consequently the creation
22875 * of the content of the bubble can be very slow.
22877 * In order to avoid this, a maximum number of items is displayed
22880 * By default this number is 30.
22882 * Marker with the same group class are grouped if they are close.
22884 * @see elm_map_marker_add()
22888 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
22891 * Remove a marker from the map.
22893 * @param marker The marker to remove.
22895 * @see elm_map_marker_add()
22899 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22902 * Get the current coordinates of the marker.
22904 * @param marker marker.
22905 * @param lat Pointer where to store the marker's latitude.
22906 * @param lon Pointer where to store the marker's longitude.
22908 * These values are set when adding markers, with function
22909 * elm_map_marker_add().
22911 * @see elm_map_marker_add()
22915 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
22918 * Animatedly bring in given marker to the center of the map.
22920 * @param marker The marker to center at.
22922 * This causes map to jump to the given @p marker's coordinates
22923 * and show it (by scrolling) in the center of the viewport, if it is not
22924 * already centered. This will use animation to do so and take a period
22925 * of time to complete.
22927 * @see elm_map_marker_show() for a function to avoid animation.
22928 * @see elm_map_marker_region_get()
22932 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22935 * Show the given marker at the center of the map, @b immediately.
22937 * @param marker The marker to center at.
22939 * This causes map to @b redraw its viewport's contents to the
22940 * region contining the given @p marker's coordinates, that will be
22941 * moved to the center of the map.
22943 * @see elm_map_marker_bring_in() for a function to move with animation.
22944 * @see elm_map_markers_list_show() if more than one marker need to be
22946 * @see elm_map_marker_region_get()
22950 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22953 * Move and zoom the map to display a list of markers.
22955 * @param markers A list of #Elm_Map_Marker handles.
22957 * The map will be centered on the center point of the markers in the list.
22958 * Then the map will be zoomed in order to fit the markers using the maximum
22959 * zoom which allows display of all the markers.
22961 * @warning All the markers should belong to the same map object.
22963 * @see elm_map_marker_show() to show a single marker.
22964 * @see elm_map_marker_bring_in()
22968 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
22971 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
22973 * @param marker The marker wich content should be returned.
22974 * @return Return the evas object if it exists, else @c NULL.
22976 * To set callback function #ElmMapMarkerGetFunc for the marker class,
22977 * elm_map_marker_class_get_cb_set() should be used.
22979 * This content is what will be inside the bubble that will be displayed
22980 * when an user clicks over the marker.
22982 * This returns the actual Evas object used to be placed inside
22983 * the bubble. This may be @c NULL, as it may
22984 * not have been created or may have been deleted, at any time, by
22985 * the map. <b>Do not modify this object</b> (move, resize,
22986 * show, hide, etc.), as the map is controlling it. This
22987 * function is for querying, emitting custom signals or hooking
22988 * lower level callbacks for events on that object. Do not delete
22989 * this object under any circumstances.
22993 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22996 * Update the marker
22998 * @param marker The marker to be updated.
23000 * If a content is set to this marker, it will call function to delete it,
23001 * #ElmMapMarkerDelFunc, and then will fetch the content again with
23002 * #ElmMapMarkerGetFunc.
23004 * These functions are set for the marker class with
23005 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23009 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23012 * Close all the bubbles opened by the user.
23014 * @param obj The map object.
23016 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23017 * when the user clicks on a marker.
23019 * This functions is set for the marker class with
23020 * elm_map_marker_class_get_cb_set().
23024 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23027 * Create a new group class.
23029 * @param obj The map object.
23030 * @return Returns the new group class.
23032 * Each marker must be associated to a group class. Markers in the same
23033 * group are grouped if they are close.
23035 * The group class defines the style of the marker when a marker is grouped
23036 * to others markers. When it is alone, another class will be used.
23038 * A group class will need to be provided when creating a marker with
23039 * elm_map_marker_add().
23041 * Some properties and functions can be set by class, as:
23042 * - style, with elm_map_group_class_style_set()
23043 * - data - to be associated to the group class. It can be set using
23044 * elm_map_group_class_data_set().
23045 * - min zoom to display markers, set with
23046 * elm_map_group_class_zoom_displayed_set().
23047 * - max zoom to group markers, set using
23048 * elm_map_group_class_zoom_grouped_set().
23049 * - visibility - set if markers will be visible or not, set with
23050 * elm_map_group_class_hide_set().
23051 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23052 * It can be set using elm_map_group_class_icon_cb_set().
23054 * @see elm_map_marker_add()
23055 * @see elm_map_group_class_style_set()
23056 * @see elm_map_group_class_data_set()
23057 * @see elm_map_group_class_zoom_displayed_set()
23058 * @see elm_map_group_class_zoom_grouped_set()
23059 * @see elm_map_group_class_hide_set()
23060 * @see elm_map_group_class_icon_cb_set()
23064 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23067 * Set the marker's style of a group class.
23069 * @param clas The group class.
23070 * @param style The style to be used by markers.
23072 * Each marker must be associated to a group class, and will use the style
23073 * defined by such class when grouped to other markers.
23075 * The following styles are provided by default theme:
23076 * @li @c radio - blue circle
23077 * @li @c radio2 - green circle
23080 * @see elm_map_group_class_new() for more details.
23081 * @see elm_map_marker_add()
23085 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23088 * Set the icon callback function of a group class.
23090 * @param clas The group class.
23091 * @param icon_get The callback function that will return the icon.
23093 * Each marker must be associated to a group class, and it can display a
23094 * custom icon. The function @p icon_get must return this icon.
23096 * @see elm_map_group_class_new() for more details.
23097 * @see elm_map_marker_add()
23101 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23104 * Set the data associated to the group class.
23106 * @param clas The group class.
23107 * @param data The new user data.
23109 * This data will be passed for callback functions, like icon get callback,
23110 * that can be set with elm_map_group_class_icon_cb_set().
23112 * If a data was previously set, the object will lose the pointer for it,
23113 * so if needs to be freed, you must do it yourself.
23115 * @see elm_map_group_class_new() for more details.
23116 * @see elm_map_group_class_icon_cb_set()
23117 * @see elm_map_marker_add()
23121 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23124 * Set the minimum zoom from where the markers are displayed.
23126 * @param clas The group class.
23127 * @param zoom The minimum zoom.
23129 * Markers only will be displayed when the map is displayed at @p zoom
23132 * @see elm_map_group_class_new() for more details.
23133 * @see elm_map_marker_add()
23137 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23140 * Set the zoom from where the markers are no more grouped.
23142 * @param clas The group class.
23143 * @param zoom The maximum zoom.
23145 * Markers only will be grouped when the map is displayed at
23146 * less than @p zoom.
23148 * @see elm_map_group_class_new() for more details.
23149 * @see elm_map_marker_add()
23153 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23156 * Set if the markers associated to the group class @clas are hidden or not.
23158 * @param clas The group class.
23159 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23162 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23167 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23170 * Create a new marker class.
23172 * @param obj The map object.
23173 * @return Returns the new group class.
23175 * Each marker must be associated to a class.
23177 * The marker class defines the style of the marker when a marker is
23178 * displayed alone, i.e., not grouped to to others markers. When grouped
23179 * it will use group class style.
23181 * A marker class will need to be provided when creating a marker with
23182 * elm_map_marker_add().
23184 * Some properties and functions can be set by class, as:
23185 * - style, with elm_map_marker_class_style_set()
23186 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23187 * It can be set using elm_map_marker_class_icon_cb_set().
23188 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23189 * Set using elm_map_marker_class_get_cb_set().
23190 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23191 * Set using elm_map_marker_class_del_cb_set().
23193 * @see elm_map_marker_add()
23194 * @see elm_map_marker_class_style_set()
23195 * @see elm_map_marker_class_icon_cb_set()
23196 * @see elm_map_marker_class_get_cb_set()
23197 * @see elm_map_marker_class_del_cb_set()
23201 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23204 * Set the marker's style of a marker class.
23206 * @param clas The marker class.
23207 * @param style The style to be used by markers.
23209 * Each marker must be associated to a marker class, and will use the style
23210 * defined by such class when alone, i.e., @b not grouped to other markers.
23212 * The following styles are provided by default theme:
23217 * @see elm_map_marker_class_new() for more details.
23218 * @see elm_map_marker_add()
23222 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23225 * Set the icon callback function of a marker class.
23227 * @param clas The marker class.
23228 * @param icon_get The callback function that will return the icon.
23230 * Each marker must be associated to a marker class, and it can display a
23231 * custom icon. The function @p icon_get must return this icon.
23233 * @see elm_map_marker_class_new() for more details.
23234 * @see elm_map_marker_add()
23238 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23241 * Set the bubble content callback function of a marker class.
23243 * @param clas The marker class.
23244 * @param get The callback function that will return the content.
23246 * Each marker must be associated to a marker class, and it can display a
23247 * a content on a bubble that opens when the user click over the marker.
23248 * The function @p get must return this content object.
23250 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23253 * @see elm_map_marker_class_new() for more details.
23254 * @see elm_map_marker_class_del_cb_set()
23255 * @see elm_map_marker_add()
23259 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23262 * Set the callback function used to delete bubble content of a marker class.
23264 * @param clas The marker class.
23265 * @param del The callback function that will delete the content.
23267 * Each marker must be associated to a marker class, and it can display a
23268 * a content on a bubble that opens when the user click over the marker.
23269 * The function to return such content can be set with
23270 * elm_map_marker_class_get_cb_set().
23272 * If this content must be freed, a callback function need to be
23273 * set for that task with this function.
23275 * If this callback is defined it will have to delete (or not) the
23276 * object inside, but if the callback is not defined the object will be
23277 * destroyed with evas_object_del().
23279 * @see elm_map_marker_class_new() for more details.
23280 * @see elm_map_marker_class_get_cb_set()
23281 * @see elm_map_marker_add()
23285 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23288 * Get the list of available sources.
23290 * @param obj The map object.
23291 * @return The source names list.
23293 * It will provide a list with all available sources, that can be set as
23294 * current source with elm_map_source_name_set(), or get with
23295 * elm_map_source_name_get().
23297 * Available sources:
23303 * @see elm_map_source_name_set() for more details.
23304 * @see elm_map_source_name_get()
23308 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23311 * Set the source of the map.
23313 * @param obj The map object.
23314 * @param source The source to be used.
23316 * Map widget retrieves images that composes the map from a web service.
23317 * This web service can be set with this method.
23319 * A different service can return a different maps with different
23320 * information and it can use different zoom values.
23322 * The @p source_name need to match one of the names provided by
23323 * elm_map_source_names_get().
23325 * The current source can be get using elm_map_source_name_get().
23327 * @see elm_map_source_names_get()
23328 * @see elm_map_source_name_get()
23333 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23336 * Get the name of currently used source.
23338 * @param obj The map object.
23339 * @return Returns the name of the source in use.
23341 * @see elm_map_source_name_set() for more details.
23345 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23348 * Set the source of the route service to be used by the map.
23350 * @param obj The map object.
23351 * @param source The route service to be used, being it one of
23352 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23353 * and #ELM_MAP_ROUTE_SOURCE_ORS.
23355 * Each one has its own algorithm, so the route retrieved may
23356 * differ depending on the source route. Now, only the default is working.
23358 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23359 * http://www.yournavigation.org/.
23361 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23362 * assumptions. Its routing core is based on Contraction Hierarchies.
23364 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23366 * @see elm_map_route_source_get().
23370 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23373 * Get the current route source.
23375 * @param obj The map object.
23376 * @return The source of the route service used by the map.
23378 * @see elm_map_route_source_set() for details.
23382 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23385 * Set the minimum zoom of the source.
23387 * @param obj The map object.
23388 * @param zoom New minimum zoom value to be used.
23390 * By default, it's 0.
23394 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23397 * Get the minimum zoom of the source.
23399 * @param obj The map object.
23400 * @return Returns the minimum zoom of the source.
23402 * @see elm_map_source_zoom_min_set() for details.
23406 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23409 * Set the maximum zoom of the source.
23411 * @param obj The map object.
23412 * @param zoom New maximum zoom value to be used.
23414 * By default, it's 18.
23418 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23421 * Get the maximum zoom of the source.
23423 * @param obj The map object.
23424 * @return Returns the maximum zoom of the source.
23426 * @see elm_map_source_zoom_min_set() for details.
23430 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23433 * Set the user agent used by the map object to access routing services.
23435 * @param obj The map object.
23436 * @param user_agent The user agent to be used by the map.
23438 * User agent is a client application implementing a network protocol used
23439 * in communications within a clientāserver distributed computing system
23441 * The @p user_agent identification string will transmitted in a header
23442 * field @c User-Agent.
23444 * @see elm_map_user_agent_get()
23448 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23451 * Get the user agent used by the map object.
23453 * @param obj The map object.
23454 * @return The user agent identification string used by the map.
23456 * @see elm_map_user_agent_set() for details.
23460 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23463 * Add a new route to the map object.
23465 * @param obj The map object.
23466 * @param type The type of transport to be considered when tracing a route.
23467 * @param method The routing method, what should be priorized.
23468 * @param flon The start longitude.
23469 * @param flat The start latitude.
23470 * @param tlon The destination longitude.
23471 * @param tlat The destination latitude.
23473 * @return The created route or @c NULL upon failure.
23475 * A route will be traced by point on coordinates (@p flat, @p flon)
23476 * to point on coordinates (@p tlat, @p tlon), using the route service
23477 * set with elm_map_route_source_set().
23479 * It will take @p type on consideration to define the route,
23480 * depending if the user will be walking or driving, the route may vary.
23481 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23482 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23484 * Another parameter is what the route should priorize, the minor distance
23485 * or the less time to be spend on the route. So @p method should be one
23486 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23488 * Routes created with this method can be deleted with
23489 * elm_map_route_remove(), colored with elm_map_route_color_set(),
23490 * and distance can be get with elm_map_route_distance_get().
23492 * @see elm_map_route_remove()
23493 * @see elm_map_route_color_set()
23494 * @see elm_map_route_distance_get()
23495 * @see elm_map_route_source_set()
23499 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);
23502 * Remove a route from the map.
23504 * @param route The route to remove.
23506 * @see elm_map_route_add()
23510 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23513 * Set the route color.
23515 * @param route The route object.
23516 * @param r Red channel value, from 0 to 255.
23517 * @param g Green channel value, from 0 to 255.
23518 * @param b Blue channel value, from 0 to 255.
23519 * @param a Alpha channel value, from 0 to 255.
23521 * It uses an additive color model, so each color channel represents
23522 * how much of each primary colors must to be used. 0 represents
23523 * ausence of this color, so if all of the three are set to 0,
23524 * the color will be black.
23526 * These component values should be integers in the range 0 to 255,
23527 * (single 8-bit byte).
23529 * This sets the color used for the route. By default, it is set to
23530 * solid red (r = 255, g = 0, b = 0, a = 255).
23532 * For alpha channel, 0 represents completely transparent, and 255, opaque.
23534 * @see elm_map_route_color_get()
23538 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23541 * Get the route color.
23543 * @param route The route object.
23544 * @param r Pointer where to store the red channel value.
23545 * @param g Pointer where to store the green channel value.
23546 * @param b Pointer where to store the blue channel value.
23547 * @param a Pointer where to store the alpha channel value.
23549 * @see elm_map_route_color_set() for details.
23553 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23556 * Get the route distance in kilometers.
23558 * @param route The route object.
23559 * @return The distance of route (unit : km).
23563 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23566 * Get the information of route nodes.
23568 * @param route The route object.
23569 * @return Returns a string with the nodes of route.
23573 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23576 * Get the information of route waypoint.
23578 * @param route the route object.
23579 * @return Returns a string with information about waypoint of route.
23583 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23586 * Get the address of the name.
23588 * @param name The name handle.
23589 * @return Returns the address string of @p name.
23591 * This gets the coordinates of the @p name, created with one of the
23592 * conversion functions.
23594 * @see elm_map_utils_convert_name_into_coord()
23595 * @see elm_map_utils_convert_coord_into_name()
23599 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23602 * Get the current coordinates of the name.
23604 * @param name The name handle.
23605 * @param lat Pointer where to store the latitude.
23606 * @param lon Pointer where to store The longitude.
23608 * This gets the coordinates of the @p name, created with one of the
23609 * conversion functions.
23611 * @see elm_map_utils_convert_name_into_coord()
23612 * @see elm_map_utils_convert_coord_into_name()
23616 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23619 * Remove a name from the map.
23621 * @param name The name to remove.
23623 * Basically the struct handled by @p name will be freed, so convertions
23624 * between address and coordinates will be lost.
23626 * @see elm_map_utils_convert_name_into_coord()
23627 * @see elm_map_utils_convert_coord_into_name()
23631 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23636 * @param obj The map object.
23637 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23638 * @param cx Rotation's center horizontal position.
23639 * @param cy Rotation's center vertical position.
23641 * @see elm_map_rotate_get()
23645 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23648 * Get the rotate degree of the map
23650 * @param obj The map object
23651 * @param degree Pointer where to store degrees from 0.0 to 360.0
23652 * to rotate arount Z axis.
23653 * @param cx Pointer where to store rotation's center horizontal position.
23654 * @param cy Pointer where to store rotation's center vertical position.
23656 * @see elm_map_rotate_set() to set map rotation.
23660 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);
23663 * Enable or disable mouse wheel to be used to zoom in / out the map.
23665 * @param obj The map object.
23666 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23669 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23671 * It's disabled by default.
23673 * @see elm_map_wheel_disabled_get()
23677 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23680 * Get a value whether mouse wheel is enabled or not.
23682 * @param obj The map object.
23683 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23684 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23686 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23688 * @see elm_map_wheel_disabled_set() for details.
23692 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23696 * Add a track on the map
23698 * @param obj The map object.
23699 * @param emap The emap route object.
23700 * @return The route object. This is an elm object of type Route.
23702 * @see elm_route_add() for details.
23706 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23710 * Remove a track from the map
23712 * @param obj The map object.
23713 * @param route The track to remove.
23717 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23724 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23726 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23728 EAPI double elm_route_lon_min_get(Evas_Object *obj);
23729 EAPI double elm_route_lat_min_get(Evas_Object *obj);
23730 EAPI double elm_route_lon_max_get(Evas_Object *obj);
23731 EAPI double elm_route_lat_max_get(Evas_Object *obj);
23735 * @defgroup Panel Panel
23737 * @image html img/widget/panel/preview-00.png
23738 * @image latex img/widget/panel/preview-00.eps
23740 * @brief A panel is a type of animated container that contains subobjects.
23741 * It can be expanded or contracted by clicking the button on it's edge.
23743 * Orientations are as follows:
23744 * @li ELM_PANEL_ORIENT_TOP
23745 * @li ELM_PANEL_ORIENT_LEFT
23746 * @li ELM_PANEL_ORIENT_RIGHT
23748 * To set/get/unset the content of the panel, you can use
23749 * elm_object_content_set/get/unset APIs.
23750 * Once the content object is set, a previously set one will be deleted.
23751 * If you want to keep that old content object, use the
23752 * elm_object_content_unset() function
23754 * @ref tutorial_panel shows one way to use this widget.
23757 typedef enum _Elm_Panel_Orient
23759 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23760 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23761 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23762 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23763 } Elm_Panel_Orient;
23765 * @brief Adds a panel object
23767 * @param parent The parent object
23769 * @return The panel object, or NULL on failure
23771 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23773 * @brief Sets the orientation of the panel
23775 * @param parent The parent object
23776 * @param orient The panel orientation. Can be one of the following:
23777 * @li ELM_PANEL_ORIENT_TOP
23778 * @li ELM_PANEL_ORIENT_LEFT
23779 * @li ELM_PANEL_ORIENT_RIGHT
23781 * Sets from where the panel will (dis)appear.
23783 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
23785 * @brief Get the orientation of the panel.
23787 * @param obj The panel object
23788 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
23790 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23792 * @brief Set the content of the panel.
23794 * @param obj The panel object
23795 * @param content The panel content
23797 * Once the content object is set, a previously set one will be deleted.
23798 * If you want to keep that old content object, use the
23799 * elm_panel_content_unset() function.
23801 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23803 * @brief Get the content of the panel.
23805 * @param obj The panel object
23806 * @return The content that is being used
23808 * Return the content object which is set for this widget.
23810 * @see elm_panel_content_set()
23812 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23814 * @brief Unset the content of the panel.
23816 * @param obj The panel object
23817 * @return The content that was being used
23819 * Unparent and return the content object which was set for this widget.
23821 * @see elm_panel_content_set()
23823 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23825 * @brief Set the state of the panel.
23827 * @param obj The panel object
23828 * @param hidden If true, the panel will run the animation to contract
23830 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
23832 * @brief Get the state of the panel.
23834 * @param obj The panel object
23835 * @param hidden If true, the panel is in the "hide" state
23837 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23839 * @brief Toggle the hidden state of the panel from code
23841 * @param obj The panel object
23843 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
23849 * @defgroup Panes Panes
23850 * @ingroup Elementary
23852 * @image html img/widget/panes/preview-00.png
23853 * @image latex img/widget/panes/preview-00.eps width=\textwidth
23855 * @image html img/panes.png
23856 * @image latex img/panes.eps width=\textwidth
23858 * The panes adds a dragable bar between two contents. When dragged
23859 * this bar will resize contents size.
23861 * Panes can be displayed vertically or horizontally, and contents
23862 * size proportion can be customized (homogeneous by default).
23864 * Smart callbacks one can listen to:
23865 * - "press" - The panes has been pressed (button wasn't released yet).
23866 * - "unpressed" - The panes was released after being pressed.
23867 * - "clicked" - The panes has been clicked>
23868 * - "clicked,double" - The panes has been double clicked
23870 * Available styles for it:
23873 * Default contents parts of the panes widget that you can use for are:
23874 * @li "elm.swallow.left" - A leftside content of the panes
23875 * @li "elm.swallow.right" - A rightside content of the panes
23877 * If panes is displayed vertically, left content will be displayed at
23880 * Here is an example on its usage:
23881 * @li @ref panes_example
23884 #define ELM_PANES_CONTENT_LEFT "elm.swallow.left"
23885 #define ELM_PANES_CONTENT_RIGHT "elm.swallow.right"
23888 * @addtogroup Panes
23893 * Add a new panes widget to the given parent Elementary
23894 * (container) object.
23896 * @param parent The parent object.
23897 * @return a new panes widget handle or @c NULL, on errors.
23899 * This function inserts a new panes widget on the canvas.
23903 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23906 * Set the left content of the panes widget.
23908 * @param obj The panes object.
23909 * @param content The new left content object.
23911 * Once the content object is set, a previously set one will be deleted.
23912 * If you want to keep that old content object, use the
23913 * elm_panes_content_left_unset() function.
23915 * If panes is displayed vertically, left content will be displayed at
23918 * @see elm_panes_content_left_get()
23919 * @see elm_panes_content_right_set() to set content on the other side.
23923 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23926 * Set the right content of the panes widget.
23928 * @param obj The panes object.
23929 * @param content The new right content object.
23931 * Once the content object is set, a previously set one will be deleted.
23932 * If you want to keep that old content object, use the
23933 * elm_panes_content_right_unset() function.
23935 * If panes is displayed vertically, left content will be displayed at
23938 * @see elm_panes_content_right_get()
23939 * @see elm_panes_content_left_set() to set content on the other side.
23943 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23946 * Get the left content of the panes.
23948 * @param obj The panes object.
23949 * @return The left content object that is being used.
23951 * Return the left content object which is set for this widget.
23953 * @see elm_panes_content_left_set() for details.
23957 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23960 * Get the right content of the panes.
23962 * @param obj The panes object
23963 * @return The right content object that is being used
23965 * Return the right content object which is set for this widget.
23967 * @see elm_panes_content_right_set() for details.
23971 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23974 * Unset the left content used for the panes.
23976 * @param obj The panes object.
23977 * @return The left content object that was being used.
23979 * Unparent and return the left content object which was set for this widget.
23981 * @see elm_panes_content_left_set() for details.
23982 * @see elm_panes_content_left_get().
23986 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23989 * Unset the right content used for the panes.
23991 * @param obj The panes object.
23992 * @return The right content object that was being used.
23994 * Unparent and return the right content object which was set for this
23997 * @see elm_panes_content_right_set() for details.
23998 * @see elm_panes_content_right_get().
24002 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24005 * Get the size proportion of panes widget's left side.
24007 * @param obj The panes object.
24008 * @return float value between 0.0 and 1.0 representing size proportion
24011 * @see elm_panes_content_left_size_set() for more details.
24015 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24018 * Set the size proportion of panes widget's left side.
24020 * @param obj The panes object.
24021 * @param size Value between 0.0 and 1.0 representing size proportion
24024 * By default it's homogeneous, i.e., both sides have the same size.
24026 * If something different is required, it can be set with this function.
24027 * For example, if the left content should be displayed over
24028 * 75% of the panes size, @p size should be passed as @c 0.75.
24029 * This way, right content will be resized to 25% of panes size.
24031 * If displayed vertically, left content is displayed at top, and
24032 * right content at bottom.
24034 * @note This proportion will change when user drags the panes bar.
24036 * @see elm_panes_content_left_size_get()
24040 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24043 * Set the orientation of a given panes widget.
24045 * @param obj The panes object.
24046 * @param horizontal Use @c EINA_TRUE to make @p obj to be
24047 * @b horizontal, @c EINA_FALSE to make it @b vertical.
24049 * Use this function to change how your panes is to be
24050 * disposed: vertically or horizontally.
24052 * By default it's displayed horizontally.
24054 * @see elm_panes_horizontal_get()
24058 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24061 * Retrieve the orientation of a given panes widget.
24063 * @param obj The panes object.
24064 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24065 * @c EINA_FALSE if it's @b vertical (and on errors).
24067 * @see elm_panes_horizontal_set() for more details.
24071 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24072 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24073 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24080 * @defgroup Flip Flip
24082 * @image html img/widget/flip/preview-00.png
24083 * @image latex img/widget/flip/preview-00.eps
24085 * This widget holds 2 content objects(Evas_Object): one on the front and one
24086 * on the back. It allows you to flip from front to back and vice-versa using
24087 * various animations.
24089 * If either the front or back contents are not set the flip will treat that
24090 * as transparent. So if you wore to set the front content but not the back,
24091 * and then call elm_flip_go() you would see whatever is below the flip.
24093 * For a list of supported animations see elm_flip_go().
24095 * Signals that you can add callbacks for are:
24096 * "animate,begin" - when a flip animation was started
24097 * "animate,done" - when a flip animation is finished
24099 * @ref tutorial_flip show how to use most of the API.
24103 typedef enum _Elm_Flip_Mode
24105 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24106 ELM_FLIP_ROTATE_X_CENTER_AXIS,
24107 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24108 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24109 ELM_FLIP_CUBE_LEFT,
24110 ELM_FLIP_CUBE_RIGHT,
24112 ELM_FLIP_CUBE_DOWN,
24113 ELM_FLIP_PAGE_LEFT,
24114 ELM_FLIP_PAGE_RIGHT,
24118 typedef enum _Elm_Flip_Interaction
24120 ELM_FLIP_INTERACTION_NONE,
24121 ELM_FLIP_INTERACTION_ROTATE,
24122 ELM_FLIP_INTERACTION_CUBE,
24123 ELM_FLIP_INTERACTION_PAGE
24124 } Elm_Flip_Interaction;
24125 typedef enum _Elm_Flip_Direction
24127 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24128 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24129 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24130 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24131 } Elm_Flip_Direction;
24133 * @brief Add a new flip to the parent
24135 * @param parent The parent object
24136 * @return The new object or NULL if it cannot be created
24138 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24140 * @brief Set the front content of the flip widget.
24142 * @param obj The flip object
24143 * @param content The new front content object
24145 * Once the content object is set, a previously set one will be deleted.
24146 * If you want to keep that old content object, use the
24147 * elm_flip_content_front_unset() function.
24149 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24151 * @brief Set the back content of the flip widget.
24153 * @param obj The flip object
24154 * @param content The new back content object
24156 * Once the content object is set, a previously set one will be deleted.
24157 * If you want to keep that old content object, use the
24158 * elm_flip_content_back_unset() function.
24160 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24162 * @brief Get the front content used for the flip
24164 * @param obj The flip object
24165 * @return The front content object that is being used
24167 * Return the front content object which is set for this widget.
24169 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24171 * @brief Get the back content used for the flip
24173 * @param obj The flip object
24174 * @return The back content object that is being used
24176 * Return the back content object which is set for this widget.
24178 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24180 * @brief Unset the front content used for the flip
24182 * @param obj The flip object
24183 * @return The front content object that was being used
24185 * Unparent and return the front content object which was set for this widget.
24187 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24189 * @brief Unset the back content used for the flip
24191 * @param obj The flip object
24192 * @return The back content object that was being used
24194 * Unparent and return the back content object which was set for this widget.
24196 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24198 * @brief Get flip front visibility state
24200 * @param obj The flip objct
24201 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24204 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24206 * @brief Set flip perspective
24208 * @param obj The flip object
24209 * @param foc The coordinate to set the focus on
24210 * @param x The X coordinate
24211 * @param y The Y coordinate
24213 * @warning This function currently does nothing.
24215 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24217 * @brief Runs the flip animation
24219 * @param obj The flip object
24220 * @param mode The mode type
24222 * Flips the front and back contents using the @p mode animation. This
24223 * efectively hides the currently visible content and shows the hidden one.
24225 * There a number of possible animations to use for the flipping:
24226 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24227 * around a horizontal axis in the middle of its height, the other content
24228 * is shown as the other side of the flip.
24229 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24230 * around a vertical axis in the middle of its width, the other content is
24231 * shown as the other side of the flip.
24232 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24233 * around a diagonal axis in the middle of its width, the other content is
24234 * shown as the other side of the flip.
24235 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24236 * around a diagonal axis in the middle of its height, the other content is
24237 * shown as the other side of the flip.
24238 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24239 * as if the flip was a cube, the other content is show as the right face of
24241 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24242 * right as if the flip was a cube, the other content is show as the left
24243 * face of the cube.
24244 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24245 * flip was a cube, the other content is show as the bottom face of the cube.
24246 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24247 * the flip was a cube, the other content is show as the upper face of the
24249 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24250 * if the flip was a book, the other content is shown as the page below that.
24251 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24252 * as if the flip was a book, the other content is shown as the page below
24254 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24255 * flip was a book, the other content is shown as the page below that.
24256 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24257 * flip was a book, the other content is shown as the page below that.
24259 * @image html elm_flip.png
24260 * @image latex elm_flip.eps width=\textwidth
24262 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24264 * @brief Set the interactive flip mode
24266 * @param obj The flip object
24267 * @param mode The interactive flip mode to use
24269 * This sets if the flip should be interactive (allow user to click and
24270 * drag a side of the flip to reveal the back page and cause it to flip).
24271 * By default a flip is not interactive. You may also need to set which
24272 * sides of the flip are "active" for flipping and how much space they use
24273 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24274 * and elm_flip_interacton_direction_hitsize_set()
24276 * The four avilable mode of interaction are:
24277 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24278 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24279 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24280 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24282 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24283 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24284 * happen, those can only be acheived with elm_flip_go();
24286 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24288 * @brief Get the interactive flip mode
24290 * @param obj The flip object
24291 * @return The interactive flip mode
24293 * Returns the interactive flip mode set by elm_flip_interaction_set()
24295 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24297 * @brief Set which directions of the flip respond to interactive flip
24299 * @param obj The flip object
24300 * @param dir The direction to change
24301 * @param enabled If that direction is enabled or not
24303 * By default all directions are disabled, so you may want to enable the
24304 * desired directions for flipping if you need interactive flipping. You must
24305 * call this function once for each direction that should be enabled.
24307 * @see elm_flip_interaction_set()
24309 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24311 * @brief Get the enabled state of that flip direction
24313 * @param obj The flip object
24314 * @param dir The direction to check
24315 * @return If that direction is enabled or not
24317 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24319 * @see elm_flip_interaction_set()
24321 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24323 * @brief Set the amount of the flip that is sensitive to interactive flip
24325 * @param obj The flip object
24326 * @param dir The direction to modify
24327 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24329 * Set the amount of the flip that is sensitive to interactive flip, with 0
24330 * representing no area in the flip and 1 representing the entire flip. There
24331 * is however a consideration to be made in that the area will never be
24332 * smaller than the finger size set(as set in your Elementary configuration).
24334 * @see elm_flip_interaction_set()
24336 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24338 * @brief Get the amount of the flip that is sensitive to interactive flip
24340 * @param obj The flip object
24341 * @param dir The direction to check
24342 * @return The size set for that direction
24344 * Returns the amount os sensitive area set by
24345 * elm_flip_interacton_direction_hitsize_set().
24347 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24352 /* scrolledentry */
24353 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24354 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24355 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24356 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24357 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24358 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24359 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24360 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24361 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24362 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24363 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24364 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24365 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24366 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24367 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24368 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24369 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24370 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24371 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24372 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24373 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24374 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24375 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24376 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24377 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24378 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24379 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24380 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24381 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24382 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24383 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24384 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24385 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24386 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24387 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24388 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);
24389 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24390 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24391 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);
24392 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24393 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);
24394 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24395 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24396 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24397 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24398 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24399 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24400 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24401 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24402 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);
24403 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);
24404 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);
24405 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);
24406 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);
24407 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);
24408 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24409 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24410 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24411 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24412 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24413 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24414 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24415 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
24416 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
24417 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
24418 EINA_DEPRECATED EAPI Ecore_IMF_Context *elm_scrolled_entry_imf_context_get(Evas_Object *obj);
24419 EINA_DEPRECATED EAPI void elm_scrolled_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
24420 EINA_DEPRECATED EAPI void elm_scrolled_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
24423 * @defgroup Conformant Conformant
24424 * @ingroup Elementary
24426 * @image html img/widget/conformant/preview-00.png
24427 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24429 * @image html img/conformant.png
24430 * @image latex img/conformant.eps width=\textwidth
24432 * The aim is to provide a widget that can be used in elementary apps to
24433 * account for space taken up by the indicator, virtual keypad & softkey
24434 * windows when running the illume2 module of E17.
24436 * So conformant content will be sized and positioned considering the
24437 * space required for such stuff, and when they popup, as a keyboard
24438 * shows when an entry is selected, conformant content won't change.
24440 * Available styles for it:
24443 * Default contents parts of the conformant widget that you can use for are:
24445 * @li "elm.swallow.content" - A content of the conformant
24447 * See how to use this widget in this example:
24448 * @ref conformant_example
24452 * @addtogroup Conformant
24457 * Add a new conformant widget to the given parent Elementary
24458 * (container) object.
24460 * @param parent The parent object.
24461 * @return A new conformant widget handle or @c NULL, on errors.
24463 * This function inserts a new conformant widget on the canvas.
24465 * @ingroup Conformant
24467 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24470 * Set the content of the conformant widget.
24472 * @param obj The conformant object.
24473 * @param content The content to be displayed by the conformant.
24475 * Content will be sized and positioned considering the space required
24476 * to display a virtual keyboard. So it won't fill all the conformant
24477 * size. This way is possible to be sure that content won't resize
24478 * or be re-positioned after the keyboard is displayed.
24480 * Once the content object is set, a previously set one will be deleted.
24481 * If you want to keep that old content object, use the
24482 * elm_object_content_unset() function.
24484 * @see elm_object_content_unset()
24485 * @see elm_object_content_get()
24487 * @ingroup Conformant
24489 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24492 * Get the content of the conformant widget.
24494 * @param obj The conformant object.
24495 * @return The content that is being used.
24497 * Return the content object which is set for this widget.
24498 * It won't be unparent from conformant. For that, use
24499 * elm_object_content_unset().
24501 * @see elm_object_content_set().
24502 * @see elm_object_content_unset()
24504 * @ingroup Conformant
24506 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24509 * Unset the content of the conformant widget.
24511 * @param obj The conformant object.
24512 * @return The content that was being used.
24514 * Unparent and return the content object which was set for this widget.
24516 * @see elm_object_content_set().
24518 * @ingroup Conformant
24520 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24523 * Returns the Evas_Object that represents the content area.
24525 * @param obj The conformant object.
24526 * @return The content area of the widget.
24528 * @ingroup Conformant
24530 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24537 * @defgroup Mapbuf Mapbuf
24538 * @ingroup Elementary
24540 * @image html img/widget/mapbuf/preview-00.png
24541 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24543 * This holds one content object and uses an Evas Map of transformation
24544 * points to be later used with this content. So the content will be
24545 * moved, resized, etc as a single image. So it will improve performance
24546 * when you have a complex interafce, with a lot of elements, and will
24547 * need to resize or move it frequently (the content object and its
24550 * To set/get/unset the content of the mapbuf, you can use
24551 * elm_object_content_set/get/unset APIs.
24552 * Once the content object is set, a previously set one will be deleted.
24553 * If you want to keep that old content object, use the
24554 * elm_object_content_unset() function.
24556 * To enable map, elm_mapbuf_enabled_set() should be used.
24558 * See how to use this widget in this example:
24559 * @ref mapbuf_example
24563 * @addtogroup Mapbuf
24568 * Add a new mapbuf widget to the given parent Elementary
24569 * (container) object.
24571 * @param parent The parent object.
24572 * @return A new mapbuf widget handle or @c NULL, on errors.
24574 * This function inserts a new mapbuf widget on the canvas.
24578 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24581 * Set the content of the mapbuf.
24583 * @param obj The mapbuf object.
24584 * @param content The content that will be filled in this mapbuf object.
24586 * Once the content object is set, a previously set one will be deleted.
24587 * If you want to keep that old content object, use the
24588 * elm_mapbuf_content_unset() function.
24590 * To enable map, elm_mapbuf_enabled_set() should be used.
24594 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24597 * Get the content of the mapbuf.
24599 * @param obj The mapbuf object.
24600 * @return The content that is being used.
24602 * Return the content object which is set for this widget.
24604 * @see elm_mapbuf_content_set() for details.
24608 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24611 * Unset the content of the mapbuf.
24613 * @param obj The mapbuf object.
24614 * @return The content that was being used.
24616 * Unparent and return the content object which was set for this widget.
24618 * @see elm_mapbuf_content_set() for details.
24622 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24625 * Enable or disable the map.
24627 * @param obj The mapbuf object.
24628 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24630 * This enables the map that is set or disables it. On enable, the object
24631 * geometry will be saved, and the new geometry will change (position and
24632 * size) to reflect the map geometry set.
24634 * Also, when enabled, alpha and smooth states will be used, so if the
24635 * content isn't solid, alpha should be enabled, for example, otherwise
24636 * a black retangle will fill the content.
24638 * When disabled, the stored map will be freed and geometry prior to
24639 * enabling the map will be restored.
24641 * It's disabled by default.
24643 * @see elm_mapbuf_alpha_set()
24644 * @see elm_mapbuf_smooth_set()
24648 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24651 * Get a value whether map is enabled or not.
24653 * @param obj The mapbuf object.
24654 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24655 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24657 * @see elm_mapbuf_enabled_set() for details.
24661 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24664 * Enable or disable smooth map rendering.
24666 * @param obj The mapbuf object.
24667 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24670 * This sets smoothing for map rendering. If the object is a type that has
24671 * its own smoothing settings, then both the smooth settings for this object
24672 * and the map must be turned off.
24674 * By default smooth maps are enabled.
24678 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24681 * Get a value whether smooth map rendering is enabled or not.
24683 * @param obj The mapbuf object.
24684 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24685 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24687 * @see elm_mapbuf_smooth_set() for details.
24691 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24694 * Set or unset alpha flag for map rendering.
24696 * @param obj The mapbuf object.
24697 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24700 * This sets alpha flag for map rendering. If the object is a type that has
24701 * its own alpha settings, then this will take precedence. Only image objects
24702 * have this currently. It stops alpha blending of the map area, and is
24703 * useful if you know the object and/or all sub-objects is 100% solid.
24705 * Alpha is enabled by default.
24709 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24712 * Get a value whether alpha blending is enabled or not.
24714 * @param obj The mapbuf object.
24715 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24716 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24718 * @see elm_mapbuf_alpha_set() for details.
24722 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24729 * @defgroup Flipselector Flip Selector
24731 * A flip selector is a widget to show a set of @b text items, one
24732 * at a time, with the same sheet switching style as the @ref Clock
24733 * "clock" widget, when one changes the current displaying sheet
24734 * (thus, the "flip" in the name).
24736 * User clicks to flip sheets which are @b held for some time will
24737 * make the flip selector to flip continuosly and automatically for
24738 * the user. The interval between flips will keep growing in time,
24739 * so that it helps the user to reach an item which is distant from
24740 * the current selection.
24742 * Smart callbacks one can register to:
24743 * - @c "selected" - when the widget's selected text item is changed
24744 * - @c "overflowed" - when the widget's current selection is changed
24745 * from the first item in its list to the last
24746 * - @c "underflowed" - when the widget's current selection is changed
24747 * from the last item in its list to the first
24749 * Available styles for it:
24752 * Here is an example on its usage:
24753 * @li @ref flipselector_example
24757 * @addtogroup Flipselector
24761 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
24764 * Add a new flip selector widget to the given parent Elementary
24765 * (container) widget
24767 * @param parent The parent object
24768 * @return a new flip selector widget handle or @c NULL, on errors
24770 * This function inserts a new flip selector widget on the canvas.
24772 * @ingroup Flipselector
24774 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24777 * Programmatically select the next item of a flip selector widget
24779 * @param obj The flipselector object
24781 * @note The selection will be animated. Also, if it reaches the
24782 * end of its list of member items, it will continue with the first
24785 * @ingroup Flipselector
24787 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24790 * Programmatically select the previous item of a flip selector
24793 * @param obj The flipselector object
24795 * @note The selection will be animated. Also, if it reaches the
24796 * beginning of its list of member items, it will continue with the
24797 * last one backwards.
24799 * @ingroup Flipselector
24801 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24804 * Append a (text) item to a flip selector widget
24806 * @param obj The flipselector object
24807 * @param label The (text) label of the new item
24808 * @param func Convenience callback function to take place when
24810 * @param data Data passed to @p func, above
24811 * @return A handle to the item added or @c NULL, on errors
24813 * The widget's list of labels to show will be appended with the
24814 * given value. If the user wishes so, a callback function pointer
24815 * can be passed, which will get called when this same item is
24818 * @note The current selection @b won't be modified by appending an
24819 * element to the list.
24821 * @note The maximum length of the text label is going to be
24822 * determined <b>by the widget's theme</b>. Strings larger than
24823 * that value are going to be @b truncated.
24825 * @ingroup Flipselector
24827 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24830 * Prepend a (text) item to a flip selector widget
24832 * @param obj The flipselector object
24833 * @param label The (text) label of the new item
24834 * @param func Convenience callback function to take place when
24836 * @param data Data passed to @p func, above
24837 * @return A handle to the item added or @c NULL, on errors
24839 * The widget's list of labels to show will be prepended with the
24840 * given value. If the user wishes so, a callback function pointer
24841 * can be passed, which will get called when this same item is
24844 * @note The current selection @b won't be modified by prepending
24845 * an element to the list.
24847 * @note The maximum length of the text label is going to be
24848 * determined <b>by the widget's theme</b>. Strings larger than
24849 * that value are going to be @b truncated.
24851 * @ingroup Flipselector
24853 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24856 * Get the internal list of items in a given flip selector widget.
24858 * @param obj The flipselector object
24859 * @return The list of items (#Elm_Flipselector_Item as data) or @c
24862 * This list is @b not to be modified in any way and must not be
24863 * freed. Use the list members with functions like
24864 * elm_flipselector_item_label_set(),
24865 * elm_flipselector_item_label_get(), elm_flipselector_item_del(),
24866 * elm_flipselector_item_del(),
24867 * elm_flipselector_item_selected_get(),
24868 * elm_flipselector_item_selected_set().
24870 * @warning This list is only valid until @p obj object's internal
24871 * items list is changed. It should be fetched again with another
24872 * call to this function when changes happen.
24874 * @ingroup Flipselector
24876 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24879 * Get the first item in the given flip selector widget's list of
24882 * @param obj The flipselector object
24883 * @return The first item or @c NULL, if it has no items (and on
24886 * @see elm_flipselector_item_append()
24887 * @see elm_flipselector_last_item_get()
24889 * @ingroup Flipselector
24891 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24894 * Get the last item in the given flip selector widget's list of
24897 * @param obj The flipselector object
24898 * @return The last item or @c NULL, if it has no items (and on
24901 * @see elm_flipselector_item_prepend()
24902 * @see elm_flipselector_first_item_get()
24904 * @ingroup Flipselector
24906 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24909 * Get the currently selected item in a flip selector widget.
24911 * @param obj The flipselector object
24912 * @return The selected item or @c NULL, if the widget has no items
24915 * @ingroup Flipselector
24917 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24920 * Set whether a given flip selector widget's item should be the
24921 * currently selected one.
24923 * @param item The flip selector item
24924 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
24926 * This sets whether @p item is or not the selected (thus, under
24927 * display) one. If @p item is different than one under display,
24928 * the latter will be unselected. If the @p item is set to be
24929 * unselected, on the other hand, the @b first item in the widget's
24930 * internal members list will be the new selected one.
24932 * @see elm_flipselector_item_selected_get()
24934 * @ingroup Flipselector
24936 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24939 * Get whether a given flip selector widget's item is the currently
24942 * @param item The flip selector item
24943 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
24946 * @see elm_flipselector_item_selected_set()
24948 * @ingroup Flipselector
24950 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24953 * Delete a given item from a flip selector widget.
24955 * @param item The item to delete
24957 * @ingroup Flipselector
24959 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24962 * Get the label of a given flip selector widget's item.
24964 * @param item The item to get label from
24965 * @return The text label of @p item or @c NULL, on errors
24967 * @see elm_flipselector_item_label_set()
24969 * @ingroup Flipselector
24971 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24974 * Set the label of a given flip selector widget's item.
24976 * @param item The item to set label on
24977 * @param label The text label string, in UTF-8 encoding
24979 * @see elm_flipselector_item_label_get()
24981 * @ingroup Flipselector
24983 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24986 * Gets the item before @p item in a flip selector widget's
24987 * internal list of items.
24989 * @param item The item to fetch previous from
24990 * @return The item before the @p item, in its parent's list. If
24991 * there is no previous item for @p item or there's an
24992 * error, @c NULL is returned.
24994 * @see elm_flipselector_item_next_get()
24996 * @ingroup Flipselector
24998 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25001 * Gets the item after @p item in a flip selector widget's
25002 * internal list of items.
25004 * @param item The item to fetch next from
25005 * @return The item after the @p item, in its parent's list. If
25006 * there is no next item for @p item or there's an
25007 * error, @c NULL is returned.
25009 * @see elm_flipselector_item_next_get()
25011 * @ingroup Flipselector
25013 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25016 * Set the interval on time updates for an user mouse button hold
25017 * on a flip selector widget.
25019 * @param obj The flip selector object
25020 * @param interval The (first) interval value in seconds
25022 * This interval value is @b decreased while the user holds the
25023 * mouse pointer either flipping up or flipping doww a given flip
25026 * This helps the user to get to a given item distant from the
25027 * current one easier/faster, as it will start to flip quicker and
25028 * quicker on mouse button holds.
25030 * The calculation for the next flip interval value, starting from
25031 * the one set with this call, is the previous interval divided by
25032 * 1.05, so it decreases a little bit.
25034 * The default starting interval value for automatic flips is
25037 * @see elm_flipselector_interval_get()
25039 * @ingroup Flipselector
25041 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25044 * Get the interval on time updates for an user mouse button hold
25045 * on a flip selector widget.
25047 * @param obj The flip selector object
25048 * @return The (first) interval value, in seconds, set on it
25050 * @see elm_flipselector_interval_set() for more details
25052 * @ingroup Flipselector
25054 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25061 * @addtogroup Animator Animator
25062 * @ingroup Elementary
25064 * @brief Functions to ease creation of animations.
25066 * elm_animator is designed to provide an easy way to create animations.
25067 * Creating an animation with elm_animator is as simple as setting a
25068 * duration, an operating callback and telling it to run the animation.
25069 * However that is not the full extent of elm_animator's ability, animations
25070 * can be paused and resumed, reversed and the animation need not be linear.
25072 * To run an animation you must specify at least a duration and operation
25073 * callback, not setting any other properties will create a linear animation
25074 * that runs once and is not reversed.
25076 * @ref elm_animator_example_page_01 "This" example should make all of that
25079 * @warning elm_animator is @b not a widget.
25083 * @brief Type of curve desired for animation.
25085 * The speed in which an animation happens doesn't have to be linear, some
25086 * animations will look better if they're accelerating or decelerating, so
25087 * elm_animator provides four options in this regard:
25088 * @image html elm_animator_curve_style.png
25089 * @image latex elm_animator_curve_style.eps width=\textwidth
25090 * As can be seen in the image the speed of the animation will be:
25091 * @li ELM_ANIMATOR_CURVE_LINEAR constant
25092 * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
25093 * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
25094 * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
25098 ELM_ANIMATOR_CURVE_LINEAR,
25099 ELM_ANIMATOR_CURVE_IN_OUT,
25100 ELM_ANIMATOR_CURVE_IN,
25101 ELM_ANIMATOR_CURVE_OUT
25102 } Elm_Animator_Curve_Style;
25103 typedef struct _Elm_Animator Elm_Animator;
25105 * Called back per loop of an elementary animators cycle
25106 * @param data user-data given to elm_animator_operation_callback_set()
25107 * @param animator the animator being run
25108 * @param double the position in the animation
25110 typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
25112 * Called back when an elementary animator finishes
25113 * @param data user-data given to elm_animator_completion_callback_set()
25115 typedef void (*Elm_Animator_Completion_Cb) (void *data);
25118 * @brief Create a new animator.
25120 * @param[in] parent Parent object
25122 * The @a parent argument can be set to NULL for no parent. If a parent is set
25123 * there is no need to call elm_animator_del(), when the parent is deleted it
25124 * will delete the animator.
25125 * @deprecated Use @ref Transit instead.
25128 EINA_DEPRECATED EAPI Elm_Animator* elm_animator_add(Evas_Object *parent);
25130 * Deletes the animator freeing any resources it used. If the animator was
25131 * created with a NULL parent this must be called, otherwise it will be
25132 * automatically called when the parent is deleted.
25134 * @param[in] animator Animator object
25135 * @deprecated Use @ref Transit instead.
25137 EINA_DEPRECATED EAPI void elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
25139 * Set the duration of the animation.
25141 * @param[in] animator Animator object
25142 * @param[in] duration Duration in second
25143 * @deprecated Use @ref Transit instead.
25145 EINA_DEPRECATED EAPI void elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
25147 * @brief Set the callback function for animator operation.
25149 * @param[in] animator Animator object
25150 * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
25151 * @param[in] data Callback function user argument
25153 * The @p func callback will be called with a frame value in range [0, 1] which
25154 * indicates how far along the animation should be. It is the job of @p func to
25155 * actually change the state of any object(or objects) that are being animated.
25156 * @deprecated Use @ref Transit instead.
25158 EINA_DEPRECATED EAPI void elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
25160 * Set the callback function for the when the animation ends.
25162 * @param[in] animator Animator object
25163 * @param[in] func Callback function pointe
25164 * @param[in] data Callback function user argument
25166 * @warning @a func will not be executed if elm_animator_stop() is called.
25167 * @deprecated Use @ref Transit instead.
25169 EINA_DEPRECATED EAPI void elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
25171 * @brief Stop animator.
25173 * @param[in] animator Animator object
25175 * If called before elm_animator_animate() it does nothing. If there is an
25176 * animation in progress the animation will be stopped(the operation callback
25177 * will not be executed again) and it can't be restarted using
25178 * elm_animator_resume().
25179 * @deprecated Use @ref Transit instead.
25181 EINA_DEPRECATED EAPI void elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
25183 * Set the animator repeat count.
25185 * @param[in] animator Animator object
25186 * @param[in] repeat_cnt Repeat count
25187 * @deprecated Use @ref Transit instead.
25189 EINA_DEPRECATED EAPI void elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
25191 * @brief Start animation.
25193 * @param[in] animator Animator object
25195 * This function starts the animation if the nescessary properties(duration
25196 * and operation callback) have been set. Once started the animation will
25197 * run until complete or elm_animator_stop() is called.
25198 * @deprecated Use @ref Transit instead.
25200 EINA_DEPRECATED EAPI void elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
25202 * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
25204 * @param[in] animator Animator object
25205 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
25206 * @deprecated Use @ref Transit instead.
25208 EINA_DEPRECATED EAPI void elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
25210 * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
25212 * @param[in] animator Animator object
25213 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
25214 * @deprecated Use @ref Transit instead.
25216 EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
25218 * @brief Sets wether the animation should be automatically reversed.
25220 * @param[in] animator Animator object
25221 * @param[in] reverse Reverse or not
25223 * This controls wether the animation will be run on reverse imediately after
25224 * running forward. When this is set together with repetition the animation
25225 * will run in reverse once for each time it ran forward.@n
25226 * Runnin an animation in reverse is accomplished by calling the operation
25227 * callback with a frame value starting at 1 and diminshing until 0.
25228 * @deprecated Use @ref Transit instead.
25230 EINA_DEPRECATED EAPI void elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
25232 * Gets wether the animation will automatically reversed
25234 * @param[in] animator Animator object
25235 * @deprecated Use @ref Transit instead.
25237 EINA_DEPRECATED EAPI Eina_Bool elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
25239 * Gets the status for the animator operation. The status of the animator @b
25240 * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
25241 * only informs if the animation was started and has not ended(either normally
25242 * or through elm_animator_stop()).
25244 * @param[in] animator Animator object
25245 * @deprecated Use @ref Transit instead.
25247 EINA_DEPRECATED EAPI Eina_Bool elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
25249 * Gets how many times the animation will be repeated
25251 * @param[in] animator Animator object
25252 * @deprecated Use @ref Transit instead.
25254 EINA_DEPRECATED EAPI unsigned int elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
25256 * Pause the animator.
25258 * @param[in] animator Animator object
25260 * This causes the animation to be temporarily stopped(the operation callback
25261 * will not be called). If the animation is not yet running this is a no-op.
25262 * Once an animation has been paused with this function it can be resumed
25263 * using elm_animator_resume().
25264 * @deprecated Use @ref Transit instead.
25266 EINA_DEPRECATED EAPI void elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
25268 * @brief Resumes the animator.
25270 * @param[in] animator Animator object
25272 * Resumes an animation that was paused using elm_animator_pause(), after
25273 * calling this function calls to the operation callback will happen
25274 * normally. If an animation is stopped by means of elm_animator_stop it
25275 * @b can't be restarted with this function.@n
25277 * @warning When an animation is resumed it doesn't start from where it was paused, it
25278 * will go to where it would have been if it had not been paused. If an
25279 * animation with a duration of 3 seconds is paused after 1 second for 1 second
25280 * it will resume as if it had ben animating for 2 seconds, the operating
25281 * callback will be called with a frame value of aproximately 2/3.
25282 * @deprecated Use @ref Transit instead.
25284 EINA_DEPRECATED EAPI void elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
25290 * @addtogroup Calendar
25295 * @enum _Elm_Calendar_Mark_Repeat
25296 * @typedef Elm_Calendar_Mark_Repeat
25298 * Event periodicity, used to define if a mark should be repeated
25299 * @b beyond event's day. It's set when a mark is added.
25301 * So, for a mark added to 13th May with periodicity set to WEEKLY,
25302 * there will be marks every week after this date. Marks will be displayed
25303 * at 13th, 20th, 27th, 3rd June ...
25305 * Values don't work as bitmask, only one can be choosen.
25307 * @see elm_calendar_mark_add()
25309 * @ingroup Calendar
25311 typedef enum _Elm_Calendar_Mark_Repeat
25313 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25314 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25315 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25316 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*/
25317 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. */
25318 } Elm_Calendar_Mark_Repeat;
25320 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(). */
25323 * Add a new calendar widget to the given parent Elementary
25324 * (container) object.
25326 * @param parent The parent object.
25327 * @return a new calendar widget handle or @c NULL, on errors.
25329 * This function inserts a new calendar widget on the canvas.
25331 * @ref calendar_example_01
25333 * @ingroup Calendar
25335 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25338 * Get weekdays names displayed by the calendar.
25340 * @param obj The calendar object.
25341 * @return Array of seven strings to be used as weekday names.
25343 * By default, weekdays abbreviations get from system are displayed:
25344 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25345 * The first string is related to Sunday, the second to Monday...
25347 * @see elm_calendar_weekdays_name_set()
25349 * @ref calendar_example_05
25351 * @ingroup Calendar
25353 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25356 * Set weekdays names to be displayed by the calendar.
25358 * @param obj The calendar object.
25359 * @param weekdays Array of seven strings to be used as weekday names.
25360 * @warning It must have 7 elements, or it will access invalid memory.
25361 * @warning The strings must be NULL terminated ('@\0').
25363 * By default, weekdays abbreviations get from system are displayed:
25364 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25366 * The first string should be related to Sunday, the second to Monday...
25368 * The usage should be like this:
25370 * const char *weekdays[] =
25372 * "Sunday", "Monday", "Tuesday", "Wednesday",
25373 * "Thursday", "Friday", "Saturday"
25375 * elm_calendar_weekdays_names_set(calendar, weekdays);
25378 * @see elm_calendar_weekdays_name_get()
25380 * @ref calendar_example_02
25382 * @ingroup Calendar
25384 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25387 * Set the minimum and maximum values for the year
25389 * @param obj The calendar object
25390 * @param min The minimum year, greater than 1901;
25391 * @param max The maximum year;
25393 * Maximum must be greater than minimum, except if you don't wan't to set
25395 * Default values are 1902 and -1.
25397 * If the maximum year is a negative value, it will be limited depending
25398 * on the platform architecture (year 2037 for 32 bits);
25400 * @see elm_calendar_min_max_year_get()
25402 * @ref calendar_example_03
25404 * @ingroup Calendar
25406 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25409 * Get the minimum and maximum values for the year
25411 * @param obj The calendar object.
25412 * @param min The minimum year.
25413 * @param max The maximum year.
25415 * Default values are 1902 and -1.
25417 * @see elm_calendar_min_max_year_get() for more details.
25419 * @ref calendar_example_05
25421 * @ingroup Calendar
25423 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25426 * Enable or disable day selection
25428 * @param obj The calendar object.
25429 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25432 * Enabled by default. If disabled, the user still can select months,
25433 * but not days. Selected days are highlighted on calendar.
25434 * It should be used if you won't need such selection for the widget usage.
25436 * When a day is selected, or month is changed, smart callbacks for
25437 * signal "changed" will be called.
25439 * @see elm_calendar_day_selection_enable_get()
25441 * @ref calendar_example_04
25443 * @ingroup Calendar
25445 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25448 * Get a value whether day selection is enabled or not.
25450 * @see elm_calendar_day_selection_enable_set() for details.
25452 * @param obj The calendar object.
25453 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25454 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25456 * @ref calendar_example_05
25458 * @ingroup Calendar
25460 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25464 * Set selected date to be highlighted on calendar.
25466 * @param obj The calendar object.
25467 * @param selected_time A @b tm struct to represent the selected date.
25469 * Set the selected date, changing the displayed month if needed.
25470 * Selected date changes when the user goes to next/previous month or
25471 * select a day pressing over it on calendar.
25473 * @see elm_calendar_selected_time_get()
25475 * @ref calendar_example_04
25477 * @ingroup Calendar
25479 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25482 * Get selected date.
25484 * @param obj The calendar object
25485 * @param selected_time A @b tm struct to point to selected date
25486 * @return EINA_FALSE means an error ocurred and returned time shouldn't
25489 * Get date selected by the user or set by function
25490 * elm_calendar_selected_time_set().
25491 * Selected date changes when the user goes to next/previous month or
25492 * select a day pressing over it on calendar.
25494 * @see elm_calendar_selected_time_get()
25496 * @ref calendar_example_05
25498 * @ingroup Calendar
25500 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25503 * Set a function to format the string that will be used to display
25506 * @param obj The calendar object
25507 * @param format_function Function to set the month-year string given
25508 * the selected date
25510 * By default it uses strftime with "%B %Y" format string.
25511 * It should allocate the memory that will be used by the string,
25512 * that will be freed by the widget after usage.
25513 * A pointer to the string and a pointer to the time struct will be provided.
25518 * _format_month_year(struct tm *selected_time)
25521 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25522 * return strdup(buf);
25525 * elm_calendar_format_function_set(calendar, _format_month_year);
25528 * @ref calendar_example_02
25530 * @ingroup Calendar
25532 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25535 * Add a new mark to the calendar
25537 * @param obj The calendar object
25538 * @param mark_type A string used to define the type of mark. It will be
25539 * emitted to the theme, that should display a related modification on these
25540 * days representation.
25541 * @param mark_time A time struct to represent the date of inclusion of the
25542 * mark. For marks that repeats it will just be displayed after the inclusion
25543 * date in the calendar.
25544 * @param repeat Repeat the event following this periodicity. Can be a unique
25545 * mark (that don't repeat), daily, weekly, monthly or annually.
25546 * @return The created mark or @p NULL upon failure.
25548 * Add a mark that will be drawn in the calendar respecting the insertion
25549 * time and periodicity. It will emit the type as signal to the widget theme.
25550 * Default theme supports "holiday" and "checked", but it can be extended.
25552 * It won't immediately update the calendar, drawing the marks.
25553 * For this, call elm_calendar_marks_draw(). However, when user selects
25554 * next or previous month calendar forces marks drawn.
25556 * Marks created with this method can be deleted with
25557 * elm_calendar_mark_del().
25561 * struct tm selected_time;
25562 * time_t current_time;
25564 * current_time = time(NULL) + 5 * 84600;
25565 * localtime_r(¤t_time, &selected_time);
25566 * elm_calendar_mark_add(cal, "holiday", selected_time,
25567 * ELM_CALENDAR_ANNUALLY);
25569 * current_time = time(NULL) + 1 * 84600;
25570 * localtime_r(¤t_time, &selected_time);
25571 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25573 * elm_calendar_marks_draw(cal);
25576 * @see elm_calendar_marks_draw()
25577 * @see elm_calendar_mark_del()
25579 * @ref calendar_example_06
25581 * @ingroup Calendar
25583 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);
25586 * Delete mark from the calendar.
25588 * @param mark The mark to be deleted.
25590 * If deleting all calendar marks is required, elm_calendar_marks_clear()
25591 * should be used instead of getting marks list and deleting each one.
25593 * @see elm_calendar_mark_add()
25595 * @ref calendar_example_06
25597 * @ingroup Calendar
25599 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25602 * Remove all calendar's marks
25604 * @param obj The calendar object.
25606 * @see elm_calendar_mark_add()
25607 * @see elm_calendar_mark_del()
25609 * @ingroup Calendar
25611 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25615 * Get a list of all the calendar marks.
25617 * @param obj The calendar object.
25618 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25620 * @see elm_calendar_mark_add()
25621 * @see elm_calendar_mark_del()
25622 * @see elm_calendar_marks_clear()
25624 * @ingroup Calendar
25626 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25629 * Draw calendar marks.
25631 * @param obj The calendar object.
25633 * Should be used after adding, removing or clearing marks.
25634 * It will go through the entire marks list updating the calendar.
25635 * If lots of marks will be added, add all the marks and then call
25638 * When the month is changed, i.e. user selects next or previous month,
25639 * marks will be drawed.
25641 * @see elm_calendar_mark_add()
25642 * @see elm_calendar_mark_del()
25643 * @see elm_calendar_marks_clear()
25645 * @ref calendar_example_06
25647 * @ingroup Calendar
25649 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25650 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25651 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25652 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25655 * Set a day text color to the same that represents Saturdays.
25657 * @param obj The calendar object.
25658 * @param pos The text position. Position is the cell counter, from left
25659 * to right, up to down. It starts on 0 and ends on 41.
25661 * @deprecated use elm_calendar_mark_add() instead like:
25664 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25665 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25668 * @see elm_calendar_mark_add()
25670 * @ingroup Calendar
25672 EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25675 * Set a day text color to the same that represents Sundays.
25677 * @param obj The calendar object.
25678 * @param pos The text position. Position is the cell counter, from left
25679 * to right, up to down. It starts on 0 and ends on 41.
25681 * @deprecated use elm_calendar_mark_add() instead like:
25684 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25685 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25688 * @see elm_calendar_mark_add()
25690 * @ingroup Calendar
25692 EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25695 * Set a day text color to the same that represents Weekdays.
25697 * @param obj The calendar object
25698 * @param pos The text position. Position is the cell counter, from left
25699 * to right, up to down. It starts on 0 and ends on 41.
25701 * @deprecated use elm_calendar_mark_add() instead like:
25704 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25706 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25707 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25708 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25709 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25710 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25711 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25712 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25713 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25714 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25717 * @see elm_calendar_mark_add()
25719 * @ingroup Calendar
25721 EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25724 * Set the interval on time updates for an user mouse button hold
25725 * on calendar widgets' month selection.
25727 * @param obj The calendar object
25728 * @param interval The (first) interval value in seconds
25730 * This interval value is @b decreased while the user holds the
25731 * mouse pointer either selecting next or previous month.
25733 * This helps the user to get to a given month distant from the
25734 * current one easier/faster, as it will start to change quicker and
25735 * quicker on mouse button holds.
25737 * The calculation for the next change interval value, starting from
25738 * the one set with this call, is the previous interval divided by
25739 * 1.05, so it decreases a little bit.
25741 * The default starting interval value for automatic changes is
25744 * @see elm_calendar_interval_get()
25746 * @ingroup Calendar
25748 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25751 * Get the interval on time updates for an user mouse button hold
25752 * on calendar widgets' month selection.
25754 * @param obj The calendar object
25755 * @return The (first) interval value, in seconds, set on it
25757 * @see elm_calendar_interval_set() for more details
25759 * @ingroup Calendar
25761 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25768 * @defgroup Diskselector Diskselector
25769 * @ingroup Elementary
25771 * @image html img/widget/diskselector/preview-00.png
25772 * @image latex img/widget/diskselector/preview-00.eps
25774 * A diskselector is a kind of list widget. It scrolls horizontally,
25775 * and can contain label and icon objects. Three items are displayed
25776 * with the selected one in the middle.
25778 * It can act like a circular list with round mode and labels can be
25779 * reduced for a defined length for side items.
25781 * Smart callbacks one can listen to:
25782 * - "selected" - when item is selected, i.e. scroller stops.
25784 * Available styles for it:
25787 * List of examples:
25788 * @li @ref diskselector_example_01
25789 * @li @ref diskselector_example_02
25793 * @addtogroup Diskselector
25797 typedef struct _Elm_Diskselector_Item Elm_Diskselector_Item; /**< Item handle for a diskselector item. Created with elm_diskselector_item_append() and deleted with elm_diskselector_item_del(). */
25800 * Add a new diskselector widget to the given parent Elementary
25801 * (container) object.
25803 * @param parent The parent object.
25804 * @return a new diskselector widget handle or @c NULL, on errors.
25806 * This function inserts a new diskselector widget on the canvas.
25808 * @ingroup Diskselector
25810 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25813 * Enable or disable round mode.
25815 * @param obj The diskselector object.
25816 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25819 * Disabled by default. If round mode is enabled the items list will
25820 * work like a circle list, so when the user reaches the last item,
25821 * the first one will popup.
25823 * @see elm_diskselector_round_get()
25825 * @ingroup Diskselector
25827 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25830 * Get a value whether round mode is enabled or not.
25832 * @see elm_diskselector_round_set() for details.
25834 * @param obj The diskselector object.
25835 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25836 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25838 * @ingroup Diskselector
25840 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25843 * Get the side labels max length.
25845 * @deprecated use elm_diskselector_side_label_length_get() instead:
25847 * @param obj The diskselector object.
25848 * @return The max length defined for side labels, or 0 if not a valid
25851 * @ingroup Diskselector
25853 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25856 * Set the side labels max length.
25858 * @deprecated use elm_diskselector_side_label_length_set() instead:
25860 * @param obj The diskselector object.
25861 * @param len The max length defined for side labels.
25863 * @ingroup Diskselector
25865 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25868 * Get the side labels max length.
25870 * @see elm_diskselector_side_label_length_set() for details.
25872 * @param obj The diskselector object.
25873 * @return The max length defined for side labels, or 0 if not a valid
25876 * @ingroup Diskselector
25878 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25881 * Set the side labels max length.
25883 * @param obj The diskselector object.
25884 * @param len The max length defined for side labels.
25886 * Length is the number of characters of items' label that will be
25887 * visible when it's set on side positions. It will just crop
25888 * the string after defined size. E.g.:
25890 * An item with label "January" would be displayed on side position as
25891 * "Jan" if max length is set to 3, or "Janu", if this property
25894 * When it's selected, the entire label will be displayed, except for
25895 * width restrictions. In this case label will be cropped and "..."
25896 * will be concatenated.
25898 * Default side label max length is 3.
25900 * This property will be applyed over all items, included before or
25901 * later this function call.
25903 * @ingroup Diskselector
25905 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25908 * Set the number of items to be displayed.
25910 * @param obj The diskselector object.
25911 * @param num The number of items the diskselector will display.
25913 * Default value is 3, and also it's the minimun. If @p num is less
25914 * than 3, it will be set to 3.
25916 * Also, it can be set on theme, using data item @c display_item_num
25917 * on group "elm/diskselector/item/X", where X is style set.
25920 * group { name: "elm/diskselector/item/X";
25922 * item: "display_item_num" "5";
25925 * @ingroup Diskselector
25927 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25930 * Get the number of items in the diskselector object.
25932 * @param obj The diskselector object.
25934 * @ingroup Diskselector
25936 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25939 * Set bouncing behaviour when the scrolled content reaches an edge.
25941 * Tell the internal scroller object whether it should bounce or not
25942 * when it reaches the respective edges for each axis.
25944 * @param obj The diskselector object.
25945 * @param h_bounce Whether to bounce or not in the horizontal axis.
25946 * @param v_bounce Whether to bounce or not in the vertical axis.
25948 * @see elm_scroller_bounce_set()
25950 * @ingroup Diskselector
25952 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25955 * Get the bouncing behaviour of the internal scroller.
25957 * Get whether the internal scroller should bounce when the edge of each
25958 * axis is reached scrolling.
25960 * @param obj The diskselector object.
25961 * @param h_bounce Pointer where to store the bounce state of the horizontal
25963 * @param v_bounce Pointer where to store the bounce state of the vertical
25966 * @see elm_scroller_bounce_get()
25967 * @see elm_diskselector_bounce_set()
25969 * @ingroup Diskselector
25971 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25974 * Get the scrollbar policy.
25976 * @see elm_diskselector_scroller_policy_get() for details.
25978 * @param obj The diskselector object.
25979 * @param policy_h Pointer where to store horizontal scrollbar policy.
25980 * @param policy_v Pointer where to store vertical scrollbar policy.
25982 * @ingroup Diskselector
25984 EAPI void elm_diskselector_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
25987 * Set the scrollbar policy.
25989 * @param obj The diskselector object.
25990 * @param policy_h Horizontal scrollbar policy.
25991 * @param policy_v Vertical scrollbar policy.
25993 * This sets the scrollbar visibility policy for the given scroller.
25994 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
25995 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
25996 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
25997 * This applies respectively for the horizontal and vertical scrollbars.
25999 * The both are disabled by default, i.e., are set to
26000 * #ELM_SCROLLER_POLICY_OFF.
26002 * @ingroup Diskselector
26004 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
26007 * Remove all diskselector's items.
26009 * @param obj The diskselector object.
26011 * @see elm_diskselector_item_del()
26012 * @see elm_diskselector_item_append()
26014 * @ingroup Diskselector
26016 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26019 * Get a list of all the diskselector items.
26021 * @param obj The diskselector object.
26022 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
26023 * or @c NULL on failure.
26025 * @see elm_diskselector_item_append()
26026 * @see elm_diskselector_item_del()
26027 * @see elm_diskselector_clear()
26029 * @ingroup Diskselector
26031 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26034 * Appends a new item to the diskselector object.
26036 * @param obj The diskselector object.
26037 * @param label The label of the diskselector item.
26038 * @param icon The icon object to use at left side of the item. An
26039 * icon can be any Evas object, but usually it is an icon created
26040 * with elm_icon_add().
26041 * @param func The function to call when the item is selected.
26042 * @param data The data to associate with the item for related callbacks.
26044 * @return The created item or @c NULL upon failure.
26046 * A new item will be created and appended to the diskselector, i.e., will
26047 * be set as last item. Also, if there is no selected item, it will
26048 * be selected. This will always happens for the first appended item.
26050 * If no icon is set, label will be centered on item position, otherwise
26051 * the icon will be placed at left of the label, that will be shifted
26054 * Items created with this method can be deleted with
26055 * elm_diskselector_item_del().
26057 * Associated @p data can be properly freed when item is deleted if a
26058 * callback function is set with elm_diskselector_item_del_cb_set().
26060 * If a function is passed as argument, it will be called everytime this item
26061 * is selected, i.e., the user stops the diskselector with this
26062 * item on center position. If such function isn't needed, just passing
26063 * @c NULL as @p func is enough. The same should be done for @p data.
26065 * Simple example (with no function callback or data associated):
26067 * disk = elm_diskselector_add(win);
26068 * ic = elm_icon_add(win);
26069 * elm_icon_file_set(ic, "path/to/image", NULL);
26070 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26071 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
26074 * @see elm_diskselector_item_del()
26075 * @see elm_diskselector_item_del_cb_set()
26076 * @see elm_diskselector_clear()
26077 * @see elm_icon_add()
26079 * @ingroup Diskselector
26081 EAPI Elm_Diskselector_Item *elm_diskselector_item_append(Evas_Object *obj, const char *label, Evas_Object *icon, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
26085 * Delete them item from the diskselector.
26087 * @param it The item of diskselector to be deleted.
26089 * If deleting all diskselector items is required, elm_diskselector_clear()
26090 * should be used instead of getting items list and deleting each one.
26092 * @see elm_diskselector_clear()
26093 * @see elm_diskselector_item_append()
26094 * @see elm_diskselector_item_del_cb_set()
26096 * @ingroup Diskselector
26098 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26101 * Set the function called when a diskselector item is freed.
26103 * @param it The item to set the callback on
26104 * @param func The function called
26106 * If there is a @p func, then it will be called prior item's memory release.
26107 * That will be called with the following arguments:
26109 * @li item's Evas object;
26112 * This way, a data associated to a diskselector item could be properly
26115 * @ingroup Diskselector
26117 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
26120 * Get the data associated to the item.
26122 * @param it The diskselector item
26123 * @return The data associated to @p it
26125 * The return value is a pointer to data associated to @p item when it was
26126 * created, with function elm_diskselector_item_append(). If no data
26127 * was passed as argument, it will return @c NULL.
26129 * @see elm_diskselector_item_append()
26131 * @ingroup Diskselector
26133 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26136 * Set the icon associated to the item.
26138 * @param it The diskselector item
26139 * @param icon The icon object to associate with @p it
26141 * The icon object to use at left side of the item. An
26142 * icon can be any Evas object, but usually it is an icon created
26143 * with elm_icon_add().
26145 * Once the icon object is set, a previously set one will be deleted.
26146 * @warning Setting the same icon for two items will cause the icon to
26147 * dissapear from the first item.
26149 * If an icon was passed as argument on item creation, with function
26150 * elm_diskselector_item_append(), it will be already
26151 * associated to the item.
26153 * @see elm_diskselector_item_append()
26154 * @see elm_diskselector_item_icon_get()
26156 * @ingroup Diskselector
26158 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
26161 * Get the icon associated to the item.
26163 * @param it The diskselector item
26164 * @return The icon associated to @p it
26166 * The return value is a pointer to the icon associated to @p item when it was
26167 * created, with function elm_diskselector_item_append(), or later
26168 * with function elm_diskselector_item_icon_set. If no icon
26169 * was passed as argument, it will return @c NULL.
26171 * @see elm_diskselector_item_append()
26172 * @see elm_diskselector_item_icon_set()
26174 * @ingroup Diskselector
26176 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26179 * Set the label of item.
26181 * @param it The item of diskselector.
26182 * @param label The label of item.
26184 * The label to be displayed by the item.
26186 * If no icon is set, label will be centered on item position, otherwise
26187 * the icon will be placed at left of the label, that will be shifted
26190 * An item with label "January" would be displayed on side position as
26191 * "Jan" if max length is set to 3 with function
26192 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
26195 * When this @p item is selected, the entire label will be displayed,
26196 * except for width restrictions.
26197 * In this case label will be cropped and "..." will be concatenated,
26198 * but only for display purposes. It will keep the entire string, so
26199 * if diskselector is resized the remaining characters will be displayed.
26201 * If a label was passed as argument on item creation, with function
26202 * elm_diskselector_item_append(), it will be already
26203 * displayed by the item.
26205 * @see elm_diskselector_side_label_lenght_set()
26206 * @see elm_diskselector_item_label_get()
26207 * @see elm_diskselector_item_append()
26209 * @ingroup Diskselector
26211 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
26214 * Get the label of item.
26216 * @param it The item of diskselector.
26217 * @return The label of item.
26219 * The return value is a pointer to the label associated to @p item when it was
26220 * created, with function elm_diskselector_item_append(), or later
26221 * with function elm_diskselector_item_label_set. If no label
26222 * was passed as argument, it will return @c NULL.
26224 * @see elm_diskselector_item_label_set() for more details.
26225 * @see elm_diskselector_item_append()
26227 * @ingroup Diskselector
26229 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26232 * Get the selected item.
26234 * @param obj The diskselector object.
26235 * @return The selected diskselector item.
26237 * The selected item can be unselected with function
26238 * elm_diskselector_item_selected_set(), and the first item of
26239 * diskselector will be selected.
26241 * The selected item always will be centered on diskselector, with
26242 * full label displayed, i.e., max lenght set to side labels won't
26243 * apply on the selected item. More details on
26244 * elm_diskselector_side_label_length_set().
26246 * @ingroup Diskselector
26248 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26251 * Set the selected state of an item.
26253 * @param it The diskselector item
26254 * @param selected The selected state
26256 * This sets the selected state of the given item @p it.
26257 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26259 * If a new item is selected the previosly selected will be unselected.
26260 * Previoulsy selected item can be get with function
26261 * elm_diskselector_selected_item_get().
26263 * If the item @p it is unselected, the first item of diskselector will
26266 * Selected items will be visible on center position of diskselector.
26267 * So if it was on another position before selected, or was invisible,
26268 * diskselector will animate items until the selected item reaches center
26271 * @see elm_diskselector_item_selected_get()
26272 * @see elm_diskselector_selected_item_get()
26274 * @ingroup Diskselector
26276 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26279 * Get whether the @p item is selected or not.
26281 * @param it The diskselector item.
26282 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26283 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26285 * @see elm_diskselector_selected_item_set() for details.
26286 * @see elm_diskselector_item_selected_get()
26288 * @ingroup Diskselector
26290 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26293 * Get the first item of the diskselector.
26295 * @param obj The diskselector object.
26296 * @return The first item, or @c NULL if none.
26298 * The list of items follows append order. So it will return the first
26299 * item appended to the widget that wasn't deleted.
26301 * @see elm_diskselector_item_append()
26302 * @see elm_diskselector_items_get()
26304 * @ingroup Diskselector
26306 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26309 * Get the last item of the diskselector.
26311 * @param obj The diskselector object.
26312 * @return The last item, or @c NULL if none.
26314 * The list of items follows append order. So it will return last first
26315 * item appended to the widget that wasn't deleted.
26317 * @see elm_diskselector_item_append()
26318 * @see elm_diskselector_items_get()
26320 * @ingroup Diskselector
26322 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26325 * Get the item before @p item in diskselector.
26327 * @param it The diskselector item.
26328 * @return The item before @p item, or @c NULL if none or on failure.
26330 * The list of items follows append order. So it will return item appended
26331 * just before @p item and that wasn't deleted.
26333 * If it is the first item, @c NULL will be returned.
26334 * First item can be get by elm_diskselector_first_item_get().
26336 * @see elm_diskselector_item_append()
26337 * @see elm_diskselector_items_get()
26339 * @ingroup Diskselector
26341 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26344 * Get the item after @p item in diskselector.
26346 * @param it The diskselector item.
26347 * @return The item after @p item, or @c NULL if none or on failure.
26349 * The list of items follows append order. So it will return item appended
26350 * just after @p item and that wasn't deleted.
26352 * If it is the last item, @c NULL will be returned.
26353 * Last item can be get by elm_diskselector_last_item_get().
26355 * @see elm_diskselector_item_append()
26356 * @see elm_diskselector_items_get()
26358 * @ingroup Diskselector
26360 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26363 * Set the text to be shown in the diskselector item.
26365 * @param item Target item
26366 * @param text The text to set in the content
26368 * Setup the text as tooltip to object. The item can have only one tooltip,
26369 * so any previous tooltip data is removed.
26371 * @see elm_object_tooltip_text_set() for more details.
26373 * @ingroup Diskselector
26375 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26378 * Set the content to be shown in the tooltip item.
26380 * Setup the tooltip to item. The item can have only one tooltip,
26381 * so any previous tooltip data is removed. @p func(with @p data) will
26382 * be called every time that need show the tooltip and it should
26383 * return a valid Evas_Object. This object is then managed fully by
26384 * tooltip system and is deleted when the tooltip is gone.
26386 * @param item the diskselector item being attached a tooltip.
26387 * @param func the function used to create the tooltip contents.
26388 * @param data what to provide to @a func as callback data/context.
26389 * @param del_cb called when data is not needed anymore, either when
26390 * another callback replaces @p func, the tooltip is unset with
26391 * elm_diskselector_item_tooltip_unset() or the owner @a item
26392 * dies. This callback receives as the first parameter the
26393 * given @a data, and @c event_info is the item.
26395 * @see elm_object_tooltip_content_cb_set() for more details.
26397 * @ingroup Diskselector
26399 EAPI void elm_diskselector_item_tooltip_content_cb_set(Elm_Diskselector_Item *item, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb) EINA_ARG_NONNULL(1);
26402 * Unset tooltip from item.
26404 * @param item diskselector item to remove previously set tooltip.
26406 * Remove tooltip from item. The callback provided as del_cb to
26407 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26408 * it is not used anymore.
26410 * @see elm_object_tooltip_unset() for more details.
26411 * @see elm_diskselector_item_tooltip_content_cb_set()
26413 * @ingroup Diskselector
26415 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26419 * Sets a different style for this item tooltip.
26421 * @note before you set a style you should define a tooltip with
26422 * elm_diskselector_item_tooltip_content_cb_set() or
26423 * elm_diskselector_item_tooltip_text_set()
26425 * @param item diskselector item with tooltip already set.
26426 * @param style the theme style to use (default, transparent, ...)
26428 * @see elm_object_tooltip_style_set() for more details.
26430 * @ingroup Diskselector
26432 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26435 * Get the style for this item tooltip.
26437 * @param item diskselector item with tooltip already set.
26438 * @return style the theme style in use, defaults to "default". If the
26439 * object does not have a tooltip set, then NULL is returned.
26441 * @see elm_object_tooltip_style_get() for more details.
26442 * @see elm_diskselector_item_tooltip_style_set()
26444 * @ingroup Diskselector
26446 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26449 * Set the cursor to be shown when mouse is over the diskselector item
26451 * @param item Target item
26452 * @param cursor the cursor name to be used.
26454 * @see elm_object_cursor_set() for more details.
26456 * @ingroup Diskselector
26458 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26461 * Get the cursor to be shown when mouse is over the diskselector item
26463 * @param item diskselector item with cursor already set.
26464 * @return the cursor name.
26466 * @see elm_object_cursor_get() for more details.
26467 * @see elm_diskselector_cursor_set()
26469 * @ingroup Diskselector
26471 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26475 * Unset the cursor to be shown when mouse is over the diskselector item
26477 * @param item Target item
26479 * @see elm_object_cursor_unset() for more details.
26480 * @see elm_diskselector_cursor_set()
26482 * @ingroup Diskselector
26484 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26487 * Sets a different style for this item cursor.
26489 * @note before you set a style you should define a cursor with
26490 * elm_diskselector_item_cursor_set()
26492 * @param item diskselector item with cursor already set.
26493 * @param style the theme style to use (default, transparent, ...)
26495 * @see elm_object_cursor_style_set() for more details.
26497 * @ingroup Diskselector
26499 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26503 * Get the style for this item cursor.
26505 * @param item diskselector item with cursor already set.
26506 * @return style the theme style in use, defaults to "default". If the
26507 * object does not have a cursor set, then @c NULL is returned.
26509 * @see elm_object_cursor_style_get() for more details.
26510 * @see elm_diskselector_item_cursor_style_set()
26512 * @ingroup Diskselector
26514 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26518 * Set if the cursor set should be searched on the theme or should use
26519 * the provided by the engine, only.
26521 * @note before you set if should look on theme you should define a cursor
26522 * with elm_diskselector_item_cursor_set().
26523 * By default it will only look for cursors provided by the engine.
26525 * @param item widget item with cursor already set.
26526 * @param engine_only boolean to define if cursors set with
26527 * elm_diskselector_item_cursor_set() should be searched only
26528 * between cursors provided by the engine or searched on widget's
26531 * @see elm_object_cursor_engine_only_set() for more details.
26533 * @ingroup Diskselector
26535 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26538 * Get the cursor engine only usage for this item cursor.
26540 * @param item widget item with cursor already set.
26541 * @return engine_only boolean to define it cursors should be looked only
26542 * between the provided by the engine or searched on widget's theme as well.
26543 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26545 * @see elm_object_cursor_engine_only_get() for more details.
26546 * @see elm_diskselector_item_cursor_engine_only_set()
26548 * @ingroup Diskselector
26550 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26557 * @defgroup Colorselector Colorselector
26561 * @image html img/widget/colorselector/preview-00.png
26562 * @image latex img/widget/colorselector/preview-00.eps
26564 * @brief Widget for user to select a color.
26566 * Signals that you can add callbacks for are:
26567 * "changed" - When the color value changes(event_info is NULL).
26569 * See @ref tutorial_colorselector.
26572 * @brief Add a new colorselector to the parent
26574 * @param parent The parent object
26575 * @return The new object or NULL if it cannot be created
26577 * @ingroup Colorselector
26579 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26581 * Set a color for the colorselector
26583 * @param obj Colorselector object
26584 * @param r r-value of color
26585 * @param g g-value of color
26586 * @param b b-value of color
26587 * @param a a-value of color
26589 * @ingroup Colorselector
26591 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26593 * Get a color from the colorselector
26595 * @param obj Colorselector object
26596 * @param r integer pointer for r-value of color
26597 * @param g integer pointer for g-value of color
26598 * @param b integer pointer for b-value of color
26599 * @param a integer pointer for a-value of color
26601 * @ingroup Colorselector
26603 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26609 * @defgroup Ctxpopup Ctxpopup
26611 * @image html img/widget/ctxpopup/preview-00.png
26612 * @image latex img/widget/ctxpopup/preview-00.eps
26614 * @brief Context popup widet.
26616 * A ctxpopup is a widget that, when shown, pops up a list of items.
26617 * It automatically chooses an area inside its parent object's view
26618 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26619 * optimally fit into it. In the default theme, it will also point an
26620 * arrow to it's top left position at the time one shows it. Ctxpopup
26621 * items have a label and/or an icon. It is intended for a small
26622 * number of items (hence the use of list, not genlist).
26624 * @note Ctxpopup is a especialization of @ref Hover.
26626 * Signals that you can add callbacks for are:
26627 * "dismissed" - the ctxpopup was dismissed
26629 * Default contents parts of the ctxpopup widget that you can use for are:
26630 * @li "elm.swallow.content" - A content of the ctxpopup
26632 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26635 typedef enum _Elm_Ctxpopup_Direction
26637 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26639 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26640 the clicked area */
26641 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26642 the clicked area */
26643 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26645 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26646 } Elm_Ctxpopup_Direction;
26647 #define Elm_Ctxpopup_Item Elm_Object_Item
26650 * @brief Add a new Ctxpopup object to the parent.
26652 * @param parent Parent object
26653 * @return New object or @c NULL, if it cannot be created
26655 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26657 * @brief Set the Ctxpopup's parent
26659 * @param obj The ctxpopup object
26660 * @param area The parent to use
26662 * Set the parent object.
26664 * @note elm_ctxpopup_add() will automatically call this function
26665 * with its @c parent argument.
26667 * @see elm_ctxpopup_add()
26668 * @see elm_hover_parent_set()
26670 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26672 * @brief Get the Ctxpopup's parent
26674 * @param obj The ctxpopup object
26676 * @see elm_ctxpopup_hover_parent_set() for more information
26678 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26680 * @brief Clear all items in the given ctxpopup object.
26682 * @param obj Ctxpopup object
26684 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26686 * @brief Change the ctxpopup's orientation to horizontal or vertical.
26688 * @param obj Ctxpopup object
26689 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26691 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26693 * @brief Get the value of current ctxpopup object's orientation.
26695 * @param obj Ctxpopup object
26696 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26698 * @see elm_ctxpopup_horizontal_set()
26700 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26702 * @brief Add a new item to a ctxpopup object.
26704 * @param obj Ctxpopup object
26705 * @param icon Icon to be set on new item
26706 * @param label The Label of the new item
26707 * @param func Convenience function called when item selected
26708 * @param data Data passed to @p func
26709 * @return A handle to the item added or @c NULL, on errors
26711 * @warning Ctxpopup can't hold both an item list and a content at the same
26712 * time. When an item is added, any previous content will be removed.
26714 * @see elm_ctxpopup_content_set()
26716 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);
26718 * @brief Delete the given item in a ctxpopup object.
26720 * @param it Ctxpopup item to be deleted
26722 * @see elm_ctxpopup_item_append()
26724 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26726 * @brief Set the ctxpopup item's state as disabled or enabled.
26728 * @param it Ctxpopup item to be enabled/disabled
26729 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26731 * When disabled the item is greyed out to indicate it's state.
26733 EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26735 * @brief Get the ctxpopup item's disabled/enabled state.
26737 * @param it Ctxpopup item to be enabled/disabled
26738 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26740 * @see elm_ctxpopup_item_disabled_set()
26742 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26744 * @brief Get the icon object for the given ctxpopup item.
26746 * @param it Ctxpopup item
26747 * @return icon object or @c NULL, if the item does not have icon or an error
26750 * @see elm_ctxpopup_item_append()
26751 * @see elm_ctxpopup_item_icon_set()
26753 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26755 * @brief Sets the side icon associated with the ctxpopup item
26757 * @param it Ctxpopup item
26758 * @param icon Icon object to be set
26760 * Once the icon object is set, a previously set one will be deleted.
26761 * @warning Setting the same icon for two items will cause the icon to
26762 * dissapear from the first item.
26764 * @see elm_ctxpopup_item_append()
26766 EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26768 * @brief Get the label for the given ctxpopup item.
26770 * @param it Ctxpopup item
26771 * @return label string or @c NULL, if the item does not have label or an
26774 * @see elm_ctxpopup_item_append()
26775 * @see elm_ctxpopup_item_label_set()
26777 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26779 * @brief (Re)set the label on the given ctxpopup item.
26781 * @param it Ctxpopup item
26782 * @param label String to set as label
26784 EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26786 * @brief Set an elm widget as the content of the ctxpopup.
26788 * @param obj Ctxpopup object
26789 * @param content Content to be swallowed
26791 * If the content object is already set, a previous one will bedeleted. If
26792 * you want to keep that old content object, use the
26793 * elm_ctxpopup_content_unset() function.
26795 * @deprecated use elm_object_content_set()
26797 * @warning Ctxpopup can't hold both a item list and a content at the same
26798 * time. When a content is set, any previous items will be removed.
26800 EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26802 * @brief Unset the ctxpopup content
26804 * @param obj Ctxpopup object
26805 * @return The content that was being used
26807 * Unparent and return the content object which was set for this widget.
26809 * @deprecated use elm_object_content_unset()
26811 * @see elm_ctxpopup_content_set()
26813 EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26815 * @brief Set the direction priority of a ctxpopup.
26817 * @param obj Ctxpopup object
26818 * @param first 1st priority of direction
26819 * @param second 2nd priority of direction
26820 * @param third 3th priority of direction
26821 * @param fourth 4th priority of direction
26823 * This functions gives a chance to user to set the priority of ctxpopup
26824 * showing direction. This doesn't guarantee the ctxpopup will appear in the
26825 * requested direction.
26827 * @see Elm_Ctxpopup_Direction
26829 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);
26831 * @brief Get the direction priority of a ctxpopup.
26833 * @param obj Ctxpopup object
26834 * @param first 1st priority of direction to be returned
26835 * @param second 2nd priority of direction to be returned
26836 * @param third 3th priority of direction to be returned
26837 * @param fourth 4th priority of direction to be returned
26839 * @see elm_ctxpopup_direction_priority_set() for more information.
26841 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);
26844 * @brief Get the current direction of a ctxpopup.
26846 * @param obj Ctxpopup object
26847 * @return current direction of a ctxpopup
26849 * @warning Once the ctxpopup showed up, the direction would be determined
26851 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26860 * @defgroup Transit Transit
26861 * @ingroup Elementary
26863 * Transit is designed to apply various animated transition effects to @c
26864 * Evas_Object, such like translation, rotation, etc. For using these
26865 * effects, create an @ref Elm_Transit and add the desired transition effects.
26867 * Once the effects are added into transit, they will be automatically
26868 * managed (their callback will be called until the duration is ended, and
26869 * they will be deleted on completion).
26873 * Elm_Transit *trans = elm_transit_add();
26874 * elm_transit_object_add(trans, obj);
26875 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26876 * elm_transit_duration_set(transit, 1);
26877 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26878 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26879 * elm_transit_repeat_times_set(transit, 3);
26882 * Some transition effects are used to change the properties of objects. They
26884 * @li @ref elm_transit_effect_translation_add
26885 * @li @ref elm_transit_effect_color_add
26886 * @li @ref elm_transit_effect_rotation_add
26887 * @li @ref elm_transit_effect_wipe_add
26888 * @li @ref elm_transit_effect_zoom_add
26889 * @li @ref elm_transit_effect_resizing_add
26891 * Other transition effects are used to make one object disappear and another
26892 * object appear on its old place. These effects are:
26894 * @li @ref elm_transit_effect_flip_add
26895 * @li @ref elm_transit_effect_resizable_flip_add
26896 * @li @ref elm_transit_effect_fade_add
26897 * @li @ref elm_transit_effect_blend_add
26899 * It's also possible to make a transition chain with @ref
26900 * elm_transit_chain_transit_add.
26902 * @warning We strongly recommend to use elm_transit just when edje can not do
26903 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26904 * animations can be manipulated inside the theme.
26906 * List of examples:
26907 * @li @ref transit_example_01_explained
26908 * @li @ref transit_example_02_explained
26909 * @li @ref transit_example_03_c
26910 * @li @ref transit_example_04_c
26916 * @enum Elm_Transit_Tween_Mode
26918 * The type of acceleration used in the transition.
26922 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26923 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26924 over time, then decrease again
26926 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26928 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26930 } Elm_Transit_Tween_Mode;
26933 * @enum Elm_Transit_Effect_Flip_Axis
26935 * The axis where flip effect should be applied.
26939 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26940 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26941 } Elm_Transit_Effect_Flip_Axis;
26943 * @enum Elm_Transit_Effect_Wipe_Dir
26945 * The direction where the wipe effect should occur.
26949 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26950 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26951 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26952 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26953 } Elm_Transit_Effect_Wipe_Dir;
26954 /** @enum Elm_Transit_Effect_Wipe_Type
26956 * Whether the wipe effect should show or hide the object.
26960 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26962 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26964 } Elm_Transit_Effect_Wipe_Type;
26967 * @typedef Elm_Transit
26969 * The Transit created with elm_transit_add(). This type has the information
26970 * about the objects which the transition will be applied, and the
26971 * transition effects that will be used. It also contains info about
26972 * duration, number of repetitions, auto-reverse, etc.
26974 typedef struct _Elm_Transit Elm_Transit;
26975 typedef void Elm_Transit_Effect;
26977 * @typedef Elm_Transit_Effect_Transition_Cb
26979 * Transition callback called for this effect on each transition iteration.
26981 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
26983 * Elm_Transit_Effect_End_Cb
26985 * Transition callback called for this effect when the transition is over.
26987 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
26990 * Elm_Transit_Del_Cb
26992 * A callback called when the transit is deleted.
26994 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
26999 * @note Is not necessary to delete the transit object, it will be deleted at
27000 * the end of its operation.
27001 * @note The transit will start playing when the program enter in the main loop, is not
27002 * necessary to give a start to the transit.
27004 * @return The transit object.
27008 EAPI Elm_Transit *elm_transit_add(void);
27011 * Stops the animation and delete the @p transit object.
27013 * Call this function if you wants to stop the animation before the duration
27014 * time. Make sure the @p transit object is still alive with
27015 * elm_transit_del_cb_set() function.
27016 * All added effects will be deleted, calling its repective data_free_cb
27017 * functions. The function setted by elm_transit_del_cb_set() will be called.
27019 * @see elm_transit_del_cb_set()
27021 * @param transit The transit object to be deleted.
27024 * @warning Just call this function if you are sure the transit is alive.
27026 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27029 * Add a new effect to the transit.
27031 * @note The cb function and the data are the key to the effect. If you try to
27032 * add an already added effect, nothing is done.
27033 * @note After the first addition of an effect in @p transit, if its
27034 * effect list become empty again, the @p transit will be killed by
27035 * elm_transit_del(transit) function.
27039 * Elm_Transit *transit = elm_transit_add();
27040 * elm_transit_effect_add(transit,
27041 * elm_transit_effect_blend_op,
27042 * elm_transit_effect_blend_context_new(),
27043 * elm_transit_effect_blend_context_free);
27046 * @param transit The transit object.
27047 * @param transition_cb The operation function. It is called when the
27048 * animation begins, it is the function that actually performs the animation.
27049 * It is called with the @p data, @p transit and the time progression of the
27050 * animation (a double value between 0.0 and 1.0).
27051 * @param effect The context data of the effect.
27052 * @param end_cb The function to free the context data, it will be called
27053 * at the end of the effect, it must finalize the animation and free the
27057 * @warning The transit free the context data at the and of the transition with
27058 * the data_free_cb function, do not use the context data in another transit.
27060 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);
27063 * Delete an added effect.
27065 * This function will remove the effect from the @p transit, calling the
27066 * data_free_cb to free the @p data.
27068 * @see elm_transit_effect_add()
27070 * @note If the effect is not found, nothing is done.
27071 * @note If the effect list become empty, this function will call
27072 * elm_transit_del(transit), that is, it will kill the @p transit.
27074 * @param transit The transit object.
27075 * @param transition_cb The operation function.
27076 * @param effect The context data of the effect.
27080 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);
27083 * Add new object to apply the effects.
27085 * @note After the first addition of an object in @p transit, if its
27086 * object list become empty again, the @p transit will be killed by
27087 * elm_transit_del(transit) function.
27088 * @note If the @p obj belongs to another transit, the @p obj will be
27089 * removed from it and it will only belong to the @p transit. If the old
27090 * transit stays without objects, it will die.
27091 * @note When you add an object into the @p transit, its state from
27092 * evas_object_pass_events_get(obj) is saved, and it is applied when the
27093 * transit ends, if you change this state whith evas_object_pass_events_set()
27094 * after add the object, this state will change again when @p transit stops to
27097 * @param transit The transit object.
27098 * @param obj Object to be animated.
27101 * @warning It is not allowed to add a new object after transit begins to go.
27103 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27106 * Removes an added object from the transit.
27108 * @note If the @p obj is not in the @p transit, nothing is done.
27109 * @note If the list become empty, this function will call
27110 * elm_transit_del(transit), that is, it will kill the @p transit.
27112 * @param transit The transit object.
27113 * @param obj Object to be removed from @p transit.
27116 * @warning It is not allowed to remove objects after transit begins to go.
27118 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27121 * Get the objects of the transit.
27123 * @param transit The transit object.
27124 * @return a Eina_List with the objects from the transit.
27128 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27131 * Enable/disable keeping up the objects states.
27132 * If it is not kept, the objects states will be reset when transition ends.
27134 * @note @p transit can not be NULL.
27135 * @note One state includes geometry, color, map data.
27137 * @param transit The transit object.
27138 * @param state_keep Keeping or Non Keeping.
27142 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
27145 * Get a value whether the objects states will be reset or not.
27147 * @note @p transit can not be NULL
27149 * @see elm_transit_objects_final_state_keep_set()
27151 * @param transit The transit object.
27152 * @return EINA_TRUE means the states of the objects will be reset.
27153 * If @p transit is NULL, EINA_FALSE is returned
27157 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27160 * Set the event enabled when transit is operating.
27162 * If @p enabled is EINA_TRUE, the objects of the transit will receives
27163 * events from mouse and keyboard during the animation.
27164 * @note When you add an object with elm_transit_object_add(), its state from
27165 * evas_object_pass_events_get(obj) is saved, and it is applied when the
27166 * transit ends, if you change this state with evas_object_pass_events_set()
27167 * after adding the object, this state will change again when @p transit stops
27170 * @param transit The transit object.
27171 * @param enabled Events are received when enabled is @c EINA_TRUE, and
27172 * ignored otherwise.
27176 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
27179 * Get the value of event enabled status.
27181 * @see elm_transit_event_enabled_set()
27183 * @param transit The Transit object
27184 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
27185 * EINA_FALSE is returned
27189 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27192 * Set the user-callback function when the transit is deleted.
27194 * @note Using this function twice will overwrite the first function setted.
27195 * @note the @p transit object will be deleted after call @p cb function.
27197 * @param transit The transit object.
27198 * @param cb Callback function pointer. This function will be called before
27199 * the deletion of the transit.
27200 * @param data Callback funtion user data. It is the @p op parameter.
27204 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
27207 * Set reverse effect automatically.
27209 * If auto reverse is setted, after running the effects with the progress
27210 * parameter from 0 to 1, it will call the effecs again with the progress
27211 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
27212 * where the duration was setted with the function elm_transit_add and
27213 * the repeat with the function elm_transit_repeat_times_set().
27215 * @param transit The transit object.
27216 * @param reverse EINA_TRUE means the auto_reverse is on.
27220 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
27223 * Get if the auto reverse is on.
27225 * @see elm_transit_auto_reverse_set()
27227 * @param transit The transit object.
27228 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27229 * EINA_FALSE is returned
27233 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27236 * Set the transit repeat count. Effect will be repeated by repeat count.
27238 * This function sets the number of repetition the transit will run after
27239 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27240 * If the @p repeat is a negative number, it will repeat infinite times.
27242 * @note If this function is called during the transit execution, the transit
27243 * will run @p repeat times, ignoring the times it already performed.
27245 * @param transit The transit object
27246 * @param repeat Repeat count
27250 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27253 * Get the transit repeat count.
27255 * @see elm_transit_repeat_times_set()
27257 * @param transit The Transit object.
27258 * @return The repeat count. If @p transit is NULL
27263 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27266 * Set the transit animation acceleration type.
27268 * This function sets the tween mode of the transit that can be:
27269 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27270 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27271 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27272 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27274 * @param transit The transit object.
27275 * @param tween_mode The tween type.
27279 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27282 * Get the transit animation acceleration type.
27284 * @note @p transit can not be NULL
27286 * @param transit The transit object.
27287 * @return The tween type. If @p transit is NULL
27288 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27292 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27295 * Set the transit animation time
27297 * @note @p transit can not be NULL
27299 * @param transit The transit object.
27300 * @param duration The animation time.
27304 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27307 * Get the transit animation time
27309 * @note @p transit can not be NULL
27311 * @param transit The transit object.
27313 * @return The transit animation time.
27317 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27320 * Starts the transition.
27321 * Once this API is called, the transit begins to measure the time.
27323 * @note @p transit can not be NULL
27325 * @param transit The transit object.
27329 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27332 * Pause/Resume the transition.
27334 * If you call elm_transit_go again, the transit will be started from the
27335 * beginning, and will be unpaused.
27337 * @note @p transit can not be NULL
27339 * @param transit The transit object.
27340 * @param paused Whether the transition should be paused or not.
27344 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27347 * Get the value of paused status.
27349 * @see elm_transit_paused_set()
27351 * @note @p transit can not be NULL
27353 * @param transit The transit object.
27354 * @return EINA_TRUE means transition is paused. If @p transit is NULL
27355 * EINA_FALSE is returned
27359 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27362 * Get the time progression of the animation (a double value between 0.0 and 1.0).
27364 * The value returned is a fraction (current time / total time). It
27365 * represents the progression position relative to the total.
27367 * @note @p transit can not be NULL
27369 * @param transit The transit object.
27371 * @return The time progression value. If @p transit is NULL
27376 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27379 * Makes the chain relationship between two transits.
27381 * @note @p transit can not be NULL. Transit would have multiple chain transits.
27382 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27384 * @param transit The transit object.
27385 * @param chain_transit The chain transit object. This transit will be operated
27386 * after transit is done.
27388 * This function adds @p chain_transit transition to a chain after the @p
27389 * transit, and will be started as soon as @p transit ends. See @ref
27390 * transit_example_02_explained for a full example.
27394 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27397 * Cut off the chain relationship between two transits.
27399 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27400 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27402 * @param transit The transit object.
27403 * @param chain_transit The chain transit object.
27405 * This function remove the @p chain_transit transition from the @p transit.
27409 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27412 * Get the current chain transit list.
27414 * @note @p transit can not be NULL.
27416 * @param transit The transit object.
27417 * @return chain transit list.
27421 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
27424 * Add the Resizing Effect to Elm_Transit.
27426 * @note This API is one of the facades. It creates resizing effect context
27427 * and add it's required APIs to elm_transit_effect_add.
27429 * @see elm_transit_effect_add()
27431 * @param transit Transit object.
27432 * @param from_w Object width size when effect begins.
27433 * @param from_h Object height size when effect begins.
27434 * @param to_w Object width size when effect ends.
27435 * @param to_h Object height size when effect ends.
27436 * @return Resizing effect context data.
27440 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);
27443 * Add the Translation Effect to Elm_Transit.
27445 * @note This API is one of the facades. It creates translation effect context
27446 * and add it's required APIs to elm_transit_effect_add.
27448 * @see elm_transit_effect_add()
27450 * @param transit Transit object.
27451 * @param from_dx X Position variation when effect begins.
27452 * @param from_dy Y Position variation when effect begins.
27453 * @param to_dx X Position variation when effect ends.
27454 * @param to_dy Y Position variation when effect ends.
27455 * @return Translation effect context data.
27458 * @warning It is highly recommended just create a transit with this effect when
27459 * the window that the objects of the transit belongs has already been created.
27460 * This is because this effect needs the geometry information about the objects,
27461 * and if the window was not created yet, it can get a wrong information.
27463 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);
27466 * Add the Zoom Effect to Elm_Transit.
27468 * @note This API is one of the facades. It creates zoom effect context
27469 * and add it's required APIs to elm_transit_effect_add.
27471 * @see elm_transit_effect_add()
27473 * @param transit Transit object.
27474 * @param from_rate Scale rate when effect begins (1 is current rate).
27475 * @param to_rate Scale rate when effect ends.
27476 * @return Zoom effect context data.
27479 * @warning It is highly recommended just create a transit with this effect when
27480 * the window that the objects of the transit belongs has already been created.
27481 * This is because this effect needs the geometry information about the objects,
27482 * and if the window was not created yet, it can get a wrong information.
27484 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27487 * Add the Flip Effect to Elm_Transit.
27489 * @note This API is one of the facades. It creates flip effect context
27490 * and add it's required APIs to elm_transit_effect_add.
27491 * @note This effect is applied to each pair of objects in the order they are listed
27492 * in the transit list of objects. The first object in the pair will be the
27493 * "front" object and the second will be the "back" object.
27495 * @see elm_transit_effect_add()
27497 * @param transit Transit object.
27498 * @param axis Flipping Axis(X or Y).
27499 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27500 * @return Flip effect context data.
27503 * @warning It is highly recommended just create a transit with this effect when
27504 * the window that the objects of the transit belongs has already been created.
27505 * This is because this effect needs the geometry information about the objects,
27506 * and if the window was not created yet, it can get a wrong information.
27508 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27511 * Add the Resizable Flip Effect to Elm_Transit.
27513 * @note This API is one of the facades. It creates resizable flip effect context
27514 * and add it's required APIs to elm_transit_effect_add.
27515 * @note This effect is applied to each pair of objects in the order they are listed
27516 * in the transit list of objects. The first object in the pair will be the
27517 * "front" object and the second will be the "back" object.
27519 * @see elm_transit_effect_add()
27521 * @param transit Transit object.
27522 * @param axis Flipping Axis(X or Y).
27523 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27524 * @return Resizable flip effect context data.
27527 * @warning It is highly recommended just create a transit with this effect when
27528 * the window that the objects of the transit belongs has already been created.
27529 * This is because this effect needs the geometry information about the objects,
27530 * and if the window was not created yet, it can get a wrong information.
27532 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27535 * Add the Wipe Effect to Elm_Transit.
27537 * @note This API is one of the facades. It creates wipe effect context
27538 * and add it's required APIs to elm_transit_effect_add.
27540 * @see elm_transit_effect_add()
27542 * @param transit Transit object.
27543 * @param type Wipe type. Hide or show.
27544 * @param dir Wipe Direction.
27545 * @return Wipe effect context data.
27548 * @warning It is highly recommended just create a transit with this effect when
27549 * the window that the objects of the transit belongs has already been created.
27550 * This is because this effect needs the geometry information about the objects,
27551 * and if the window was not created yet, it can get a wrong information.
27553 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27556 * Add the Color Effect to Elm_Transit.
27558 * @note This API is one of the facades. It creates color effect context
27559 * and add it's required APIs to elm_transit_effect_add.
27561 * @see elm_transit_effect_add()
27563 * @param transit Transit object.
27564 * @param from_r RGB R when effect begins.
27565 * @param from_g RGB G when effect begins.
27566 * @param from_b RGB B when effect begins.
27567 * @param from_a RGB A when effect begins.
27568 * @param to_r RGB R when effect ends.
27569 * @param to_g RGB G when effect ends.
27570 * @param to_b RGB B when effect ends.
27571 * @param to_a RGB A when effect ends.
27572 * @return Color effect context data.
27576 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);
27579 * Add the Fade Effect to Elm_Transit.
27581 * @note This API is one of the facades. It creates fade effect context
27582 * and add it's required APIs to elm_transit_effect_add.
27583 * @note This effect is applied to each pair of objects in the order they are listed
27584 * in the transit list of objects. The first object in the pair will be the
27585 * "before" object and the second will be the "after" object.
27587 * @see elm_transit_effect_add()
27589 * @param transit Transit object.
27590 * @return Fade effect context data.
27593 * @warning It is highly recommended just create a transit with this effect when
27594 * the window that the objects of the transit belongs has already been created.
27595 * This is because this effect needs the color information about the objects,
27596 * and if the window was not created yet, it can get a wrong information.
27598 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27601 * Add the Blend Effect to Elm_Transit.
27603 * @note This API is one of the facades. It creates blend effect context
27604 * and add it's required APIs to elm_transit_effect_add.
27605 * @note This effect is applied to each pair of objects in the order they are listed
27606 * in the transit list of objects. The first object in the pair will be the
27607 * "before" object and the second will be the "after" object.
27609 * @see elm_transit_effect_add()
27611 * @param transit Transit object.
27612 * @return Blend effect context data.
27615 * @warning It is highly recommended just create a transit with this effect when
27616 * the window that the objects of the transit belongs has already been created.
27617 * This is because this effect needs the color information about the objects,
27618 * and if the window was not created yet, it can get a wrong information.
27620 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27623 * Add the Rotation Effect to Elm_Transit.
27625 * @note This API is one of the facades. It creates rotation effect context
27626 * and add it's required APIs to elm_transit_effect_add.
27628 * @see elm_transit_effect_add()
27630 * @param transit Transit object.
27631 * @param from_degree Degree when effect begins.
27632 * @param to_degree Degree when effect is ends.
27633 * @return Rotation effect context data.
27636 * @warning It is highly recommended just create a transit with this effect when
27637 * the window that the objects of the transit belongs has already been created.
27638 * This is because this effect needs the geometry information about the objects,
27639 * and if the window was not created yet, it can get a wrong information.
27641 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27644 * Add the ImageAnimation Effect to Elm_Transit.
27646 * @note This API is one of the facades. It creates image animation effect context
27647 * and add it's required APIs to elm_transit_effect_add.
27648 * The @p images parameter is a list images paths. This list and
27649 * its contents will be deleted at the end of the effect by
27650 * elm_transit_effect_image_animation_context_free() function.
27654 * char buf[PATH_MAX];
27655 * Eina_List *images = NULL;
27656 * Elm_Transit *transi = elm_transit_add();
27658 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27659 * images = eina_list_append(images, eina_stringshare_add(buf));
27661 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27662 * images = eina_list_append(images, eina_stringshare_add(buf));
27663 * elm_transit_effect_image_animation_add(transi, images);
27667 * @see elm_transit_effect_add()
27669 * @param transit Transit object.
27670 * @param images Eina_List of images file paths. This list and
27671 * its contents will be deleted at the end of the effect by
27672 * elm_transit_effect_image_animation_context_free() function.
27673 * @return Image Animation effect context data.
27677 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27683 typedef struct _Elm_Store Elm_Store;
27684 typedef struct _Elm_Store_DBsystem Elm_Store_DBsystem;
27685 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
27686 typedef struct _Elm_Store_Item Elm_Store_Item;
27687 typedef struct _Elm_Store_Item_DBsystem Elm_Store_Item_DBsystem;
27688 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
27689 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
27690 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27691 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
27692 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
27693 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
27694 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
27695 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
27697 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27698 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27699 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27700 typedef void (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
27701 typedef int (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
27702 typedef void (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
27703 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27707 ELM_STORE_ITEM_MAPPING_NONE = 0,
27708 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27709 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27710 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27711 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27712 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27713 // can add more here as needed by common apps
27714 ELM_STORE_ITEM_MAPPING_LAST
27715 } Elm_Store_Item_Mapping_Type;
27717 struct _Elm_Store_Item_Mapping_Icon
27719 // FIXME: allow edje file icons
27721 Elm_Icon_Lookup_Order lookup_order;
27722 Eina_Bool standard_name : 1;
27723 Eina_Bool no_scale : 1;
27724 Eina_Bool smooth : 1;
27725 Eina_Bool scale_up : 1;
27726 Eina_Bool scale_down : 1;
27729 struct _Elm_Store_Item_Mapping_Empty
27734 struct _Elm_Store_Item_Mapping_Photo
27739 struct _Elm_Store_Item_Mapping_Custom
27741 Elm_Store_Item_Mapping_Cb func;
27744 struct _Elm_Store_Item_Mapping
27746 Elm_Store_Item_Mapping_Type type;
27751 Elm_Store_Item_Mapping_Empty empty;
27752 Elm_Store_Item_Mapping_Icon icon;
27753 Elm_Store_Item_Mapping_Photo photo;
27754 Elm_Store_Item_Mapping_Custom custom;
27755 // add more types here
27759 struct _Elm_Store_Item_Info
27764 Eina_Bool rec_item;
27765 int pre_group_index;
27767 Elm_Genlist_Item_Class *item_class;
27768 const Elm_Store_Item_Mapping *mapping;
27773 struct _Elm_Store_Item_Info_Filesystem
27775 Elm_Store_Item_Info base;
27779 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27780 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27782 EAPI Elm_Store *elm_store_dbsystem_new(void);
27783 EAPI void elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
27784 EAPI void elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
27785 EAPI void elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
27786 EAPI void elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
27787 EAPI int elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27788 EAPI void *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27789 EAPI void elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
27790 EAPI int elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27791 EAPI Elm_Store_Item *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
27792 EAPI void elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27793 EAPI void elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
27794 EAPI void elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27795 EAPI void elm_store_free(Elm_Store *st);
27796 EAPI Elm_Store *elm_store_filesystem_new(void);
27797 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27798 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27799 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27801 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27803 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27804 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27805 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27806 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27807 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27808 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27810 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27811 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27812 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27813 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27814 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27815 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27816 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27819 * @defgroup SegmentControl SegmentControl
27820 * @ingroup Elementary
27822 * @image html img/widget/segment_control/preview-00.png
27823 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27825 * @image html img/segment_control.png
27826 * @image latex img/segment_control.eps width=\textwidth
27828 * Segment control widget is a horizontal control made of multiple segment
27829 * items, each segment item functioning similar to discrete two state button.
27830 * A segment control groups the items together and provides compact
27831 * single button with multiple equal size segments.
27833 * Segment item size is determined by base widget
27834 * size and the number of items added.
27835 * Only one segment item can be at selected state. A segment item can display
27836 * combination of Text and any Evas_Object like Images or other widget.
27838 * Smart callbacks one can listen to:
27839 * - "changed" - When the user clicks on a segment item which is not
27840 * previously selected and get selected. The event_info parameter is the
27841 * segment item pointer.
27843 * Available styles for it:
27846 * Here is an example on its usage:
27847 * @li @ref segment_control_example
27851 * @addtogroup SegmentControl
27855 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27858 * Add a new segment control widget to the given parent Elementary
27859 * (container) object.
27861 * @param parent The parent object.
27862 * @return a new segment control widget handle or @c NULL, on errors.
27864 * This function inserts a new segment control widget on the canvas.
27866 * @ingroup SegmentControl
27868 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27871 * Append a new item to the segment control object.
27873 * @param obj The segment control object.
27874 * @param icon The icon object to use for the left side of the item. An
27875 * icon can be any Evas object, but usually it is an icon created
27876 * with elm_icon_add().
27877 * @param label The label of the item.
27878 * Note that, NULL is different from empty string "".
27879 * @return The created item or @c NULL upon failure.
27881 * A new item will be created and appended to the segment control, i.e., will
27882 * be set as @b last item.
27884 * If it should be inserted at another position,
27885 * elm_segment_control_item_insert_at() should be used instead.
27887 * Items created with this function can be deleted with function
27888 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27890 * @note @p label set to @c NULL is different from empty string "".
27892 * only has icon, it will be displayed bigger and centered. If it has
27893 * icon and label, even that an empty string, icon will be smaller and
27894 * positioned at left.
27898 * sc = elm_segment_control_add(win);
27899 * ic = elm_icon_add(win);
27900 * elm_icon_file_set(ic, "path/to/image", NULL);
27901 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27902 * elm_segment_control_item_add(sc, ic, "label");
27903 * evas_object_show(sc);
27906 * @see elm_segment_control_item_insert_at()
27907 * @see elm_segment_control_item_del()
27909 * @ingroup SegmentControl
27911 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27914 * Insert a new item to the segment control object at specified position.
27916 * @param obj The segment control object.
27917 * @param icon The icon object to use for the left side of the item. An
27918 * icon can be any Evas object, but usually it is an icon created
27919 * with elm_icon_add().
27920 * @param label The label of the item.
27921 * @param index Item position. Value should be between 0 and items count.
27922 * @return The created item or @c NULL upon failure.
27924 * Index values must be between @c 0, when item will be prepended to
27925 * segment control, and items count, that can be get with
27926 * elm_segment_control_item_count_get(), case when item will be appended
27927 * to segment control, just like elm_segment_control_item_add().
27929 * Items created with this function can be deleted with function
27930 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27932 * @note @p label set to @c NULL is different from empty string "".
27934 * only has icon, it will be displayed bigger and centered. If it has
27935 * icon and label, even that an empty string, icon will be smaller and
27936 * positioned at left.
27938 * @see elm_segment_control_item_add()
27939 * @see elm_segment_control_item_count_get()
27940 * @see elm_segment_control_item_del()
27942 * @ingroup SegmentControl
27944 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);
27947 * Remove a segment control item from its parent, deleting it.
27949 * @param it The item to be removed.
27951 * Items can be added with elm_segment_control_item_add() or
27952 * elm_segment_control_item_insert_at().
27954 * @ingroup SegmentControl
27956 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27959 * Remove a segment control item at given index from its parent,
27962 * @param obj The segment control object.
27963 * @param index The position of the segment control item to be deleted.
27965 * Items can be added with elm_segment_control_item_add() or
27966 * elm_segment_control_item_insert_at().
27968 * @ingroup SegmentControl
27970 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27973 * Get the Segment items count from segment control.
27975 * @param obj The segment control object.
27976 * @return Segment items count.
27978 * It will just return the number of items added to segment control @p obj.
27980 * @ingroup SegmentControl
27982 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27985 * Get the item placed at specified index.
27987 * @param obj The segment control object.
27988 * @param index The index of the segment item.
27989 * @return The segment control item or @c NULL on failure.
27991 * Index is the position of an item in segment control widget. Its
27992 * range is from @c 0 to <tt> count - 1 </tt>.
27993 * Count is the number of items, that can be get with
27994 * elm_segment_control_item_count_get().
27996 * @ingroup SegmentControl
27998 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28001 * Get the label of item.
28003 * @param obj The segment control object.
28004 * @param index The index of the segment item.
28005 * @return The label of the item at @p index.
28007 * The return value is a pointer to the label associated to the item when
28008 * it was created, with function elm_segment_control_item_add(), or later
28009 * with function elm_segment_control_item_label_set. If no label
28010 * was passed as argument, it will return @c NULL.
28012 * @see elm_segment_control_item_label_set() for more details.
28013 * @see elm_segment_control_item_add()
28015 * @ingroup SegmentControl
28017 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28020 * Set the label of item.
28022 * @param it The item of segment control.
28023 * @param text The label of item.
28025 * The label to be displayed by the item.
28026 * Label will be at right of the icon (if set).
28028 * If a label was passed as argument on item creation, with function
28029 * elm_control_segment_item_add(), it will be already
28030 * displayed by the item.
28032 * @see elm_segment_control_item_label_get()
28033 * @see elm_segment_control_item_add()
28035 * @ingroup SegmentControl
28037 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
28040 * Get the icon associated to the item.
28042 * @param obj The segment control object.
28043 * @param index The index of the segment item.
28044 * @return The left side icon associated to the item at @p index.
28046 * The return value is a pointer to the icon associated to the item when
28047 * it was created, with function elm_segment_control_item_add(), or later
28048 * with function elm_segment_control_item_icon_set(). If no icon
28049 * was passed as argument, it will return @c NULL.
28051 * @see elm_segment_control_item_add()
28052 * @see elm_segment_control_item_icon_set()
28054 * @ingroup SegmentControl
28056 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28059 * Set the icon associated to the item.
28061 * @param it The segment control item.
28062 * @param icon The icon object to associate with @p it.
28064 * The icon object to use at left side of the item. An
28065 * icon can be any Evas object, but usually it is an icon created
28066 * with elm_icon_add().
28068 * Once the icon object is set, a previously set one will be deleted.
28069 * @warning Setting the same icon for two items will cause the icon to
28070 * dissapear from the first item.
28072 * If an icon was passed as argument on item creation, with function
28073 * elm_segment_control_item_add(), it will be already
28074 * associated to the item.
28076 * @see elm_segment_control_item_add()
28077 * @see elm_segment_control_item_icon_get()
28079 * @ingroup SegmentControl
28081 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
28084 * Get the index of an item.
28086 * @param it The segment control item.
28087 * @return The position of item in segment control widget.
28089 * Index is the position of an item in segment control widget. Its
28090 * range is from @c 0 to <tt> count - 1 </tt>.
28091 * Count is the number of items, that can be get with
28092 * elm_segment_control_item_count_get().
28094 * @ingroup SegmentControl
28096 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28099 * Get the base object of the item.
28101 * @param it The segment control item.
28102 * @return The base object associated with @p it.
28104 * Base object is the @c Evas_Object that represents that item.
28106 * @ingroup SegmentControl
28108 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28111 * Get the selected item.
28113 * @param obj The segment control object.
28114 * @return The selected item or @c NULL if none of segment items is
28117 * The selected item can be unselected with function
28118 * elm_segment_control_item_selected_set().
28120 * The selected item always will be highlighted on segment control.
28122 * @ingroup SegmentControl
28124 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28127 * Set the selected state of an item.
28129 * @param it The segment control item
28130 * @param select The selected state
28132 * This sets the selected state of the given item @p it.
28133 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
28135 * If a new item is selected the previosly selected will be unselected.
28136 * Previoulsy selected item can be get with function
28137 * elm_segment_control_item_selected_get().
28139 * The selected item always will be highlighted on segment control.
28141 * @see elm_segment_control_item_selected_get()
28143 * @ingroup SegmentControl
28145 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
28152 * @defgroup Grid Grid
28154 * The grid is a grid layout widget that lays out a series of children as a
28155 * fixed "grid" of widgets using a given percentage of the grid width and
28156 * height each using the child object.
28158 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
28159 * widgets size itself. The default is 100 x 100, so that means the
28160 * position and sizes of children will effectively be percentages (0 to 100)
28161 * of the width or height of the grid widget
28167 * Add a new grid to the parent
28169 * @param parent The parent object
28170 * @return The new object or NULL if it cannot be created
28174 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
28177 * Set the virtual size of the grid
28179 * @param obj The grid object
28180 * @param w The virtual width of the grid
28181 * @param h The virtual height of the grid
28185 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
28188 * Get the virtual size of the grid
28190 * @param obj The grid object
28191 * @param w Pointer to integer to store the virtual width of the grid
28192 * @param h Pointer to integer to store the virtual height of the grid
28196 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
28199 * Pack child at given position and size
28201 * @param obj The grid object
28202 * @param subobj The child to pack
28203 * @param x The virtual x coord at which to pack it
28204 * @param y The virtual y coord at which to pack it
28205 * @param w The virtual width at which to pack it
28206 * @param h The virtual height at which to pack it
28210 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
28213 * Unpack a child from a grid object
28215 * @param obj The grid object
28216 * @param subobj The child to unpack
28220 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
28223 * Faster way to remove all child objects from a grid object.
28225 * @param obj The grid object
28226 * @param clear If true, it will delete just removed children
28230 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28233 * Set packing of an existing child at to position and size
28235 * @param subobj The child to set packing of
28236 * @param x The virtual x coord at which to pack it
28237 * @param y The virtual y coord at which to pack it
28238 * @param w The virtual width at which to pack it
28239 * @param h The virtual height at which to pack it
28243 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28246 * get packing of a child
28248 * @param subobj The child to query
28249 * @param x Pointer to integer to store the virtual x coord
28250 * @param y Pointer to integer to store the virtual y coord
28251 * @param w Pointer to integer to store the virtual width
28252 * @param h Pointer to integer to store the virtual height
28256 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28262 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28263 EINA_DEPRECATED EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28264 EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28265 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28266 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
28267 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
28271 * @defgroup Video Video
28273 * @addtogroup Video
28276 * Elementary comes with two object that help design application that need
28277 * to display video. The main one, Elm_Video, display a video by using Emotion.
28278 * It does embedded the video inside an Edje object, so you can do some
28279 * animation depending on the video state change. It does also implement a
28280 * ressource management policy to remove this burden from the application writer.
28282 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28283 * It take care of updating its content according to Emotion event and provide a
28284 * way to theme itself. It also does automatically raise the priority of the
28285 * linked Elm_Video so it will use the video decoder if available. It also does
28286 * activate the remember function on the linked Elm_Video object.
28288 * Signals that you can add callback for are :
28290 * "forward,clicked" - the user clicked the forward button.
28291 * "info,clicked" - the user clicked the info button.
28292 * "next,clicked" - the user clicked the next button.
28293 * "pause,clicked" - the user clicked the pause button.
28294 * "play,clicked" - the user clicked the play button.
28295 * "prev,clicked" - the user clicked the prev button.
28296 * "rewind,clicked" - the user clicked the rewind button.
28297 * "stop,clicked" - the user clicked the stop button.
28299 * To set the video of the player, you can use elm_object_content_set() API.
28304 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28306 * @param parent The parent object
28307 * @return a new player widget handle or @c NULL, on errors.
28309 * This function inserts a new player widget on the canvas.
28311 * @see elm_object_content_set()
28315 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28318 * @brief Link a Elm_Payer with an Elm_Video object.
28320 * @param player the Elm_Player object.
28321 * @param video The Elm_Video object.
28323 * This mean that action on the player widget will affect the
28324 * video object and the state of the video will be reflected in
28325 * the player itself.
28327 * @see elm_player_add()
28328 * @see elm_video_add()
28332 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28335 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28337 * @param parent The parent object
28338 * @return a new video widget handle or @c NULL, on errors.
28340 * This function inserts a new video widget on the canvas.
28342 * @seeelm_video_file_set()
28343 * @see elm_video_uri_set()
28347 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28350 * @brief Define the file that will be the video source.
28352 * @param video The video object to define the file for.
28353 * @param filename The file to target.
28355 * This function will explicitly define a filename as a source
28356 * for the video of the Elm_Video object.
28358 * @see elm_video_uri_set()
28359 * @see elm_video_add()
28360 * @see elm_player_add()
28364 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28367 * @brief Define the uri that will be the video source.
28369 * @param video The video object to define the file for.
28370 * @param uri The uri to target.
28372 * This function will define an uri as a source for the video of the
28373 * Elm_Video object. URI could be remote source of video, like http:// or local source
28374 * like for example WebCam who are most of the time v4l2:// (but that depend and
28375 * you should use Emotion API to request and list the available Webcam on your system).
28377 * @see elm_video_file_set()
28378 * @see elm_video_add()
28379 * @see elm_player_add()
28383 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28386 * @brief Get the underlying Emotion object.
28388 * @param video The video object to proceed the request on.
28389 * @return the underlying Emotion object.
28393 EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28396 * @brief Start to play the video
28398 * @param video The video object to proceed the request on.
28400 * Start to play the video and cancel all suspend state.
28404 EAPI void elm_video_play(Evas_Object *video);
28407 * @brief Pause the video
28409 * @param video The video object to proceed the request on.
28411 * Pause the video and start a timer to trigger suspend mode.
28415 EAPI void elm_video_pause(Evas_Object *video);
28418 * @brief Stop the video
28420 * @param video The video object to proceed the request on.
28422 * Stop the video and put the emotion in deep sleep mode.
28426 EAPI void elm_video_stop(Evas_Object *video);
28429 * @brief Is the video actually playing.
28431 * @param video The video object to proceed the request on.
28432 * @return EINA_TRUE if the video is actually playing.
28434 * You should consider watching event on the object instead of polling
28435 * the object state.
28439 EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28442 * @brief Is it possible to seek inside the video.
28444 * @param video The video object to proceed the request on.
28445 * @return EINA_TRUE if is possible to seek inside the video.
28449 EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28452 * @brief Is the audio muted.
28454 * @param video The video object to proceed the request on.
28455 * @return EINA_TRUE if the audio is muted.
28459 EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28462 * @brief Change the mute state of the Elm_Video object.
28464 * @param video The video object to proceed the request on.
28465 * @param mute The new mute state.
28469 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28472 * @brief Get the audio level of the current video.
28474 * @param video The video object to proceed the request on.
28475 * @return the current audio level.
28479 EAPI double elm_video_audio_level_get(const Evas_Object *video);
28482 * @brief Set the audio level of anElm_Video object.
28484 * @param video The video object to proceed the request on.
28485 * @param volume The new audio volume.
28489 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28491 EAPI double elm_video_play_position_get(const Evas_Object *video);
28492 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28493 EAPI double elm_video_play_length_get(const Evas_Object *video);
28494 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28495 EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28496 EAPI const char *elm_video_title_get(const Evas_Object *video);
28501 // FIXME: incomplete - carousel. don't use this until this comment is removed
28502 typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
28503 EAPI Evas_Object *elm_carousel_add(Evas_Object *parent);
28504 EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
28505 EAPI void elm_carousel_item_del(Elm_Carousel_Item *item);
28506 EAPI void elm_carousel_item_select(Elm_Carousel_Item *item);
28507 /* smart callbacks called:
28508 * "clicked" - when the user clicks on a carousel item and becomes selected
28513 typedef enum _Elm_Datefield_ItemType
28515 ELM_DATEFIELD_YEAR = 0,
28516 ELM_DATEFIELD_MONTH,
28517 ELM_DATEFIELD_DATE,
28518 ELM_DATEFIELD_HOUR,
28519 ELM_DATEFIELD_MINUTE,
28521 } Elm_Datefield_ItemType;
28523 EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
28524 EAPI void elm_datefield_format_set(Evas_Object *obj, const char *fmt);
28525 EAPI char *elm_datefield_format_get(const Evas_Object *obj);
28526 EAPI void elm_datefield_item_enabled_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, Eina_Bool enable);
28527 EAPI Eina_Bool elm_datefield_item_enabled_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28528 EAPI void elm_datefield_item_value_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value);
28529 EAPI int elm_datefield_item_value_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28530 EAPI void elm_datefield_item_min_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28531 EAPI int elm_datefield_item_min_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28532 EAPI Eina_Bool elm_datefield_item_min_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28533 EAPI void elm_datefield_item_max_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28534 EAPI int elm_datefield_item_max_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28535 EAPI Eina_Bool elm_datefield_item_max_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28537 /* smart callbacks called:
28538 * "changed" - when datefield value is changed, this signal is sent.
28541 ////////////////////// DEPRECATED ///////////////////////////////////
28543 typedef enum _Elm_Datefield_Layout
28545 ELM_DATEFIELD_LAYOUT_TIME,
28546 ELM_DATEFIELD_LAYOUT_DATE,
28547 ELM_DATEFIELD_LAYOUT_DATEANDTIME
28548 } Elm_Datefield_Layout;
28550 EINA_DEPRECATED EAPI void elm_datefield_layout_set(Evas_Object *obj, Elm_Datefield_Layout layout);
28551 EINA_DEPRECATED EAPI Elm_Datefield_Layout elm_datefield_layout_get(const Evas_Object *obj);
28552 EINA_DEPRECATED EAPI void elm_datefield_date_format_set(Evas_Object *obj, const char *fmt);
28553 EINA_DEPRECATED EAPI const char *elm_datefield_date_format_get(const Evas_Object *obj);
28554 EINA_DEPRECATED EAPI void elm_datefield_time_mode_set(Evas_Object *obj, Eina_Bool mode);
28555 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_time_mode_get(const Evas_Object *obj);
28556 EINA_DEPRECATED EAPI void elm_datefield_date_set(Evas_Object *obj, int year, int month, int day, int hour, int min);
28557 EINA_DEPRECATED EAPI void elm_datefield_date_get(const Evas_Object *obj, int *year, int *month, int *day, int *hour, int *min);
28558 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_max_set(Evas_Object *obj, int year, int month, int day);
28559 EINA_DEPRECATED EAPI void elm_datefield_date_max_get(const Evas_Object *obj, int *year, int *month, int *day);
28560 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_min_set(Evas_Object *obj, int year, int month, int day);
28561 EINA_DEPRECATED EAPI void elm_datefield_date_min_get(const Evas_Object *obj, int *year, int *month, int *day);
28562 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);
28563 EINA_DEPRECATED EAPI void elm_datefield_input_panel_state_callback_del(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value));
28564 /////////////////////////////////////////////////////////////////////
28567 typedef enum _Elm_Popup_Response
28569 ELM_POPUP_RESPONSE_NONE = -1,
28570 ELM_POPUP_RESPONSE_TIMEOUT = -2,
28571 ELM_POPUP_RESPONSE_OK = -3,
28572 ELM_POPUP_RESPONSE_CANCEL = -4,
28573 ELM_POPUP_RESPONSE_CLOSE = -5
28574 } Elm_Popup_Response;
28576 typedef enum _Elm_Popup_Mode
28578 ELM_POPUP_TYPE_NONE = 0,
28579 ELM_POPUP_TYPE_ALERT = (1 << 0)
28582 typedef enum _Elm_Popup_Orient
28584 ELM_POPUP_ORIENT_TOP,
28585 ELM_POPUP_ORIENT_CENTER,
28586 ELM_POPUP_ORIENT_BOTTOM,
28587 ELM_POPUP_ORIENT_LEFT,
28588 ELM_POPUP_ORIENT_RIGHT,
28589 ELM_POPUP_ORIENT_TOP_LEFT,
28590 ELM_POPUP_ORIENT_TOP_RIGHT,
28591 ELM_POPUP_ORIENT_BOTTOM_LEFT,
28592 ELM_POPUP_ORIENT_BOTTOM_RIGHT
28593 } Elm_Popup_Orient;
28595 /* smart callbacks called:
28596 * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
28599 EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
28600 EAPI void elm_popup_desc_set(Evas_Object *obj, const char *text);
28601 EAPI const char *elm_popup_desc_get(Evas_Object *obj);
28602 EAPI void elm_popup_title_label_set(Evas_Object *obj, const char *text);
28603 EAPI const char *elm_popup_title_label_get(Evas_Object *obj);
28604 EAPI void elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
28605 EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
28606 EAPI void elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
28607 EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
28608 EAPI void elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text, ...);
28609 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, ... );
28610 EAPI void elm_popup_timeout_set(Evas_Object *obj, double timeout);
28611 EAPI void elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
28612 EAPI void elm_popup_response(Evas_Object *obj, int response_id);
28613 EAPI void elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
28614 EAPI int elm_popup_run(Evas_Object *obj);
28616 /* NavigationBar */
28617 #define NAVIBAR_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28618 #define NAVIBAR_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28622 ELM_NAVIGATIONBAR_FUNCTION_BUTTON1,
28623 ELM_NAVIGATIONBAR_FUNCTION_BUTTON2,
28624 ELM_NAVIGATIONBAR_FUNCTION_BUTTON3,
28625 ELM_NAVIGATIONBAR_BACK_BUTTON
28626 } Elm_Navi_Button_Type;
28628 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_add(Evas_Object *parent);
28629 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);
28630 EINA_DEPRECATED EAPI void elm_navigationbar_pop(Evas_Object *obj);
28631 EINA_DEPRECATED EAPI void elm_navigationbar_to_content_pop(Evas_Object *obj, Evas_Object *content);
28632 EINA_DEPRECATED EAPI void elm_navigationbar_title_label_set(Evas_Object *obj, Evas_Object *content, const char *title);
28633 EINA_DEPRECATED EAPI const char *elm_navigationbar_title_label_get(Evas_Object *obj, Evas_Object *content);
28634 EINA_DEPRECATED EAPI void elm_navigationbar_title_object_add(Evas_Object *obj, Evas_Object *content, Evas_Object *title_obj);
28635 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_title_object_get(Evas_Object *obj, Evas_Object *content);
28636 EINA_DEPRECATED EAPI Eina_List *elm_navigationbar_title_object_list_get(Evas_Object *obj, Evas_Object *content);
28637 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_content_top_get(Evas_Object *obj);
28638 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_content_bottom_get(Evas_Object *obj);
28639 EINA_DEPRECATED EAPI void elm_navigationbar_hidden_set(Evas_Object *obj, Eina_Bool hidden);
28640 EINA_DEPRECATED EAPI void elm_navigationbar_title_button_set(Evas_Object *obj, Evas_Object *content, Evas_Object *button, Elm_Navi_Button_Type button_type);
28641 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_title_button_get(Evas_Object *obj, Evas_Object *content, Elm_Navi_Button_Type button_type);
28642 EINA_DEPRECATED EAPI const char *elm_navigationbar_subtitle_label_get(Evas_Object *obj, Evas_Object *content);
28643 EINA_DEPRECATED EAPI void elm_navigationbar_subtitle_label_set(Evas_Object *obj, Evas_Object *content, const char *subtitle);
28644 EINA_DEPRECATED EAPI void elm_navigationbar_title_object_list_unset(Evas_Object *obj, Evas_Object *content, Eina_List **list);
28645 EINA_DEPRECATED EAPI void elm_navigationbar_animation_disabled_set(Evas_Object *obj, Eina_Bool disable);
28646 EINA_DEPRECATED EAPI void elm_navigationbar_title_object_visible_set(Evas_Object *obj, Evas_Object *content, Eina_Bool visible);
28647 EINA_DEPRECATED Eina_Bool elm_navigationbar_title_object_visible_get(Evas_Object *obj, Evas_Object *content);
28648 EINA_DEPRECATED EAPI void elm_navigationbar_title_icon_set(Evas_Object *obj, Evas_Object *content, Evas_Object *icon);
28649 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_title_icon_get(Evas_Object *obj, Evas_Object *content);
28651 /* NavigationBar */
28652 #define NAVIBAR_EX_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28653 #define NAVIBAR_EX_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28657 ELM_NAVIGATIONBAR_EX_BACK_BUTTON,
28658 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON1,
28659 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON2,
28660 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON3,
28661 ELM_NAVIGATIONBAR_EX_MAX
28662 } Elm_Navi_ex_Button_Type;
28663 typedef struct _Elm_Navigationbar_ex_Item Elm_Navigationbar_ex_Item;
28665 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_add(Evas_Object *parent);
28666 EINA_DEPRECATED EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_push(Evas_Object *obj, Evas_Object *content, const char *item_style);
28667 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_pop(Evas_Object *obj);
28668 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_promote(Elm_Navigationbar_ex_Item* item);
28669 EINA_DEPRECATED EAPI void elm_navigationbar_ex_to_item_pop(Elm_Navigationbar_ex_Item* item);
28670 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_title_label_set(Elm_Navigationbar_ex_Item *item, const char *title);
28671 EINA_DEPRECATED EAPI const char *elm_navigationbar_ex_item_title_label_get(Elm_Navigationbar_ex_Item* item);
28672 EINA_DEPRECATED EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_top_get(const Evas_Object *obj);
28673 EINA_DEPRECATED EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_bottom_get(const Evas_Object *obj);
28674 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);
28675 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_title_button_get(Elm_Navigationbar_ex_Item* item, int button_type);
28676 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_title_object_set(Elm_Navigationbar_ex_Item* item, Evas_Object *title_obj);
28677 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_title_object_unset(Elm_Navigationbar_ex_Item* item);
28678 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_title_hidden_set(Elm_Navigationbar_ex_Item* item, Eina_Bool hidden);
28679 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_title_object_get(Elm_Navigationbar_ex_Item* item);
28680 EINA_DEPRECATED EAPI const char *elm_navigationbar_ex_item_subtitle_label_get(Elm_Navigationbar_ex_Item* item);
28681 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_subtitle_label_set( Elm_Navigationbar_ex_Item* item, const char *subtitle);
28682 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_style_set(Elm_Navigationbar_ex_Item* item, const char* item_style);
28683 EINA_DEPRECATED EAPI const char *elm_navigationbar_ex_item_style_get(Elm_Navigationbar_ex_Item* item);
28684 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_content_unset(Elm_Navigationbar_ex_Item* item);
28685 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_content_get(Elm_Navigationbar_ex_Item* item);
28686 EINA_DEPRECATED EAPI void elm_navigationbar_ex_delete_on_pop_set(Evas_Object *obj, Eina_Bool del_on_pop);
28687 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_icon_get(Elm_Navigationbar_ex_Item* item);
28688 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_icon_set(Elm_Navigationbar_ex_Item* item, Evas_Object *icon);
28689 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_title_button_unset(Elm_Navigationbar_ex_Item* item, int button_type);
28690 EINA_DEPRECATED EAPI void elm_navigationbar_ex_animation_disable_set(Evas_Object *obj, Eina_Bool disable);
28691 EINA_DEPRECATED EAPI void elm_navigationbar_ex_title_object_visible_set(Elm_Navigationbar_ex_Item* item, Eina_Bool visible);
28692 EINA_DEPRECATED Eina_Bool elm_navigationbar_ex_title_object_visible_get(Elm_Navigationbar_ex_Item* item);
28695 * @defgroup Naviframe Naviframe
28696 * @ingroup Elementary
28698 * @brief Naviframe is a kind of view manager for the applications.
28700 * Naviframe provides functions to switch different pages with stack
28701 * mechanism. It means if one page(item) needs to be changed to the new one,
28702 * then naviframe would push the new page to it's internal stack. Of course,
28703 * it can be back to the previous page by popping the top page. Naviframe
28704 * provides some transition effect while the pages are switching (same as
28707 * Since each item could keep the different styles, users could keep the
28708 * same look & feel for the pages or different styles for the items in it's
28711 * Signals that you can add callback for are:
28712 * @li "transition,finished" - When the transition is finished in changing
28714 * @li "title,clicked" - User clicked title area
28716 * Default contents parts of the naviframe items that you can use for are:
28717 * @li "elm.swallow.content" - A main content of the page
28718 * @li "elm.swallow.icon" - A icon in the title area
28719 * @li "elm.swallow.prev_btn" - A button to go to the previous page
28720 * @li "elm.swallow.next_btn" - A button to go to the next page
28722 * Default text parts of the naviframe items that you can use for are:
28723 * @li "elm.text.title" - Title label in the title area
28724 * @li "elm.text.subtitle" - Sub-title label in the title area
28726 * @ref tutorial_naviframe gives a good overview of the usage of the API.
28729 //Available commonly
28730 #define ELM_NAVIFRAME_ITEM_CONTENT "elm.swallow.content"
28731 #define ELM_NAVIFRAME_ITEM_ICON "elm.swallow.icon"
28732 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER "elm.swallow.optionheader"
28733 #define ELM_NAVIFRAME_ITEM_TITLE_LABEL "elm.text.title"
28734 #define ELM_NAVIFRAME_ITEM_PREV_BTN "elm.swallow.prev_btn"
28735 #define ELM_NAVIFRAME_ITEM_TITLE_LEFT_BTN "elm.swallow.left_btn"
28736 #define ELM_NAVIFRAME_ITEM_TITLE_RIGHT_BTN "elm.swallow.right_btn"
28737 #define ELM_NAVIFRAME_ITEM_TITLE_MORE_BTN "elm.swallow.more_btn"
28738 #define ELM_NAVIFRAME_ITEM_CONTROLBAR "elm.swallow.controlbar"
28739 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_CLOSE "elm,state,optionheader,close", ""
28740 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_OPEN "elm,state,optionheader,open", ""
28741 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_CLOSE "elm,state,optionheader,instant_close", ""
28742 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_OPEN "elm,state,optionheader,instant_open", ""
28744 //Available only in a style - "2line"
28745 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER2 "elm.swallow.optionheader2"
28747 //Available only in a style - "segment"
28748 #define ELM_NAVIFRAME_ITEM_SEGMENT2 "elm.swallow.segment2"
28749 #define ELM_NAVIFRAME_ITEM_SEGMENT3 "elm.swallow.segment3"
28752 * @addtogroup Naviframe
28757 * @brief Add a new Naviframe object to the parent.
28759 * @param parent Parent object
28760 * @return New object or @c NULL, if it cannot be created
28762 * @ingroup Naviframe
28764 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28766 * @brief Push a new item to the top of the naviframe stack (and show it).
28768 * @param obj The naviframe object
28769 * @param title_label The label in the title area. The name of the title
28770 * label part is "elm.text.title"
28771 * @param prev_btn The button to go to the previous item. If it is NULL,
28772 * then naviframe will create a back button automatically. The name of
28773 * the prev_btn part is "elm.swallow.prev_btn"
28774 * @param next_btn The button to go to the next item. Or It could be just an
28775 * extra function button. The name of the next_btn part is
28776 * "elm.swallow.next_btn"
28777 * @param content The main content object. The name of content part is
28778 * "elm.swallow.content"
28779 * @param item_style The current item style name. @c NULL would be default.
28780 * @return The created item or @c NULL upon failure.
28782 * The item pushed becomes one page of the naviframe, this item will be
28783 * deleted when it is popped.
28785 * @see also elm_naviframe_item_style_set()
28786 * @see also elm_naviframe_item_insert_before()
28787 * @see also elm_naviframe_item_insert_after()
28789 * The following styles are available for this item:
28792 * @ingroup Naviframe
28794 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);
28796 * @brief Insert a new item into the naviframe before item @p before.
28798 * @param before The naviframe item to insert before.
28799 * @param title_label The label in the title area. The name of the title
28800 * label part is "elm.text.title"
28801 * @param prev_btn The button to go to the previous item. If it is NULL,
28802 * then naviframe will create a back button automatically. The name of
28803 * the prev_btn part is "elm.swallow.prev_btn"
28804 * @param next_btn The button to go to the next item. Or It could be just an
28805 * extra function button. The name of the next_btn part is
28806 * "elm.swallow.next_btn"
28807 * @param content The main content object. The name of content part is
28808 * "elm.swallow.content"
28809 * @param item_style The current item style name. @c NULL would be default.
28810 * @return The created item or @c NULL upon failure.
28812 * The item is inserted into the naviframe straight away without any
28813 * transition operations. This item will be deleted when it is popped.
28815 * @see also elm_naviframe_item_style_set()
28816 * @see also elm_naviframe_item_push()
28817 * @see also elm_naviframe_item_insert_after()
28819 * The following styles are available for this item:
28822 * @ingroup Naviframe
28824 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);
28826 * @brief Insert a new item into the naviframe after item @p after.
28828 * @param after The naviframe item to insert after.
28829 * @param title_label The label in the title area. The name of the title
28830 * label part is "elm.text.title"
28831 * @param prev_btn The button to go to the previous item. If it is NULL,
28832 * then naviframe will create a back button automatically. The name of
28833 * the prev_btn part is "elm.swallow.prev_btn"
28834 * @param next_btn The button to go to the next item. Or It could be just an
28835 * extra function button. The name of the next_btn part is
28836 * "elm.swallow.next_btn"
28837 * @param content The main content object. The name of content part is
28838 * "elm.swallow.content"
28839 * @param item_style The current item style name. @c NULL would be default.
28840 * @return The created item or @c NULL upon failure.
28842 * The item is inserted into the naviframe straight away without any
28843 * transition operations. This item will be deleted when it is popped.
28845 * @see also elm_naviframe_item_style_set()
28846 * @see also elm_naviframe_item_push()
28847 * @see also elm_naviframe_item_insert_before()
28849 * The following styles are available for this item:
28852 * @ingroup Naviframe
28854 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);
28856 * @brief Pop an item that is on top of the stack
28858 * @param obj The naviframe object
28859 * @return @c NULL or the content object(if the
28860 * elm_naviframe_content_preserve_on_pop_get is true).
28862 * This pops an item that is on the top(visible) of the naviframe, makes it
28863 * disappear, then deletes the item. The item that was underneath it on the
28864 * stack will become visible.
28866 * @see also elm_naviframe_content_preserve_on_pop_get()
28868 * @ingroup Naviframe
28870 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28872 * @brief Pop the items between the top and the above one on the given item.
28874 * @param it The naviframe item
28876 * @ingroup Naviframe
28878 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28880 * Promote an item already in the naviframe stack to the top of the stack
28882 * @param it The naviframe item
28884 * This will take the indicated item and promote it to the top of the stack
28885 * as if it had been pushed there. The item must already be inside the
28886 * naviframe stack to work.
28889 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28891 * @brief Delete the given item instantly.
28893 * @param it The naviframe item
28895 * This just deletes the given item from the naviframe item list instantly.
28896 * So this would not emit any signals for view transitions but just change
28897 * the current view if the given item is a top one.
28899 * @ingroup Naviframe
28901 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28903 * @brief preserve the content objects when items are popped.
28905 * @param obj The naviframe object
28906 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28908 * @see also elm_naviframe_content_preserve_on_pop_get()
28910 * @ingroup Naviframe
28912 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28914 * @brief Get a value whether preserve mode is enabled or not.
28916 * @param obj The naviframe object
28917 * @return If @c EINA_TRUE, preserve mode is enabled
28919 * @see also elm_naviframe_content_preserve_on_pop_set()
28921 * @ingroup Naviframe
28923 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28925 * @brief Get a top item on the naviframe stack
28927 * @param obj The naviframe object
28928 * @return The top item on the naviframe stack or @c NULL, if the stack is
28931 * @ingroup Naviframe
28933 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28935 * @brief Get a bottom item on the naviframe stack
28937 * @param obj The naviframe object
28938 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28941 * @ingroup Naviframe
28943 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28945 * @brief Set an item style
28947 * @param obj The naviframe item
28948 * @param item_style The current item style name. @c NULL would be default
28950 * The following styles are available for this item:
28953 * @see also elm_naviframe_item_style_get()
28955 * @ingroup Naviframe
28957 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28959 * @brief Get an item style
28961 * @param obj The naviframe item
28962 * @return The current item style name
28964 * @see also elm_naviframe_item_style_set()
28966 * @ingroup Naviframe
28968 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28970 * @brief Show/Hide the title area
28972 * @param it The naviframe item
28973 * @param visible If @c EINA_TRUE, title area will be visible, hidden
28976 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
28978 * @see also elm_naviframe_item_title_visible_get()
28980 * @ingroup Naviframe
28982 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28984 * @brief Get a value whether title area is visible or not.
28986 * @param it The naviframe item
28987 * @return If @c EINA_TRUE, title area is visible
28989 * @see also elm_naviframe_item_title_visible_set()
28991 * @ingroup Naviframe
28993 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28996 * @brief Set creating prev button automatically or not
28998 * @param obj The naviframe object
28999 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
29000 * be created internally when you pass the @c NULL to the prev_btn
29001 * parameter in elm_naviframe_item_push
29003 * @see also elm_naviframe_item_push()
29005 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
29007 * @brief Get a value whether prev button(back button) will be auto pushed or
29010 * @param obj The naviframe object
29011 * @return If @c EINA_TRUE, prev button will be auto pushed.
29013 * @see also elm_naviframe_item_push()
29014 * elm_naviframe_prev_btn_auto_pushed_set()
29016 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29018 * @brief Get a list of all the naviframe items.
29020 * @param obj The naviframe object
29021 * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
29022 * or @c NULL on failure.
29024 EAPI Eina_Inlist *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29031 #define CONTROLBAR_SYSTEM_ICON_ALBUMS "controlbar_albums"
29032 #define CONTROLBAR_SYSTEM_ICON_ARTISTS "controlbar_artists"
29033 #define CONTROLBAR_SYSTEM_ICON_SONGS "controlbar_songs"
29034 #define CONTROLBAR_SYSTEM_ICON_PLAYLIST "controlbar_playlist"
29035 #define CONTROLBAR_SYSTEM_ICON_MORE "controlbar_more"
29036 #define CONTROLBAR_SYSTEM_ICON_CONTACTS "controlbar_contacts"
29037 #define CONTROLBAR_SYSTEM_ICON_DIALER "controlbar_dialer"
29038 #define CONTROLBAR_SYSTEM_ICON_FAVORITES "controlbar_favorites"
29039 #define CONTROLBAR_SYSTEM_ICON_LOGS "controlbar_logs"
29041 typedef enum _Elm_Controlbar_Mode_Type
29043 ELM_CONTROLBAR_MODE_DEFAULT = 0,
29044 ELM_CONTROLBAR_MODE_TRANSLUCENCE,
29045 ELM_CONTROLBAR_MODE_TRANSPARENCY,
29046 ELM_CONTROLBAR_MODE_LARGE,
29047 ELM_CONTROLBAR_MODE_SMALL,
29048 ELM_CONTROLBAR_MODE_LEFT,
29049 ELM_CONTROLBAR_MODE_RIGHT
29050 } Elm_Controlbar_Mode_Type;
29052 typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
29053 EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
29054 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
29055 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
29056 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);
29057 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);
29058 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);
29059 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);
29060 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);
29061 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);
29062 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
29063 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
29064 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
29065 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
29066 EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
29067 EAPI void elm_controlbar_item_del(Elm_Controlbar_Item *it);
29068 EAPI void elm_controlbar_item_select(Elm_Controlbar_Item *it);
29069 EAPI void elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
29070 EAPI Eina_Bool elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
29071 EAPI void elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
29072 EAPI Eina_Bool elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
29073 EAPI void elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
29074 EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
29075 EAPI void elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
29076 EAPI const char *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
29077 EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
29078 EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
29079 EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
29080 EAPI const Eina_List *elm_controlbar_items_get(const Evas_Object *obj);
29081 EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
29082 EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
29083 EAPI void elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
29084 EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
29085 EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
29086 EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
29087 EAPI void elm_controlbar_mode_set(Evas_Object *obj, int mode);
29088 EAPI void elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
29089 EAPI void elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
29090 EAPI void elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
29093 EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
29094 EAPI void elm_searchbar_text_set(Evas_Object *obj, const char *entry);
29095 EAPI const char *elm_searchbar_text_get(Evas_Object *obj);
29096 EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
29097 EAPI Evas_Object *elm_searchbar_editfield_get(Evas_Object *obj);
29098 EAPI void elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
29099 EAPI void elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
29100 EAPI void elm_searchbar_clear(Evas_Object *obj);
29101 EAPI void elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);
29103 EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
29104 EAPI void elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
29105 EAPI void elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
29106 EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
29109 EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
29110 EAPI void elm_nocontents_label_set(Evas_Object *obj, const char *label);
29111 EAPI const char *elm_nocontents_label_get(const Evas_Object *obj);
29112 EAPI void elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
29113 EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
29118 ELM_TICKERNOTI_ORIENT_TOP = 0,
29119 ELM_TICKERNOTI_ORIENT_BOTTOM,
29120 ELM_TICKERNOTI_ORIENT_LAST
29121 } Elm_Tickernoti_Orient;
29123 EAPI Evas_Object *elm_tickernoti_add (Evas_Object *parent);
29124 EAPI void elm_tickernoti_orient_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
29125 EAPI Elm_Tickernoti_Orient elm_tickernoti_orient_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29126 EAPI int elm_tickernoti_rotation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29127 EAPI void elm_tickernoti_rotation_set (Evas_Object *obj, int angle) EINA_ARG_NONNULL(1);
29128 EAPI Evas_Object *elm_tickernoti_win_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29129 /* #### Below APIs and data structures are going to be deprecated, announcment will be made soon ####*/
29132 ELM_TICKERNOTI_DEFAULT,
29133 ELM_TICKERNOTI_DETAILVIEW
29134 } Elm_Tickernoti_Mode;
29135 EAPI void elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
29136 EAPI const char *elm_tickernoti_detailview_label_get (const Evas_Object *obj)EINA_ARG_NONNULL(1);
29137 EAPI void elm_tickernoti_detailview_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(2);
29138 EAPI Evas_Object *elm_tickernoti_detailview_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29139 EAPI void elm_tickernoti_detailview_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
29140 EAPI Evas_Object *elm_tickernoti_detailview_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29141 EAPI Evas_Object *elm_tickernoti_detailview_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29142 EAPI void elm_tickernoti_mode_set (Evas_Object *obj, Elm_Tickernoti_Mode mode) EINA_ARG_NONNULL(1);
29143 EAPI Elm_Tickernoti_Mode elm_tickernoti_mode_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29144 EAPI void elm_tickernoti_orientation_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
29145 EAPI Elm_Tickernoti_Orient elm_tickernoti_orientation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29146 EAPI void elm_tickernoti_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
29147 EAPI const char *elm_tickernoti_label_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29148 EAPI void elm_tickernoti_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
29149 EAPI Evas_Object *elm_tickernoti_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29150 EAPI void elm_tickernoti_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(1);
29151 EAPI Evas_Object *elm_tickernoti_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29152 /* ############################################################################### */
29154 * Parts which can be used with elm_object_text_part_set() and
29155 * elm_object_text_part_get():
29157 * @li NULL/"default" - Operates on tickernoti content-text
29159 * Parts which can be used with elm_object_content_part_set(),
29160 * elm_object_content_part_get() and elm_object_content_part_unset():
29162 * @li "icon" - Operates on tickernoti's icon
29163 * @li "button" - Operates on tickernoti's button
29165 * smart callbacks called:
29166 * @li "clicked" - emitted when tickernoti is clicked, except at the
29167 * swallow/button region, if any.
29168 * @li "hide" - emitted when the tickernoti is completely hidden. In case of
29169 * any hide animation, this signal is emitted after the animation.
29173 typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
29175 struct _Colorpalette_Color
29177 unsigned int r, g, b;
29180 EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
29181 EAPI void elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
29182 EAPI void elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
29183 /* smart callbacks called:
29184 * "clicked" - when image clicked
29188 EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
29189 EAPI void elm_editfield_label_set(Evas_Object *obj, const char *label);
29190 EAPI const char *elm_editfield_label_get(Evas_Object *obj);
29191 EAPI void elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
29192 EAPI const char *elm_editfield_guide_text_get(Evas_Object *obj);
29193 EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
29194 // EAPI Evas_Object *elm_editfield_clear_button_show(Evas_Object *obj, Eina_Bool show);
29195 EAPI void elm_editfield_right_icon_set(Evas_Object *obj, Evas_Object *icon);
29196 EAPI Evas_Object *elm_editfield_right_icon_get(Evas_Object *obj);
29197 EAPI void elm_editfield_left_icon_set(Evas_Object *obj, Evas_Object *icon);
29198 EAPI Evas_Object *elm_editfield_left_icon_get(Evas_Object *obj);
29199 EAPI void elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
29200 EAPI Eina_Bool elm_editfield_entry_single_line_get(Evas_Object *obj);
29201 EAPI void elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
29202 EAPI Eina_Bool elm_editfield_eraser_get(Evas_Object *obj);
29203 /* smart callbacks called:
29204 * "clicked" - when an editfield is clicked
29205 * "unfocused" - when an editfield is unfocused
29209 /* Sliding Drawer */
29210 typedef enum _Elm_SlidingDrawer_Pos
29212 ELM_SLIDINGDRAWER_BOTTOM,
29213 ELM_SLIDINGDRAWER_LEFT,
29214 ELM_SLIDINGDRAWER_RIGHT,
29215 ELM_SLIDINGDRAWER_TOP
29216 } Elm_SlidingDrawer_Pos;
29218 typedef struct _Elm_SlidingDrawer_Drag_Value
29221 } Elm_SlidingDrawer_Drag_Value;
29223 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_add(Evas_Object *parent);
29224 EINA_DEPRECATED EAPI void elm_slidingdrawer_content_set (Evas_Object *obj, Evas_Object *content);
29225 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_content_unset(Evas_Object *obj);
29226 EINA_DEPRECATED EAPI void elm_slidingdrawer_pos_set(Evas_Object *obj, Elm_SlidingDrawer_Pos pos);
29227 EINA_DEPRECATED EAPI void elm_slidingdrawer_max_drag_value_set(Evas_Object *obj, double dw, double dh);
29228 EINA_DEPRECATED EAPI void elm_slidingdrawer_drag_value_set(Evas_Object *obj, double dx, double dy);
29230 /* multibuttonentry */
29231 typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
29232 typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
29233 EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent);
29234 EAPI const char *elm_multibuttonentry_label_get(Evas_Object *obj);
29235 EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
29236 EAPI Evas_Object *elm_multibuttonentry_entry_get(Evas_Object *obj);
29237 EAPI const char * elm_multibuttonentry_guide_text_get(Evas_Object *obj);
29238 EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
29239 EAPI int elm_multibuttonentry_contracted_state_get(Evas_Object *obj);
29240 EAPI void elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
29241 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
29242 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
29243 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
29244 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
29245 EAPI const Eina_List *elm_multibuttonentry_items_get(Evas_Object *obj);
29246 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(Evas_Object *obj);
29247 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(Evas_Object *obj);
29248 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(Evas_Object *obj);
29249 EAPI void elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
29250 EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
29251 EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
29252 EAPI void elm_multibuttonentry_items_del(Evas_Object *obj);
29253 EAPI const char *elm_multibuttonentry_item_label_get(Elm_Multibuttonentry_Item *item);
29254 EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
29255 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
29256 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
29257 EAPI void *elm_multibuttonentry_item_data_get(Elm_Multibuttonentry_Item *item);
29258 EAPI void elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
29259 EAPI void elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
29260 /* smart callback called:
29261 * "selected" - This signal is emitted when the selected item of multibuttonentry is changed.
29262 * "added" - This signal is emitted when a new multibuttonentry item is added.
29263 * "deleted" - This signal is emitted when a multibuttonentry item is deleted.
29264 * "expanded" - This signal is emitted when a multibuttonentry is expanded.
29265 * "contracted" - This signal is emitted when a multibuttonentry is contracted.
29266 * "contracted,state,changed" - This signal is emitted when the contracted state of multibuttonentry is changed.
29267 * "item,selected" - This signal is emitted when the selected item of multibuttonentry is changed.
29268 * "item,added" - This signal is emitted when a new multibuttonentry item is added.
29269 * "item,deleted" - This signal is emitted when a multibuttonentry item is deleted.
29270 * "item,clicked" - This signal is emitted when a multibuttonentry item is clicked.
29271 * "clicked" - This signal is emitted when a multibuttonentry is clicked.
29272 * "unfocused" - This signal is emitted when a multibuttonentry is unfocused.
29274 /* available styles:
29279 typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
29280 EAPI Evas_Object *elm_stackedicon_add(Evas_Object *parent);
29281 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
29282 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
29283 EAPI void elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
29284 EAPI Eina_List *elm_stackedicon_item_list_get(Evas_Object *obj);
29285 /* smart callback called:
29286 * "expanded" - This signal is emitted when a stackedicon is expanded.
29287 * "clicked" - This signal is emitted when a stackedicon is clicked.
29289 /* available styles:
29293 /* dialoguegroup */
29294 typedef struct _Dialogue_Item Dialogue_Item;
29296 typedef enum _Elm_Dialoguegourp_Item_Style
29298 ELM_DIALOGUEGROUP_ITEM_STYLE_DEFAULT = 0,
29299 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD = (1 << 0),
29300 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD_WITH_TITLE = (1 << 1),
29301 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_TITLE = (1 << 2),
29302 ELM_DIALOGUEGROUP_ITEM_STYLE_HIDDEN = (1 << 3),
29303 ELM_DIALOGUEGROUP_ITEM_STYLE_DATAVIEW = (1 << 4),
29304 ELM_DIALOGUEGROUP_ITEM_STYLE_NO_BG = (1 << 5),
29305 ELM_DIALOGUEGROUP_ITEM_STYLE_SUB = (1 << 6),
29306 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT = (1 << 7),
29307 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_MERGE = (1 << 8),
29308 ELM_DIALOGUEGROUP_ITEM_STYLE_LAST = (1 << 9)
29309 } Elm_Dialoguegroup_Item_Style;
29311 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_add(Evas_Object *parent);
29312 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_append(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
29313 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_prepend(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
29314 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_after(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *after, Elm_Dialoguegroup_Item_Style style);
29315 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_before(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *before, Elm_Dialoguegroup_Item_Style style);
29316 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove(Dialogue_Item *item);
29317 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove_all(Evas_Object *obj);
29318 EINA_DEPRECATED EAPI void elm_dialoguegroup_title_set(Evas_Object *obj, const char *title);
29319 EINA_DEPRECATED EAPI const char *elm_dialoguegroup_title_get(Evas_Object *obj);
29320 EINA_DEPRECATED EAPI void elm_dialoguegroup_press_effect_set(Dialogue_Item *item, Eina_Bool press);
29321 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_press_effect_get(Dialogue_Item *item);
29322 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_item_content_get(Dialogue_Item *item);
29323 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_style_set(Dialogue_Item *item, Elm_Dialoguegroup_Item_Style style);
29324 EINA_DEPRECATED EAPI Elm_Dialoguegroup_Item_Style elm_dialoguegroup_item_style_get(Dialogue_Item *item);
29325 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_disabled_set(Dialogue_Item *item, Eina_Bool disabled);
29326 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_item_disabled_get(Dialogue_Item *item);
29331 ELM_DAYSELECTOR_SUN,
29332 ELM_DAYSELECTOR_MON,
29333 ELM_DAYSELECTOR_TUE,
29334 ELM_DAYSELECTOR_WED,
29335 ELM_DAYSELECTOR_THU,
29336 ELM_DAYSELECTOR_FRI,
29337 ELM_DAYSELECTOR_SAT
29338 } Elm_DaySelector_Day;
29340 EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
29341 EAPI Eina_Bool elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
29342 EAPI void elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
29345 typedef struct _Imageslider_Item Elm_Imageslider_Item;
29346 typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
29347 EAPI Evas_Object *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
29348 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);
29349 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);
29350 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);
29351 EAPI void elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29352 EAPI Elm_Imageslider_Item *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
29353 EAPI Eina_Bool elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29354 EAPI void elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29355 EAPI const char *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29356 EAPI Elm_Imageslider_Item *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29357 EAPI Elm_Imageslider_Item *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29358 EAPI void elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
29359 EAPI void elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
29360 EAPI void elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
29361 EAPI void elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);