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_EMAP_DEF@ ELM_EMAP
316 @ELM_DEBUG_DEF@ ELM_DEBUG
317 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
318 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
320 /* Standard headers for standard system calls etc. */
325 #include <sys/types.h>
326 #include <sys/stat.h>
327 #include <sys/time.h>
328 #include <sys/param.h>
341 # ifdef ELM_LIBINTL_H
342 # include <libintl.h>
353 #if defined (ELM_WIN32) || defined (ELM_WINCE)
356 # define alloca _alloca
367 #include <Ecore_Evas.h>
368 #include <Ecore_File.h>
369 #include <Ecore_IMF.h>
370 #include <Ecore_Con.h>
379 # include <Efreet_Mime.h>
380 # include <Efreet_Trash.h>
384 # include <Ethumb_Client.h>
396 # ifdef ELEMENTARY_BUILD
398 # define EAPI __declspec(dllexport)
401 # endif /* ! DLL_EXPORT */
403 # define EAPI __declspec(dllimport)
404 # endif /* ! EFL_EVAS_BUILD */
408 # define EAPI __attribute__ ((visibility("default")))
415 #endif /* ! _WIN32 */
420 # define EAPI_MAIN EAPI
423 /* allow usage from c++ */
428 #define ELM_VERSION_MAJOR @VMAJ@
429 #define ELM_VERSION_MINOR @VMIN@
431 typedef struct _Elm_Version
439 EAPI extern Elm_Version *elm_version;
442 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
443 #define ELM_PI 3.14159265358979323846
446 * @defgroup General General
448 * @brief General Elementary API. Functions that don't relate to
449 * Elementary objects specifically.
451 * Here are documented functions which init/shutdown the library,
452 * that apply to generic Elementary objects, that deal with
453 * configuration, et cetera.
455 * @ref general_functions_example_page "This" example contemplates
456 * some of these functions.
460 * @addtogroup General
465 * Defines couple of standard Evas_Object layers to be used
466 * with evas_object_layer_set().
468 * @note whenever extending with new values, try to keep some padding
469 * to siblings so there is room for further extensions.
471 typedef enum _Elm_Object_Layer
473 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
474 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
475 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
476 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
477 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
478 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
481 /**************************************************************************/
482 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
485 * Emitted when any Elementary's policy value is changed.
487 EAPI extern int ELM_EVENT_POLICY_CHANGED;
490 * @typedef Elm_Event_Policy_Changed
492 * Data on the event when an Elementary policy has changed
494 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
497 * @struct _Elm_Event_Policy_Changed
499 * Data on the event when an Elementary policy has changed
501 struct _Elm_Event_Policy_Changed
503 unsigned int policy; /**< the policy identifier */
504 int new_value; /**< value the policy had before the change */
505 int old_value; /**< new value the policy got */
509 * Policy identifiers.
511 typedef enum _Elm_Policy
513 ELM_POLICY_QUIT, /**< under which circumstances the application
514 * should quit automatically. @see
518 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
521 typedef enum _Elm_Policy_Quit
523 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
525 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
527 * window is closed */
528 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
530 typedef enum _Elm_Focus_Direction
534 } Elm_Focus_Direction;
536 typedef enum _Elm_Text_Format
538 ELM_TEXT_FORMAT_PLAIN_UTF8,
539 ELM_TEXT_FORMAT_MARKUP_UTF8
543 * Line wrapping types.
545 typedef enum _Elm_Wrap_Type
547 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
548 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
549 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
550 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
556 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
557 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
558 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
559 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
560 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
561 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
562 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
563 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
564 ELM_INPUT_PANEL_LAYOUT_INVALID
565 } Elm_Input_Panel_Layout;
569 ELM_AUTOCAPITAL_TYPE_NONE,
570 ELM_AUTOCAPITAL_TYPE_WORD,
571 ELM_AUTOCAPITAL_TYPE_SENTENCE,
572 ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
573 } Elm_Autocapital_Type;
576 * @typedef Elm_Object_Item
577 * An Elementary Object item handle.
580 typedef struct _Elm_Object_Item Elm_Object_Item;
584 * Called back when a widget's tooltip is activated and needs content.
585 * @param data user-data given to elm_object_tooltip_content_cb_set()
586 * @param obj owner widget.
588 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj);
591 * Called back when a widget's item tooltip is activated and needs content.
592 * @param data user-data given to elm_object_tooltip_content_cb_set()
593 * @param obj owner widget.
594 * @param item context dependent item. As an example, if tooltip was
595 * set on Elm_List_Item, then it is of this type.
597 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, void *item);
599 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
601 #ifndef ELM_LIB_QUICKLAUNCH
602 #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 */
604 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
607 /**************************************************************************/
611 * Initialize Elementary
613 * @param[in] argc System's argument count value
614 * @param[in] argv System's pointer to array of argument strings
615 * @return The init counter value.
617 * This function initializes Elementary and increments a counter of
618 * the number of calls to it. It returns the new counter's value.
620 * @warning This call is exported only for use by the @c ELM_MAIN()
621 * macro. There is no need to use this if you use this macro (which
622 * is highly advisable). An elm_main() should contain the entry
623 * point code for your application, having the same prototype as
624 * elm_init(), and @b not being static (putting the @c EAPI symbol
625 * in front of its type declaration is advisable). The @c
626 * ELM_MAIN() call should be placed just after it.
629 * @dontinclude bg_example_01.c
633 * See the full @ref bg_example_01_c "example".
635 * @see elm_shutdown().
638 EAPI int elm_init(int argc, char **argv);
641 * Shut down Elementary
643 * @return The init counter value.
645 * This should be called at the end of your application, just
646 * before it ceases to do any more processing. This will clean up
647 * any permanent resources your application may have allocated via
648 * Elementary that would otherwise persist.
650 * @see elm_init() for an example
654 EAPI int elm_shutdown(void);
657 * Run Elementary's main loop
659 * This call should be issued just after all initialization is
660 * completed. This function will not return until elm_exit() is
661 * called. It will keep looping, running the main
662 * (event/processing) loop for Elementary.
664 * @see elm_init() for an example
668 EAPI void elm_run(void);
671 * Exit Elementary's main loop
673 * If this call is issued, it will flag the main loop to cease
674 * processing and return back to its parent function (usually your
675 * elm_main() function).
677 * @see elm_init() for an example. There, just after a request to
678 * close the window comes, the main loop will be left.
680 * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
681 * applications, you'll be able to get this function called automatically for you.
685 EAPI void elm_exit(void);
688 * Provide information in order to make Elementary determine the @b
689 * run time location of the software in question, so other data files
690 * such as images, sound files, executable utilities, libraries,
691 * modules and locale files can be found.
693 * @param mainfunc This is your application's main function name,
694 * whose binary's location is to be found. Providing @c NULL
695 * will make Elementary not to use it
696 * @param dom This will be used as the application's "domain", in the
697 * form of a prefix to any environment variables that may
698 * override prefix detection and the directory name, inside the
699 * standard share or data directories, where the software's
700 * data files will be looked for.
701 * @param checkfile This is an (optional) magic file's path to check
702 * for existence (and it must be located in the data directory,
703 * under the share directory provided above). Its presence will
704 * help determine the prefix found was correct. Pass @c NULL if
705 * the check is not to be done.
707 * This function allows one to re-locate the application somewhere
708 * else after compilation, if the developer wishes for easier
709 * distribution of pre-compiled binaries.
711 * The prefix system is designed to locate where the given software is
712 * installed (under a common path prefix) at run time and then report
713 * specific locations of this prefix and common directories inside
714 * this prefix like the binary, library, data and locale directories,
715 * through the @c elm_app_*_get() family of functions.
717 * Call elm_app_info_set() early on before you change working
718 * directory or anything about @c argv[0], so it gets accurate
721 * It will then try and trace back which file @p mainfunc comes from,
722 * if provided, to determine the application's prefix directory.
724 * The @p dom parameter provides a string prefix to prepend before
725 * environment variables, allowing a fallback to @b specific
726 * environment variables to locate the software. You would most
727 * probably provide a lowercase string there, because it will also
728 * serve as directory domain, explained next. For environment
729 * variables purposes, this string is made uppercase. For example if
730 * @c "myapp" is provided as the prefix, then the program would expect
731 * @c "MYAPP_PREFIX" as a master environment variable to specify the
732 * exact install prefix for the software, or more specific environment
733 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
734 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
735 * the user or scripts before launching. If not provided (@c NULL),
736 * environment variables will not be used to override compiled-in
737 * defaults or auto detections.
739 * The @p dom string also provides a subdirectory inside the system
740 * shared data directory for data files. For example, if the system
741 * directory is @c /usr/local/share, then this directory name is
742 * appended, creating @c /usr/local/share/myapp, if it @p was @c
743 * "myapp". It is expected that the application installs data files in
746 * The @p checkfile is a file name or path of something inside the
747 * share or data directory to be used to test that the prefix
748 * detection worked. For example, your app will install a wallpaper
749 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
750 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
753 * @see elm_app_compile_bin_dir_set()
754 * @see elm_app_compile_lib_dir_set()
755 * @see elm_app_compile_data_dir_set()
756 * @see elm_app_compile_locale_set()
757 * @see elm_app_prefix_dir_get()
758 * @see elm_app_bin_dir_get()
759 * @see elm_app_lib_dir_get()
760 * @see elm_app_data_dir_get()
761 * @see elm_app_locale_dir_get()
763 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
766 * Provide information on the @b fallback application's binaries
767 * directory, in scenarios where they get overriden by
768 * elm_app_info_set().
770 * @param dir The path to the default binaries directory (compile time
773 * @note Elementary will as well use this path to determine actual
774 * names of binaries' directory paths, maybe changing it to be @c
775 * something/local/bin instead of @c something/bin, only, for
778 * @warning You should call this function @b before
779 * elm_app_info_set().
781 EAPI void elm_app_compile_bin_dir_set(const char *dir);
784 * Provide information on the @b fallback application's libraries
785 * directory, on scenarios where they get overriden by
786 * elm_app_info_set().
788 * @param dir The path to the default libraries directory (compile
791 * @note Elementary will as well use this path to determine actual
792 * names of libraries' directory paths, maybe changing it to be @c
793 * something/lib32 or @c something/lib64 instead of @c something/lib,
796 * @warning You should call this function @b before
797 * elm_app_info_set().
799 EAPI void elm_app_compile_lib_dir_set(const char *dir);
802 * Provide information on the @b fallback application's data
803 * directory, on scenarios where they get overriden by
804 * elm_app_info_set().
806 * @param dir The path to the default data directory (compile time
809 * @note Elementary will as well use this path to determine actual
810 * names of data directory paths, maybe changing it to be @c
811 * something/local/share instead of @c something/share, only, for
814 * @warning You should call this function @b before
815 * elm_app_info_set().
817 EAPI void elm_app_compile_data_dir_set(const char *dir);
820 * Provide information on the @b fallback application's locale
821 * directory, on scenarios where they get overriden by
822 * elm_app_info_set().
824 * @param dir The path to the default locale directory (compile time
827 * @warning You should call this function @b before
828 * elm_app_info_set().
830 EAPI void elm_app_compile_locale_set(const char *dir);
833 * Retrieve the application's run time prefix directory, as set by
834 * elm_app_info_set() and the way (environment) the application was
837 * @return The directory prefix the application is actually using.
839 EAPI const char *elm_app_prefix_dir_get(void);
842 * Retrieve the application's run time binaries prefix directory, as
843 * set by elm_app_info_set() and the way (environment) the application
846 * @return The binaries directory prefix the application is actually
849 EAPI const char *elm_app_bin_dir_get(void);
852 * Retrieve the application's run time libraries prefix directory, as
853 * set by elm_app_info_set() and the way (environment) the application
856 * @return The libraries directory prefix the application is actually
859 EAPI const char *elm_app_lib_dir_get(void);
862 * Retrieve the application's run time data prefix directory, as
863 * set by elm_app_info_set() and the way (environment) the application
866 * @return The data directory prefix the application is actually
869 EAPI const char *elm_app_data_dir_get(void);
872 * Retrieve the application's run time locale prefix directory, as
873 * set by elm_app_info_set() and the way (environment) the application
876 * @return The locale directory prefix the application is actually
879 EAPI const char *elm_app_locale_dir_get(void);
881 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
882 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
883 EAPI int elm_quicklaunch_init(int argc, char **argv);
884 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
885 EAPI int elm_quicklaunch_sub_shutdown(void);
886 EAPI int elm_quicklaunch_shutdown(void);
887 EAPI void elm_quicklaunch_seed(void);
888 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
889 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
890 EAPI void elm_quicklaunch_cleanup(void);
891 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
892 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
894 EAPI Eina_Bool elm_need_efreet(void);
895 EAPI Eina_Bool elm_need_e_dbus(void);
896 EAPI Eina_Bool elm_need_ethumb(void);
899 * Set a new policy's value (for a given policy group/identifier).
901 * @param policy policy identifier, as in @ref Elm_Policy.
902 * @param value policy value, which depends on the identifier
904 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
906 * Elementary policies define applications' behavior,
907 * somehow. These behaviors are divided in policy groups (see
908 * #Elm_Policy enumeration). This call will emit the Ecore event
909 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
910 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
913 * @note Currently, we have only one policy identifier/group
914 * (#ELM_POLICY_QUIT), which has two possible values.
918 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
921 * Gets the policy value for given policy identifier.
923 * @param policy policy identifier, as in #Elm_Policy.
924 * @return The currently set policy value, for that
925 * identifier. Will be @c 0 if @p policy passed is invalid.
929 EAPI int elm_policy_get(unsigned int policy);
932 * Change the language of the current application
934 * The @p lang passed must be the full name of the locale to use, for
935 * example "en_US.utf8" or "es_ES@euro".
937 * Changing language with this function will make Elementary run through
938 * all its widgets, translating strings set with
939 * elm_object_domain_translatable_text_part_set(). This way, an entire
940 * UI can have its language changed without having to restart the program.
942 * For more complex cases, like having formatted strings that need
943 * translation, widgets will also emit a "language,changed" signal that
944 * the user can listen to to manually translate the text.
946 * @param lang Language to set, must be the full name of the locale
950 EAPI void elm_language_set(const char *lang);
953 * Set a label of an object
955 * @param obj The Elementary object
956 * @param part The text part name to set (NULL for the default label)
957 * @param label The new text of the label
959 * @note Elementary objects may have many labels (e.g. Action Slider)
963 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
965 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
968 * Get a label of an object
970 * @param obj The Elementary object
971 * @param part The text part name to get (NULL for the default label)
972 * @return text of the label or NULL for any error
974 * @note Elementary objects may have many labels (e.g. Action Slider)
978 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
980 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
983 * Set the text for an objects part, marking it as translatable
985 * The string to set as @p text must be the original one. Do not pass the
986 * return of @c gettext() here. Elementary will translate the string
987 * internally and set it on the object using elm_object_text_part_set(),
988 * also storing the original string so that it can be automatically
989 * translated when the language is changed with elm_language_set().
991 * The @p domain will be stored along to find the translation in the
992 * correct catalog. It can be NULL, in which case it will use whatever
993 * domain was set by the application with @c textdomain(). This is useful
994 * in case you are building a library on top of Elementary that will have
995 * its own translatable strings, that should not be mixed with those of
996 * programs using the library.
998 * @param obj The object
999 * @param part The name of the part to set
1000 * @param domain The translation domain to use
1001 * @param text The original, non-translated text to set
1005 EAPI void elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1007 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1009 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1012 * Gets the original string set as translatable for an object
1014 * When setting translated strings, the function elm_object_text_part_get()
1015 * will return the translation returned by @c gettext(). To get the
1016 * original string use this function.
1018 * @param obj The object
1019 * @param part The name of the part that was set
1021 * @return The original, untranslated string
1025 EAPI const char *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1027 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1030 * Set a content of an object
1032 * @param obj The Elementary object
1033 * @param part The content part name to set (NULL for the default content)
1034 * @param content The new content of the object
1036 * @note Elementary objects may have many contents
1040 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1042 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
1045 * Get a content of an object
1047 * @param obj The Elementary object
1048 * @param item The content part name to get (NULL for the default content)
1049 * @return content of the object or NULL for any error
1051 * @note Elementary objects may have many contents
1055 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1057 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
1060 * Unset a content of an object
1062 * @param obj The Elementary object
1063 * @param item The content part name to unset (NULL for the default content)
1065 * @note Elementary objects may have many contents
1069 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1071 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1074 * Set a content of an object item
1076 * @param it The Elementary object item
1077 * @param part The content part name to set (NULL for the default content)
1078 * @param content The new content of the object item
1080 * @note Elementary object items may have many contents
1084 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1086 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1089 * Get a content of an object item
1091 * @param it The Elementary object item
1092 * @param part The content part name to unset (NULL for the default content)
1093 * @return content of the object item or NULL for any error
1095 * @note Elementary object items may have many contents
1099 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1101 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1104 * Unset a content of an object item
1106 * @param it The Elementary object item
1107 * @param part The content part name to unset (NULL for the default content)
1109 * @note Elementary object items may have many contents
1113 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1115 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1118 * Set a label of an object item
1120 * @param it The Elementary object item
1121 * @param part The text part name to set (NULL for the default label)
1122 * @param label The new text of the label
1124 * @note Elementary object items may have many labels
1128 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1130 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1133 * Get a label of an object item
1135 * @param it The Elementary object item
1136 * @param part The text part name to get (NULL for the default label)
1137 * @return text of the label or NULL for any error
1139 * @note Elementary object items may have many labels
1143 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1145 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1148 * Set the text to read out when in accessibility mode
1150 * @param obj The object which is to be described
1151 * @param txt The text that describes the widget to people with poor or no vision
1155 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1158 * Set the text to read out when in accessibility mode
1160 * @param it The object item which is to be described
1161 * @param txt The text that describes the widget to people with poor or no vision
1165 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1168 * Get the data associated with an object item
1169 * @param it The object item
1170 * @return The data associated with @p it
1174 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1177 * Set the data associated with an object item
1178 * @param it The object item
1179 * @param data The data to be associated with @p it
1183 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1186 * Send a signal to the edje object of the widget item.
1188 * This function sends a signal to the edje object of the obj item. An
1189 * edje program can respond to a signal by specifying matching
1190 * 'signal' and 'source' fields.
1192 * @param it The Elementary object item
1193 * @param emission The signal's name.
1194 * @param source The signal's source.
1197 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1204 * @defgroup Caches Caches
1206 * These are functions which let one fine-tune some cache values for
1207 * Elementary applications, thus allowing for performance adjustments.
1213 * @brief Flush all caches.
1215 * Frees all data that was in cache and is not currently being used to reduce
1216 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1217 * to calling all of the following functions:
1218 * @li edje_file_cache_flush()
1219 * @li edje_collection_cache_flush()
1220 * @li eet_clearcache()
1221 * @li evas_image_cache_flush()
1222 * @li evas_font_cache_flush()
1223 * @li evas_render_dump()
1224 * @note Evas caches are flushed for every canvas associated with a window.
1228 EAPI void elm_all_flush(void);
1231 * Get the configured cache flush interval time
1233 * This gets the globally configured cache flush interval time, in
1236 * @return The cache flush interval time
1239 * @see elm_all_flush()
1241 EAPI int elm_cache_flush_interval_get(void);
1244 * Set the configured cache flush interval time
1246 * This sets the globally configured cache flush interval time, in ticks
1248 * @param size The cache flush interval time
1251 * @see elm_all_flush()
1253 EAPI void elm_cache_flush_interval_set(int size);
1256 * Set the configured cache flush interval time for all applications on the
1259 * This sets the globally configured cache flush interval time -- in ticks
1260 * -- for all applications on the display.
1262 * @param size The cache flush interval time
1265 EAPI void elm_cache_flush_interval_all_set(int size);
1268 * Get the configured cache flush enabled state
1270 * This gets the globally configured cache flush state - if it is enabled
1271 * or not. When cache flushing is enabled, elementary will regularly
1272 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1273 * memory and allow usage to re-seed caches and data in memory where it
1274 * can do so. An idle application will thus minimise its memory usage as
1275 * data will be freed from memory and not be re-loaded as it is idle and
1276 * not rendering or doing anything graphically right now.
1278 * @return The cache flush state
1281 * @see elm_all_flush()
1283 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1286 * Set the configured cache flush enabled state
1288 * This sets the globally configured cache flush enabled state.
1290 * @param size The cache flush enabled state
1293 * @see elm_all_flush()
1295 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1298 * Set the configured cache flush enabled state for all applications on the
1301 * This sets the globally configured cache flush enabled state for all
1302 * applications on the display.
1304 * @param size The cache flush enabled state
1307 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1310 * Get the configured font cache size
1312 * This gets the globally configured font cache size, in bytes.
1314 * @return The font cache size
1317 EAPI int elm_font_cache_get(void);
1320 * Set the configured font cache size
1322 * This sets the globally configured font cache size, in bytes
1324 * @param size The font cache size
1327 EAPI void elm_font_cache_set(int size);
1330 * Set the configured font cache size for all applications on the
1333 * This sets the globally configured font cache size -- in bytes
1334 * -- for all applications on the display.
1336 * @param size The font cache size
1339 EAPI void elm_font_cache_all_set(int size);
1342 * Get the configured image cache size
1344 * This gets the globally configured image cache size, in bytes
1346 * @return The image cache size
1349 EAPI int elm_image_cache_get(void);
1352 * Set the configured image cache size
1354 * This sets the globally configured image cache size, in bytes
1356 * @param size The image cache size
1359 EAPI void elm_image_cache_set(int size);
1362 * Set the configured image cache size for all applications on the
1365 * This sets the globally configured image cache size -- in bytes
1366 * -- for all applications on the display.
1368 * @param size The image cache size
1371 EAPI void elm_image_cache_all_set(int size);
1374 * Get the configured edje file cache size.
1376 * This gets the globally configured edje file cache size, in number
1379 * @return The edje file cache size
1382 EAPI int elm_edje_file_cache_get(void);
1385 * Set the configured edje file cache size
1387 * This sets the globally configured edje file cache size, in number
1390 * @param size The edje file cache size
1393 EAPI void elm_edje_file_cache_set(int size);
1396 * Set the configured edje file cache size for all applications on the
1399 * This sets the globally configured edje file cache size -- in number
1400 * of files -- for all applications on the display.
1402 * @param size The edje file cache size
1405 EAPI void elm_edje_file_cache_all_set(int size);
1408 * Get the configured edje collections (groups) cache size.
1410 * This gets the globally configured edje collections cache size, in
1411 * number of collections.
1413 * @return The edje collections cache size
1416 EAPI int elm_edje_collection_cache_get(void);
1419 * Set the configured edje collections (groups) cache size
1421 * This sets the globally configured edje collections cache size, in
1422 * number of collections.
1424 * @param size The edje collections cache size
1427 EAPI void elm_edje_collection_cache_set(int size);
1430 * Set the configured edje collections (groups) cache size for all
1431 * applications on the display
1433 * This sets the globally configured edje collections cache size -- in
1434 * number of collections -- for all applications on the display.
1436 * @param size The edje collections cache size
1439 EAPI void elm_edje_collection_cache_all_set(int size);
1446 * @defgroup Scaling Widget Scaling
1448 * Different widgets can be scaled independently. These functions
1449 * allow you to manipulate this scaling on a per-widget basis. The
1450 * object and all its children get their scaling factors multiplied
1451 * by the scale factor set. This is multiplicative, in that if a
1452 * child also has a scale size set it is in turn multiplied by its
1453 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1454 * double size, @c 0.5 is half, etc.
1456 * @ref general_functions_example_page "This" example contemplates
1457 * some of these functions.
1461 * Set the scaling factor for a given Elementary object
1463 * @param obj The Elementary to operate on
1464 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1469 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1472 * Get the scaling factor for a given Elementary object
1474 * @param obj The object
1475 * @return The scaling factor set by elm_object_scale_set()
1479 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1482 * @defgroup Password_last_show Password last input show
1484 * Last show feature of password mode enables user to view
1485 * the last input entered for few seconds before masking it.
1486 * These functions allow to set this feature in password mode
1487 * of entry widget and also allow to manipulate the duration
1488 * for which the input has to be visible.
1494 * Get show last setting of password mode.
1496 * This gets the show last input setting of password mode which might be
1497 * enabled or disabled.
1499 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1501 * @ingroup Password_last_show
1503 EAPI Eina_Bool elm_password_show_last_get(void);
1506 * Set show last setting in password mode.
1508 * This enables or disables show last setting of password mode.
1510 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1511 * @see elm_password_show_last_timeout_set()
1512 * @ingroup Password_last_show
1514 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1517 * Get's the timeout value in last show password mode.
1519 * This gets the time out value for which the last input entered in password
1520 * mode will be visible.
1522 * @return The timeout value of last show password mode.
1523 * @ingroup Password_last_show
1525 EAPI double elm_password_show_last_timeout_get(void);
1528 * Set's the timeout value in last show password mode.
1530 * This sets the time out value for which the last input entered in password
1531 * mode will be visible.
1533 * @param password_show_last_timeout The timeout value.
1534 * @see elm_password_show_last_set()
1535 * @ingroup Password_last_show
1537 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1544 * @defgroup UI-Mirroring Selective Widget mirroring
1546 * These functions allow you to set ui-mirroring on specific
1547 * widgets or the whole interface. Widgets can be in one of two
1548 * modes, automatic and manual. Automatic means they'll be changed
1549 * according to the system mirroring mode and manual means only
1550 * explicit changes will matter. You are not supposed to change
1551 * mirroring state of a widget set to automatic, will mostly work,
1552 * but the behavior is not really defined.
1558 * Get the system mirrored mode. This determines the default mirrored mode
1561 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1563 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1566 * Set the system mirrored mode. This determines the default mirrored mode
1569 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1571 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1574 * Returns the widget's mirrored mode setting.
1576 * @param obj The widget.
1577 * @return mirrored mode setting of the object.
1580 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1583 * Sets the widget's mirrored mode setting.
1584 * When widget in automatic mode, it follows the system mirrored mode set by
1585 * elm_mirrored_set().
1586 * @param obj The widget.
1587 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1589 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1596 * Set the style to use by a widget
1598 * Sets the style name that will define the appearance of a widget. Styles
1599 * vary from widget to widget and may also be defined by other themes
1600 * by means of extensions and overlays.
1602 * @param obj The Elementary widget to style
1603 * @param style The style name to use
1605 * @see elm_theme_extension_add()
1606 * @see elm_theme_extension_del()
1607 * @see elm_theme_overlay_add()
1608 * @see elm_theme_overlay_del()
1612 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1614 * Get the style used by the widget
1616 * This gets the style being used for that widget. Note that the string
1617 * pointer is only valid as longas the object is valid and the style doesn't
1620 * @param obj The Elementary widget to query for its style
1621 * @return The style name used
1623 * @see elm_object_style_set()
1627 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1630 * @defgroup Styles Styles
1632 * Widgets can have different styles of look. These generic API's
1633 * set styles of widgets, if they support them (and if the theme(s)
1636 * @ref general_functions_example_page "This" example contemplates
1637 * some of these functions.
1641 * Set the disabled state of an Elementary object.
1643 * @param obj The Elementary object to operate on
1644 * @param disabled The state to put in in: @c EINA_TRUE for
1645 * disabled, @c EINA_FALSE for enabled
1647 * Elementary objects can be @b disabled, in which state they won't
1648 * receive input and, in general, will be themed differently from
1649 * their normal state, usually greyed out. Useful for contexts
1650 * where you don't want your users to interact with some of the
1651 * parts of you interface.
1653 * This sets the state for the widget, either disabling it or
1658 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1661 * Get the disabled state of an Elementary object.
1663 * @param obj The Elementary object to operate on
1664 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1665 * if it's enabled (or on errors)
1667 * This gets the state of the widget, which might be enabled or disabled.
1671 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1674 * @defgroup WidgetNavigation Widget Tree Navigation.
1676 * How to check if an Evas Object is an Elementary widget? How to
1677 * get the first elementary widget that is parent of the given
1678 * object? These are all covered in widget tree navigation.
1680 * @ref general_functions_example_page "This" example contemplates
1681 * some of these functions.
1685 * Check if the given Evas Object is an Elementary widget.
1687 * @param obj the object to query.
1688 * @return @c EINA_TRUE if it is an elementary widget variant,
1689 * @c EINA_FALSE otherwise
1690 * @ingroup WidgetNavigation
1692 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1695 * Get the first parent of the given object that is an Elementary
1698 * @param obj the Elementary object to query parent from.
1699 * @return the parent object that is an Elementary widget, or @c
1700 * NULL, if it was not found.
1702 * Use this to query for an object's parent widget.
1704 * @note Most of Elementary users wouldn't be mixing non-Elementary
1705 * smart objects in the objects tree of an application, as this is
1706 * an advanced usage of Elementary with Evas. So, except for the
1707 * application's window, which is the root of that tree, all other
1708 * objects would have valid Elementary widget parents.
1710 * @ingroup WidgetNavigation
1712 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1715 * Get the top level parent of an Elementary widget.
1717 * @param obj The object to query.
1718 * @return The top level Elementary widget, or @c NULL if parent cannot be
1720 * @ingroup WidgetNavigation
1722 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1725 * Get the string that represents this Elementary widget.
1727 * @note Elementary is weird and exposes itself as a single
1728 * Evas_Object_Smart_Class of type "elm_widget", so
1729 * evas_object_type_get() always return that, making debug and
1730 * language bindings hard. This function tries to mitigate this
1731 * problem, but the solution is to change Elementary to use
1732 * proper inheritance.
1734 * @param obj the object to query.
1735 * @return Elementary widget name, or @c NULL if not a valid widget.
1736 * @ingroup WidgetNavigation
1738 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1741 * @defgroup Config Elementary Config
1743 * Elementary configuration is formed by a set options bounded to a
1744 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1745 * "finger size", etc. These are functions with which one syncronizes
1746 * changes made to those values to the configuration storing files, de
1747 * facto. You most probably don't want to use the functions in this
1748 * group unlees you're writing an elementary configuration manager.
1752 EAPI double elm_scale_get(void);
1753 EAPI void elm_scale_set(double scale);
1754 EAPI void elm_scale_all_set(double scale);
1757 * Save back Elementary's configuration, so that it will persist on
1760 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1763 * This function will take effect -- thus, do I/O -- immediately. Use
1764 * it when you want to apply all configuration changes at once. The
1765 * current configuration set will get saved onto the current profile
1766 * configuration file.
1769 EAPI Eina_Bool elm_mirrored_get(void);
1770 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1773 * Reload Elementary's configuration, bounded to current selected
1776 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1779 * Useful when you want to force reloading of configuration values for
1780 * a profile. If one removes user custom configuration directories,
1781 * for example, it will force a reload with system values insted.
1784 EAPI Eina_Bool elm_config_save(void);
1785 EAPI void elm_config_reload(void);
1792 * @defgroup Profile Elementary Profile
1794 * Profiles are pre-set options that affect the whole look-and-feel of
1795 * Elementary-based applications. There are, for example, profiles
1796 * aimed at desktop computer applications and others aimed at mobile,
1797 * touchscreen-based ones. You most probably don't want to use the
1798 * functions in this group unlees you're writing an elementary
1799 * configuration manager.
1805 * Get Elementary's profile in use.
1807 * This gets the global profile that is applied to all Elementary
1810 * @return The profile's name
1813 EAPI const char *elm_profile_current_get(void);
1816 * Get an Elementary's profile directory path in the filesystem. One
1817 * may want to fetch a system profile's dir or an user one (fetched
1820 * @param profile The profile's name
1821 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1822 * or a system one (@c EINA_FALSE)
1823 * @return The profile's directory path.
1826 * @note You must free it with elm_profile_dir_free().
1828 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1831 * Free an Elementary's profile directory path, as returned by
1832 * elm_profile_dir_get().
1834 * @param p_dir The profile's path
1838 EAPI void elm_profile_dir_free(const char *p_dir);
1841 * Get Elementary's list of available profiles.
1843 * @return The profiles list. List node data are the profile name
1847 * @note One must free this list, after usage, with the function
1848 * elm_profile_list_free().
1850 EAPI Eina_List *elm_profile_list_get(void);
1853 * Free Elementary's list of available profiles.
1855 * @param l The profiles list, as returned by elm_profile_list_get().
1859 EAPI void elm_profile_list_free(Eina_List *l);
1862 * Set Elementary's profile.
1864 * This sets the global profile that is applied to Elementary
1865 * applications. Just the process the call comes from will be
1868 * @param profile The profile's name
1872 EAPI void elm_profile_set(const char *profile);
1875 * Set Elementary's profile.
1877 * This sets the global profile that is applied to all Elementary
1878 * applications. All running Elementary windows will be affected.
1880 * @param profile The profile's name
1884 EAPI void elm_profile_all_set(const char *profile);
1891 * @defgroup Engine Elementary Engine
1893 * These are functions setting and querying which rendering engine
1894 * Elementary will use for drawing its windows' pixels.
1896 * The following are the available engines:
1897 * @li "software_x11"
1900 * @li "software_16_x11"
1901 * @li "software_8_x11"
1904 * @li "software_gdi"
1905 * @li "software_16_wince_gdi"
1907 * @li "software_16_sdl"
1916 * @brief Get Elementary's rendering engine in use.
1918 * @return The rendering engine's name
1919 * @note there's no need to free the returned string, here.
1921 * This gets the global rendering engine that is applied to all Elementary
1924 * @see elm_engine_set()
1926 EAPI const char *elm_engine_current_get(void);
1929 * @brief Set Elementary's rendering engine for use.
1931 * @param engine The rendering engine's name
1933 * This sets global rendering engine that is applied to all Elementary
1934 * applications. Note that it will take effect only to Elementary windows
1935 * created after this is called.
1937 * @see elm_win_add()
1939 EAPI void elm_engine_set(const char *engine);
1946 * @defgroup Fonts Elementary Fonts
1948 * These are functions dealing with font rendering, selection and the
1949 * like for Elementary applications. One might fetch which system
1950 * fonts are there to use and set custom fonts for individual classes
1951 * of UI items containing text (text classes).
1956 typedef struct _Elm_Text_Class
1962 typedef struct _Elm_Font_Overlay
1964 const char *text_class;
1966 Evas_Font_Size size;
1969 typedef struct _Elm_Font_Properties
1973 } Elm_Font_Properties;
1976 * Get Elementary's list of supported text classes.
1978 * @return The text classes list, with @c Elm_Text_Class blobs as data.
1981 * Release the list with elm_text_classes_list_free().
1983 EAPI const Eina_List *elm_text_classes_list_get(void);
1986 * Free Elementary's list of supported text classes.
1990 * @see elm_text_classes_list_get().
1992 EAPI void elm_text_classes_list_free(const Eina_List *list);
1995 * Get Elementary's list of font overlays, set with
1996 * elm_font_overlay_set().
1998 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2003 * For each text class, one can set a <b>font overlay</b> for it,
2004 * overriding the default font properties for that class coming from
2005 * the theme in use. There is no need to free this list.
2007 * @see elm_font_overlay_set() and elm_font_overlay_unset().
2009 EAPI const Eina_List *elm_font_overlay_list_get(void);
2012 * Set a font overlay for a given Elementary text class.
2014 * @param text_class Text class name
2015 * @param font Font name and style string
2016 * @param size Font size
2020 * @p font has to be in the format returned by
2021 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2022 * and elm_font_overlay_unset().
2024 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2027 * Unset a font overlay for a given Elementary text class.
2029 * @param text_class Text class name
2033 * This will bring back text elements belonging to text class
2034 * @p text_class back to their default font settings.
2036 EAPI void elm_font_overlay_unset(const char *text_class);
2039 * Apply the changes made with elm_font_overlay_set() and
2040 * elm_font_overlay_unset() on the current Elementary window.
2044 * This applies all font overlays set to all objects in the UI.
2046 EAPI void elm_font_overlay_apply(void);
2049 * Apply the changes made with elm_font_overlay_set() and
2050 * elm_font_overlay_unset() on all Elementary application windows.
2054 * This applies all font overlays set to all objects in the UI.
2056 EAPI void elm_font_overlay_all_apply(void);
2059 * Translate a font (family) name string in fontconfig's font names
2060 * syntax into an @c Elm_Font_Properties struct.
2062 * @param font The font name and styles string
2063 * @return the font properties struct
2067 * @note The reverse translation can be achived with
2068 * elm_font_fontconfig_name_get(), for one style only (single font
2069 * instance, not family).
2071 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2074 * Free font properties return by elm_font_properties_get().
2076 * @param efp the font properties struct
2080 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2083 * Translate a font name, bound to a style, into fontconfig's font names
2086 * @param name The font (family) name
2087 * @param style The given style (may be @c NULL)
2089 * @return the font name and style string
2093 * @note The reverse translation can be achived with
2094 * elm_font_properties_get(), for one style only (single font
2095 * instance, not family).
2097 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2100 * Free the font string return by elm_font_fontconfig_name_get().
2102 * @param efp the font properties struct
2106 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2109 * Create a font hash table of available system fonts.
2111 * One must call it with @p list being the return value of
2112 * evas_font_available_list(). The hash will be indexed by font
2113 * (family) names, being its values @c Elm_Font_Properties blobs.
2115 * @param list The list of available system fonts, as returned by
2116 * evas_font_available_list().
2117 * @return the font hash.
2121 * @note The user is supposed to get it populated at least with 3
2122 * default font families (Sans, Serif, Monospace), which should be
2123 * present on most systems.
2125 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2128 * Free the hash return by elm_font_available_hash_add().
2130 * @param hash the hash to be freed.
2134 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2141 * @defgroup Fingers Fingers
2143 * Elementary is designed to be finger-friendly for touchscreens,
2144 * and so in addition to scaling for display resolution, it can
2145 * also scale based on finger "resolution" (or size). You can then
2146 * customize the granularity of the areas meant to receive clicks
2149 * Different profiles may have pre-set values for finger sizes.
2151 * @ref general_functions_example_page "This" example contemplates
2152 * some of these functions.
2158 * Get the configured "finger size"
2160 * @return The finger size
2162 * This gets the globally configured finger size, <b>in pixels</b>
2166 EAPI Evas_Coord elm_finger_size_get(void);
2169 * Set the configured finger size
2171 * This sets the globally configured finger size in pixels
2173 * @param size The finger size
2176 EAPI void elm_finger_size_set(Evas_Coord size);
2179 * Set the configured finger size for all applications on the display
2181 * This sets the globally configured finger size in pixels for all
2182 * applications on the display
2184 * @param size The finger size
2187 EAPI void elm_finger_size_all_set(Evas_Coord size);
2194 * @defgroup Focus Focus
2196 * An Elementary application has, at all times, one (and only one)
2197 * @b focused object. This is what determines where the input
2198 * events go to within the application's window. Also, focused
2199 * objects can be decorated differently, in order to signal to the
2200 * user where the input is, at a given moment.
2202 * Elementary applications also have the concept of <b>focus
2203 * chain</b>: one can cycle through all the windows' focusable
2204 * objects by input (tab key) or programmatically. The default
2205 * focus chain for an application is the one define by the order in
2206 * which the widgets where added in code. One will cycle through
2207 * top level widgets, and, for each one containg sub-objects, cycle
2208 * through them all, before returning to the level
2209 * above. Elementary also allows one to set @b custom focus chains
2210 * for their applications.
2212 * Besides the focused decoration a widget may exhibit, when it
2213 * gets focus, Elementary has a @b global focus highlight object
2214 * that can be enabled for a window. If one chooses to do so, this
2215 * extra highlight effect will surround the current focused object,
2218 * @note Some Elementary widgets are @b unfocusable, after
2219 * creation, by their very nature: they are not meant to be
2220 * interacted with input events, but are there just for visual
2223 * @ref general_functions_example_page "This" example contemplates
2224 * some of these functions.
2228 * Get the enable status of the focus highlight
2230 * This gets whether the highlight on focused objects is enabled or not
2233 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2236 * Set the enable status of the focus highlight
2238 * Set whether to show or not the highlight on focused objects
2239 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2242 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2245 * Get the enable status of the highlight animation
2247 * Get whether the focus highlight, if enabled, will animate its switch from
2248 * one object to the next
2251 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2254 * Set the enable status of the highlight animation
2256 * Set whether the focus highlight, if enabled, will animate its switch from
2257 * one object to the next
2258 * @param animate Enable animation if EINA_TRUE, disable otherwise
2261 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2264 * Get the whether an Elementary object has the focus or not.
2266 * @param obj The Elementary object to get the information from
2267 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2268 * not (and on errors).
2270 * @see elm_object_focus_set()
2274 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2277 * Make a given Elementary object the focused one.
2279 * @param obj The Elementary object to make focused.
2281 * @note This object, if it can handle focus, will take the focus
2282 * away from the one who had it previously and will, for now on, be
2283 * the one receiving input events.
2285 * @see elm_object_focus_get()
2289 EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2292 * Remove the focus from an Elementary object
2294 * @param obj The Elementary to take focus from
2296 * This removes the focus from @p obj, passing it back to the
2297 * previous element in the focus chain list.
2299 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2303 EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2306 * Set the ability for an Element object to be focused
2308 * @param obj The Elementary object to operate on
2309 * @param enable @c EINA_TRUE if the object can be focused, @c
2310 * EINA_FALSE if not (and on errors)
2312 * This sets whether the object @p obj is able to take focus or
2313 * not. Unfocusable objects do nothing when programmatically
2314 * focused, being the nearest focusable parent object the one
2315 * really getting focus. Also, when they receive mouse input, they
2316 * will get the event, but not take away the focus from where it
2321 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2324 * Get whether an Elementary object is focusable or not
2326 * @param obj The Elementary object to operate on
2327 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2328 * EINA_FALSE if not (and on errors)
2330 * @note Objects which are meant to be interacted with by input
2331 * events are created able to be focused, by default. All the
2336 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2339 * Set custom focus chain.
2341 * This function overwrites any previous custom focus chain within
2342 * the list of objects. The previous list will be deleted and this list
2343 * will be managed by elementary. After it is set, don't modify it.
2345 * @note On focus cycle, only will be evaluated children of this container.
2347 * @param obj The container object
2348 * @param objs Chain of objects to pass focus
2351 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2354 * Unset a custom focus chain on a given Elementary widget
2356 * @param obj The container object to remove focus chain from
2358 * Any focus chain previously set on @p obj (for its child objects)
2359 * is removed entirely after this call.
2363 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2366 * Get custom focus chain
2368 * @param obj The container object
2371 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2374 * Append object to custom focus chain.
2376 * @note If relative_child equal to NULL or not in custom chain, the object
2377 * will be added in end.
2379 * @note On focus cycle, only will be evaluated children of this container.
2381 * @param obj The container object
2382 * @param child The child to be added in custom chain
2383 * @param relative_child The relative object to position the child
2386 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2389 * Prepend object to custom focus chain.
2391 * @note If relative_child equal to NULL or not in custom chain, the object
2392 * will be added in begin.
2394 * @note On focus cycle, only will be evaluated children of this container.
2396 * @param obj The container object
2397 * @param child The child to be added in custom chain
2398 * @param relative_child The relative object to position the child
2401 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2404 * Give focus to next object in object tree.
2406 * Give focus to next object in focus chain of one object sub-tree.
2407 * If the last object of chain already have focus, the focus will go to the
2408 * first object of chain.
2410 * @param obj The object root of sub-tree
2411 * @param dir Direction to cycle the focus
2415 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2418 * Give focus to near object in one direction.
2420 * Give focus to near object in direction of one object.
2421 * If none focusable object in given direction, the focus will not change.
2423 * @param obj The reference object
2424 * @param x Horizontal component of direction to focus
2425 * @param y Vertical component of direction to focus
2429 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2432 * Make the elementary object and its children to be unfocusable
2435 * @param obj The Elementary object to operate on
2436 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2437 * @c EINA_FALSE for focusable.
2439 * This sets whether the object @p obj and its children objects
2440 * are able to take focus or not. If the tree is set as unfocusable,
2441 * newest focused object which is not in this tree will get focus.
2442 * This API can be helpful for an object to be deleted.
2443 * When an object will be deleted soon, it and its children may not
2444 * want to get focus (by focus reverting or by other focus controls).
2445 * Then, just use this API before deleting.
2447 * @see elm_object_tree_unfocusable_get()
2451 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2454 * Get whether an Elementary object and its children are unfocusable or not.
2456 * @param obj The Elementary object to get the information from
2457 * @return @c EINA_TRUE, if the tree is unfocussable,
2458 * @c EINA_FALSE if not (and on errors).
2460 * @see elm_object_tree_unfocusable_set()
2464 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2467 * @defgroup Scrolling Scrolling
2469 * These are functions setting how scrollable views in Elementary
2470 * widgets should behave on user interaction.
2476 * Get whether scrollers should bounce when they reach their
2477 * viewport's edge during a scroll.
2479 * @return the thumb scroll bouncing state
2481 * This is the default behavior for touch screens, in general.
2482 * @ingroup Scrolling
2484 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2487 * Set whether scrollers should bounce when they reach their
2488 * viewport's edge during a scroll.
2490 * @param enabled the thumb scroll bouncing state
2492 * @see elm_thumbscroll_bounce_enabled_get()
2493 * @ingroup Scrolling
2495 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2498 * Set whether scrollers should bounce when they reach their
2499 * viewport's edge during a scroll, for all Elementary application
2502 * @param enabled the thumb scroll bouncing state
2504 * @see elm_thumbscroll_bounce_enabled_get()
2505 * @ingroup Scrolling
2507 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2510 * Get the amount of inertia a scroller will impose at bounce
2513 * @return the thumb scroll bounce friction
2515 * @ingroup Scrolling
2517 EAPI double elm_scroll_bounce_friction_get(void);
2520 * Set the amount of inertia a scroller will impose at bounce
2523 * @param friction the thumb scroll bounce friction
2525 * @see elm_thumbscroll_bounce_friction_get()
2526 * @ingroup Scrolling
2528 EAPI void elm_scroll_bounce_friction_set(double friction);
2531 * Set the amount of inertia a scroller will impose at bounce
2532 * animations, for all Elementary application windows.
2534 * @param friction the thumb scroll bounce friction
2536 * @see elm_thumbscroll_bounce_friction_get()
2537 * @ingroup Scrolling
2539 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2542 * Get the amount of inertia a <b>paged</b> scroller will impose at
2543 * page fitting animations.
2545 * @return the page scroll friction
2547 * @ingroup Scrolling
2549 EAPI double elm_scroll_page_scroll_friction_get(void);
2552 * Set the amount of inertia a <b>paged</b> scroller will impose at
2553 * page fitting animations.
2555 * @param friction the page scroll friction
2557 * @see elm_thumbscroll_page_scroll_friction_get()
2558 * @ingroup Scrolling
2560 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2563 * Set the amount of inertia a <b>paged</b> scroller will impose at
2564 * page fitting animations, for all Elementary application windows.
2566 * @param friction the page scroll friction
2568 * @see elm_thumbscroll_page_scroll_friction_get()
2569 * @ingroup Scrolling
2571 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2574 * Get the amount of inertia a scroller will impose at region bring
2577 * @return the bring in scroll friction
2579 * @ingroup Scrolling
2581 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2584 * Set the amount of inertia a scroller will impose at region bring
2587 * @param friction the bring in scroll friction
2589 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2590 * @ingroup Scrolling
2592 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2595 * Set the amount of inertia a scroller will impose at region bring
2596 * animations, for all Elementary application windows.
2598 * @param friction the bring in scroll friction
2600 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2601 * @ingroup Scrolling
2603 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2606 * Get the amount of inertia scrollers will impose at animations
2607 * triggered by Elementary widgets' zooming API.
2609 * @return the zoom friction
2611 * @ingroup Scrolling
2613 EAPI double elm_scroll_zoom_friction_get(void);
2616 * Set the amount of inertia scrollers will impose at animations
2617 * triggered by Elementary widgets' zooming API.
2619 * @param friction the zoom friction
2621 * @see elm_thumbscroll_zoom_friction_get()
2622 * @ingroup Scrolling
2624 EAPI void elm_scroll_zoom_friction_set(double friction);
2627 * Set the amount of inertia scrollers will impose at animations
2628 * triggered by Elementary widgets' zooming API, for all Elementary
2629 * application windows.
2631 * @param friction the zoom friction
2633 * @see elm_thumbscroll_zoom_friction_get()
2634 * @ingroup Scrolling
2636 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2639 * Get whether scrollers should be draggable from any point in their
2642 * @return the thumb scroll state
2644 * @note This is the default behavior for touch screens, in general.
2645 * @note All other functions namespaced with "thumbscroll" will only
2646 * have effect if this mode is enabled.
2648 * @ingroup Scrolling
2650 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2653 * Set whether scrollers should be draggable from any point in their
2656 * @param enabled the thumb scroll state
2658 * @see elm_thumbscroll_enabled_get()
2659 * @ingroup Scrolling
2661 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2664 * Set whether scrollers should be draggable from any point in their
2665 * views, for all Elementary application windows.
2667 * @param enabled the thumb scroll state
2669 * @see elm_thumbscroll_enabled_get()
2670 * @ingroup Scrolling
2672 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2675 * Get the number of pixels one should travel while dragging a
2676 * scroller's view to actually trigger scrolling.
2678 * @return the thumb scroll threshould
2680 * One would use higher values for touch screens, in general, because
2681 * of their inherent imprecision.
2682 * @ingroup Scrolling
2684 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2687 * Set the number of pixels one should travel while dragging a
2688 * scroller's view to actually trigger scrolling.
2690 * @param threshold the thumb scroll threshould
2692 * @see elm_thumbscroll_threshould_get()
2693 * @ingroup Scrolling
2695 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2698 * Set the number of pixels one should travel while dragging a
2699 * scroller's view to actually trigger scrolling, for all Elementary
2700 * application windows.
2702 * @param threshold the thumb scroll threshould
2704 * @see elm_thumbscroll_threshould_get()
2705 * @ingroup Scrolling
2707 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2710 * Get the minimum speed of mouse cursor movement which will trigger
2711 * list self scrolling animation after a mouse up event
2714 * @return the thumb scroll momentum threshould
2716 * @ingroup Scrolling
2718 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2721 * Set the minimum speed of mouse cursor movement which will trigger
2722 * list self scrolling animation after a mouse up event
2725 * @param threshold the thumb scroll momentum threshould
2727 * @see elm_thumbscroll_momentum_threshould_get()
2728 * @ingroup Scrolling
2730 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2733 * Set the minimum speed of mouse cursor movement which will trigger
2734 * list self scrolling animation after a mouse up event
2735 * (pixels/second), for all Elementary application windows.
2737 * @param threshold the thumb scroll momentum threshould
2739 * @see elm_thumbscroll_momentum_threshould_get()
2740 * @ingroup Scrolling
2742 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2745 * Get the amount of inertia a scroller will impose at self scrolling
2748 * @return the thumb scroll friction
2750 * @ingroup Scrolling
2752 EAPI double elm_scroll_thumbscroll_friction_get(void);
2755 * Set the amount of inertia a scroller will impose at self scrolling
2758 * @param friction the thumb scroll friction
2760 * @see elm_thumbscroll_friction_get()
2761 * @ingroup Scrolling
2763 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
2766 * Set the amount of inertia a scroller will impose at self scrolling
2767 * animations, for all Elementary application windows.
2769 * @param friction the thumb scroll friction
2771 * @see elm_thumbscroll_friction_get()
2772 * @ingroup Scrolling
2774 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
2777 * Get the amount of lag between your actual mouse cursor dragging
2778 * movement and a scroller's view movement itself, while pushing it
2779 * into bounce state manually.
2781 * @return the thumb scroll border friction
2783 * @ingroup Scrolling
2785 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
2788 * Set the amount of lag between your actual mouse cursor dragging
2789 * movement and a scroller's view movement itself, while pushing it
2790 * into bounce state manually.
2792 * @param friction the thumb scroll border friction. @c 0.0 for
2793 * perfect synchrony between two movements, @c 1.0 for maximum
2796 * @see elm_thumbscroll_border_friction_get()
2797 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2799 * @ingroup Scrolling
2801 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
2804 * Set the amount of lag between your actual mouse cursor dragging
2805 * movement and a scroller's view movement itself, while pushing it
2806 * into bounce state manually, for all Elementary application windows.
2808 * @param friction the thumb scroll border friction. @c 0.0 for
2809 * perfect synchrony between two movements, @c 1.0 for maximum
2812 * @see elm_thumbscroll_border_friction_get()
2813 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2815 * @ingroup Scrolling
2817 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
2820 * Get the sensitivity amount which is be multiplied by the length of
2823 * @return the thumb scroll sensitivity friction
2825 * @ingroup Scrolling
2827 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
2830 * Set the sensitivity amount which is be multiplied by the length of
2833 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2834 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2837 * @see elm_thumbscroll_sensitivity_friction_get()
2838 * @note parameter value will get bound to 0.1 - 1.0 interval, always
2840 * @ingroup Scrolling
2842 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
2845 * Set the sensitivity amount which is be multiplied by the length of
2846 * mouse dragging, for all Elementary application windows.
2848 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2849 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2852 * @see elm_thumbscroll_sensitivity_friction_get()
2853 * @note parameter value will get bound to 0.1 - 1.0 interval, always
2855 * @ingroup Scrolling
2857 EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
2864 * @defgroup Scrollhints Scrollhints
2866 * Objects when inside a scroller can scroll, but this may not always be
2867 * desirable in certain situations. This allows an object to hint to itself
2868 * and parents to "not scroll" in one of 2 ways. If any child object of a
2869 * scroller has pushed a scroll freeze or hold then it affects all parent
2870 * scrollers until all children have released them.
2872 * 1. To hold on scrolling. This means just flicking and dragging may no
2873 * longer scroll, but pressing/dragging near an edge of the scroller will
2874 * still scroll. This is automatically used by the entry object when
2877 * 2. To totally freeze scrolling. This means it stops. until
2884 * Push the scroll hold by 1
2886 * This increments the scroll hold count by one. If it is more than 0 it will
2887 * take effect on the parents of the indicated object.
2889 * @param obj The object
2890 * @ingroup Scrollhints
2892 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2895 * Pop the scroll hold by 1
2897 * This decrements the scroll hold count by one. If it is more than 0 it will
2898 * take effect on the parents of the indicated object.
2900 * @param obj The object
2901 * @ingroup Scrollhints
2903 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2906 * Push the scroll freeze by 1
2908 * This increments the scroll freeze count by one. If it is more
2909 * than 0 it will take effect on the parents of the indicated
2912 * @param obj The object
2913 * @ingroup Scrollhints
2915 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2918 * Pop the scroll freeze by 1
2920 * This decrements the scroll freeze count by one. If it is more
2921 * than 0 it will take effect on the parents of the indicated
2924 * @param obj The object
2925 * @ingroup Scrollhints
2927 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2930 * Lock the scrolling of the given widget (and thus all parents)
2932 * This locks the given object from scrolling in the X axis (and implicitly
2933 * also locks all parent scrollers too from doing the same).
2935 * @param obj The object
2936 * @param lock The lock state (1 == locked, 0 == unlocked)
2937 * @ingroup Scrollhints
2939 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2942 * Lock the scrolling of the given widget (and thus all parents)
2944 * This locks the given object from scrolling in the Y axis (and implicitly
2945 * also locks all parent scrollers too from doing the same).
2947 * @param obj The object
2948 * @param lock The lock state (1 == locked, 0 == unlocked)
2949 * @ingroup Scrollhints
2951 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2954 * Get the scrolling lock of the given widget
2956 * This gets the lock for X axis scrolling.
2958 * @param obj The object
2959 * @ingroup Scrollhints
2961 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2964 * Get the scrolling lock of the given widget
2966 * This gets the lock for X axis scrolling.
2968 * @param obj The object
2969 * @ingroup Scrollhints
2971 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2978 * Send a signal to the widget edje object.
2980 * This function sends a signal to the edje object of the obj. An
2981 * edje program can respond to a signal by specifying matching
2982 * 'signal' and 'source' fields.
2984 * @param obj The object
2985 * @param emission The signal's name.
2986 * @param source The signal's source.
2989 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
2990 EAPI void elm_object_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, void (*func) (void *data, Evas_Object *o, const char *emission, const char *source), void *data) EINA_ARG_NONNULL(1, 4);
2991 EAPI void *elm_object_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, void (*func) (void *data, Evas_Object *o, const char *emission, const char *source)) EINA_ARG_NONNULL(1, 4);
2994 * Add a callback for a signal emitted by widget edje object.
2996 * This function connects a callback function to a signal emitted by the
2997 * edje object of the obj.
2998 * Globs can occur in either the emission or source name.
3000 * @param obj The object
3001 * @param emission The signal's name.
3002 * @param source The signal's source.
3003 * @param func The callback function to be executed when the signal is
3005 * @param data A pointer to data to pass in to the callback function.
3008 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);
3011 * Remove a signal-triggered callback from a widget edje object.
3013 * This function removes a callback, previoulsy attached to a
3014 * signal emitted by the edje object of the obj. The parameters
3015 * emission, source and func must match exactly those passed to a
3016 * previous call to elm_object_signal_callback_add(). The data
3017 * pointer that was passed to this call will be returned.
3019 * @param obj The object
3020 * @param emission The signal's name.
3021 * @param source The signal's source.
3022 * @param func The callback function to be executed when the signal is
3024 * @return The data pointer
3027 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);
3030 * Add a callback for input events (key up, key down, mouse wheel)
3031 * on a given Elementary widget
3033 * @param obj The widget to add an event callback on
3034 * @param func The callback function to be executed when the event
3036 * @param data Data to pass in to @p func
3038 * Every widget in an Elementary interface set to receive focus,
3039 * with elm_object_focus_allow_set(), will propagate @b all of its
3040 * key up, key down and mouse wheel input events up to its parent
3041 * object, and so on. All of the focusable ones in this chain which
3042 * had an event callback set, with this call, will be able to treat
3043 * those events. There are two ways of making the propagation of
3044 * these event upwards in the tree of widgets to @b cease:
3045 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3046 * the event was @b not processed, so the propagation will go on.
3047 * - The @c event_info pointer passed to @p func will contain the
3048 * event's structure and, if you OR its @c event_flags inner
3049 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3050 * one has already handled it, thus killing the event's
3053 * @note Your event callback will be issued on those events taking
3054 * place only if no other child widget of @obj has consumed the
3057 * @note Not to be confused with @c
3058 * evas_object_event_callback_add(), which will add event callbacks
3059 * per type on general Evas objects (no event propagation
3060 * infrastructure taken in account).
3062 * @note Not to be confused with @c
3063 * elm_object_signal_callback_add(), which will add callbacks to @b
3064 * signals coming from a widget's theme, not input events.
3066 * @note Not to be confused with @c
3067 * edje_object_signal_callback_add(), which does the same as
3068 * elm_object_signal_callback_add(), but directly on an Edje
3071 * @note Not to be confused with @c
3072 * evas_object_smart_callback_add(), which adds callbacks to smart
3073 * objects' <b>smart events</b>, and not input events.
3075 * @see elm_object_event_callback_del()
3079 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3082 * Remove an event callback from a widget.
3084 * This function removes a callback, previoulsy attached to event emission
3086 * The parameters func and data must match exactly those passed to
3087 * a previous call to elm_object_event_callback_add(). The data pointer that
3088 * was passed to this call will be returned.
3090 * @param obj The object
3091 * @param func The callback function to be executed when the event is
3093 * @param data Data to pass in to the callback function.
3094 * @return The data pointer
3097 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3100 * Adjust size of an element for finger usage.
3102 * @param times_w How many fingers should fit horizontally
3103 * @param w Pointer to the width size to adjust
3104 * @param times_h How many fingers should fit vertically
3105 * @param h Pointer to the height size to adjust
3107 * This takes width and height sizes (in pixels) as input and a
3108 * size multiple (which is how many fingers you want to place
3109 * within the area, being "finger" the size set by
3110 * elm_finger_size_set()), and adjusts the size to be large enough
3111 * to accommodate the resulting size -- if it doesn't already
3112 * accommodate it. On return the @p w and @p h sizes pointed to by
3113 * these parameters will be modified, on those conditions.
3115 * @note This is kind of a low level Elementary call, most useful
3116 * on size evaluation times for widgets. An external user wouldn't
3117 * be calling, most of the time.
3121 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3124 * Get the duration for occuring long press event.
3126 * @return Timeout for long press event
3127 * @ingroup Longpress
3129 EAPI double elm_longpress_timeout_get(void);
3132 * Set the duration for occuring long press event.
3134 * @param lonpress_timeout Timeout for long press event
3135 * @ingroup Longpress
3137 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3140 * @defgroup Debug Debug
3141 * don't use it unless you are sure
3147 * Print Tree object hierarchy in stdout
3149 * @param obj The root object
3152 EAPI void elm_object_tree_dump(const Evas_Object *top);
3153 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3155 EAPI void elm_autocapitalization_allow_all_set(Eina_Bool autocap);
3156 EAPI void elm_autoperiod_allow_all_set(Eina_Bool autoperiod);
3158 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3160 * @param obj The root object
3161 * @param file The path of output file
3164 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3171 * @defgroup Theme Theme
3173 * Elementary uses Edje to theme its widgets, naturally. But for the most
3174 * part this is hidden behind a simpler interface that lets the user set
3175 * extensions and choose the style of widgets in a much easier way.
3177 * Instead of thinking in terms of paths to Edje files and their groups
3178 * each time you want to change the appearance of a widget, Elementary
3179 * works so you can add any theme file with extensions or replace the
3180 * main theme at one point in the application, and then just set the style
3181 * of widgets with elm_object_style_set() and related functions. Elementary
3182 * will then look in its list of themes for a matching group and apply it,
3183 * and when the theme changes midway through the application, all widgets
3184 * will be updated accordingly.
3186 * There are three concepts you need to know to understand how Elementary
3187 * theming works: default theme, extensions and overlays.
3189 * Default theme, obviously enough, is the one that provides the default
3190 * look of all widgets. End users can change the theme used by Elementary
3191 * by setting the @c ELM_THEME environment variable before running an
3192 * application, or globally for all programs using the @c elementary_config
3193 * utility. Applications can change the default theme using elm_theme_set(),
3194 * but this can go against the user wishes, so it's not an adviced practice.
3196 * Ideally, applications should find everything they need in the already
3197 * provided theme, but there may be occasions when that's not enough and
3198 * custom styles are required to correctly express the idea. For this
3199 * cases, Elementary has extensions.
3201 * Extensions allow the application developer to write styles of its own
3202 * to apply to some widgets. This requires knowledge of how each widget
3203 * is themed, as extensions will always replace the entire group used by
3204 * the widget, so important signals and parts need to be there for the
3205 * object to behave properly (see documentation of Edje for details).
3206 * Once the theme for the extension is done, the application needs to add
3207 * it to the list of themes Elementary will look into, using
3208 * elm_theme_extension_add(), and set the style of the desired widgets as
3209 * he would normally with elm_object_style_set().
3211 * Overlays, on the other hand, can replace the look of all widgets by
3212 * overriding the default style. Like extensions, it's up to the application
3213 * developer to write the theme for the widgets it wants, the difference
3214 * being that when looking for the theme, Elementary will check first the
3215 * list of overlays, then the set theme and lastly the list of extensions,
3216 * so with overlays it's possible to replace the default view and every
3217 * widget will be affected. This is very much alike to setting the whole
3218 * theme for the application and will probably clash with the end user
3219 * options, not to mention the risk of ending up with not matching styles
3220 * across the program. Unless there's a very special reason to use them,
3221 * overlays should be avoided for the resons exposed before.
3223 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3224 * keeps one default internally and every function that receives one of
3225 * these can be called with NULL to refer to this default (except for
3226 * elm_theme_free()). It's possible to create a new instance of a
3227 * ::Elm_Theme to set other theme for a specific widget (and all of its
3228 * children), but this is as discouraged, if not even more so, than using
3229 * overlays. Don't use this unless you really know what you are doing.
3231 * But to be less negative about things, you can look at the following
3233 * @li @ref theme_example_01 "Using extensions"
3234 * @li @ref theme_example_02 "Using overlays"
3239 * @typedef Elm_Theme
3241 * Opaque handler for the list of themes Elementary looks for when
3242 * rendering widgets.
3244 * Stay out of this unless you really know what you are doing. For most
3245 * cases, sticking to the default is all a developer needs.
3247 typedef struct _Elm_Theme Elm_Theme;
3250 * Create a new specific theme
3252 * This creates an empty specific theme that only uses the default theme. A
3253 * specific theme has its own private set of extensions and overlays too
3254 * (which are empty by default). Specific themes do not fall back to themes
3255 * of parent objects. They are not intended for this use. Use styles, overlays
3256 * and extensions when needed, but avoid specific themes unless there is no
3257 * other way (example: you want to have a preview of a new theme you are
3258 * selecting in a "theme selector" window. The preview is inside a scroller
3259 * and should display what the theme you selected will look like, but not
3260 * actually apply it yet. The child of the scroller will have a specific
3261 * theme set to show this preview before the user decides to apply it to all
3264 EAPI Elm_Theme *elm_theme_new(void);
3266 * Free a specific theme
3268 * @param th The theme to free
3270 * This frees a theme created with elm_theme_new().
3272 EAPI void elm_theme_free(Elm_Theme *th);
3274 * Copy the theme fom the source to the destination theme
3276 * @param th The source theme to copy from
3277 * @param thdst The destination theme to copy data to
3279 * This makes a one-time static copy of all the theme config, extensions
3280 * and overlays from @p th to @p thdst. If @p th references a theme, then
3281 * @p thdst is also set to reference it, with all the theme settings,
3282 * overlays and extensions that @p th had.
3284 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3286 * Tell the source theme to reference the ref theme
3288 * @param th The theme that will do the referencing
3289 * @param thref The theme that is the reference source
3291 * This clears @p th to be empty and then sets it to refer to @p thref
3292 * so @p th acts as an override to @p thref, but where its overrides
3293 * don't apply, it will fall through to @p thref for configuration.
3295 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3297 * Return the theme referred to
3299 * @param th The theme to get the reference from
3300 * @return The referenced theme handle
3302 * This gets the theme set as the reference theme by elm_theme_ref_set().
3303 * If no theme is set as a reference, NULL is returned.
3305 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3307 * Return the default theme
3309 * @return The default theme handle
3311 * This returns the internal default theme setup handle that all widgets
3312 * use implicitly unless a specific theme is set. This is also often use
3313 * as a shorthand of NULL.
3315 EAPI Elm_Theme *elm_theme_default_get(void);
3317 * Prepends a theme overlay to the list of overlays
3319 * @param th The theme to add to, or if NULL, the default theme
3320 * @param item The Edje file path to be used
3322 * Use this if your application needs to provide some custom overlay theme
3323 * (An Edje file that replaces some default styles of widgets) where adding
3324 * new styles, or changing system theme configuration is not possible. Do
3325 * NOT use this instead of a proper system theme configuration. Use proper
3326 * configuration files, profiles, environment variables etc. to set a theme
3327 * so that the theme can be altered by simple confiugration by a user. Using
3328 * this call to achieve that effect is abusing the API and will create lots
3331 * @see elm_theme_extension_add()
3333 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3335 * Delete a theme overlay from the list of overlays
3337 * @param th The theme to delete from, or if NULL, the default theme
3338 * @param item The name of the theme overlay
3340 * @see elm_theme_overlay_add()
3342 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3344 * Appends a theme extension to the list of extensions.
3346 * @param th The theme to add to, or if NULL, the default theme
3347 * @param item The Edje file path to be used
3349 * This is intended when an application needs more styles of widgets or new
3350 * widget themes that the default does not provide (or may not provide). The
3351 * application has "extended" usage by coming up with new custom style names
3352 * for widgets for specific uses, but as these are not "standard", they are
3353 * not guaranteed to be provided by a default theme. This means the
3354 * application is required to provide these extra elements itself in specific
3355 * Edje files. This call adds one of those Edje files to the theme search
3356 * path to be search after the default theme. The use of this call is
3357 * encouraged when default styles do not meet the needs of the application.
3358 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3360 * @see elm_object_style_set()
3362 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3364 * Deletes a theme extension from the list of extensions.
3366 * @param th The theme to delete from, or if NULL, the default theme
3367 * @param item The name of the theme extension
3369 * @see elm_theme_extension_add()
3371 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3373 * Set the theme search order for the given theme
3375 * @param th The theme to set the search order, or if NULL, the default theme
3376 * @param theme Theme search string
3378 * This sets the search string for the theme in path-notation from first
3379 * theme to search, to last, delimited by the : character. Example:
3381 * "shiny:/path/to/file.edj:default"
3383 * See the ELM_THEME environment variable for more information.
3385 * @see elm_theme_get()
3386 * @see elm_theme_list_get()
3388 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3390 * Return the theme search order
3392 * @param th The theme to get the search order, or if NULL, the default theme
3393 * @return The internal search order path
3395 * This function returns a colon separated string of theme elements as
3396 * returned by elm_theme_list_get().
3398 * @see elm_theme_set()
3399 * @see elm_theme_list_get()
3401 EAPI const char *elm_theme_get(Elm_Theme *th);
3403 * Return a list of theme elements to be used in a theme.
3405 * @param th Theme to get the list of theme elements from.
3406 * @return The internal list of theme elements
3408 * This returns the internal list of theme elements (will only be valid as
3409 * long as the theme is not modified by elm_theme_set() or theme is not
3410 * freed by elm_theme_free(). This is a list of strings which must not be
3411 * altered as they are also internal. If @p th is NULL, then the default
3412 * theme element list is returned.
3414 * A theme element can consist of a full or relative path to a .edj file,
3415 * or a name, without extension, for a theme to be searched in the known
3416 * theme paths for Elemementary.
3418 * @see elm_theme_set()
3419 * @see elm_theme_get()
3421 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3423 * Return the full patrh for a theme element
3425 * @param f The theme element name
3426 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3427 * @return The full path to the file found.
3429 * This returns a string you should free with free() on success, NULL on
3430 * failure. This will search for the given theme element, and if it is a
3431 * full or relative path element or a simple searchable name. The returned
3432 * path is the full path to the file, if searched, and the file exists, or it
3433 * is simply the full path given in the element or a resolved path if
3434 * relative to home. The @p in_search_path boolean pointed to is set to
3435 * EINA_TRUE if the file was a searchable file andis in the search path,
3436 * and EINA_FALSE otherwise.
3438 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3440 * Flush the current theme.
3442 * @param th Theme to flush
3444 * This flushes caches that let elementary know where to find theme elements
3445 * in the given theme. If @p th is NULL, then the default theme is flushed.
3446 * Call this function if source theme data has changed in such a way as to
3447 * make any caches Elementary kept invalid.
3449 EAPI void elm_theme_flush(Elm_Theme *th);
3451 * This flushes all themes (default and specific ones).
3453 * This will flush all themes in the current application context, by calling
3454 * elm_theme_flush() on each of them.
3456 EAPI void elm_theme_full_flush(void);
3458 * Set the theme for all elementary using applications on the current display
3460 * @param theme The name of the theme to use. Format same as the ELM_THEME
3461 * environment variable.
3463 EAPI void elm_theme_all_set(const char *theme);
3465 * Return a list of theme elements in the theme search path
3467 * @return A list of strings that are the theme element names.
3469 * This lists all available theme files in the standard Elementary search path
3470 * for theme elements, and returns them in alphabetical order as theme
3471 * element names in a list of strings. Free this with
3472 * elm_theme_name_available_list_free() when you are done with the list.
3474 EAPI Eina_List *elm_theme_name_available_list_new(void);
3476 * Free the list returned by elm_theme_name_available_list_new()
3478 * This frees the list of themes returned by
3479 * elm_theme_name_available_list_new(). Once freed the list should no longer
3480 * be used. a new list mys be created.
3482 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3484 * Set a specific theme to be used for this object and its children
3486 * @param obj The object to set the theme on
3487 * @param th The theme to set
3489 * This sets a specific theme that will be used for the given object and any
3490 * child objects it has. If @p th is NULL then the theme to be used is
3491 * cleared and the object will inherit its theme from its parent (which
3492 * ultimately will use the default theme if no specific themes are set).
3494 * Use special themes with great care as this will annoy users and make
3495 * configuration difficult. Avoid any custom themes at all if it can be
3498 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3500 * Get the specific theme to be used
3502 * @param obj The object to get the specific theme from
3503 * @return The specifc theme set.
3505 * This will return a specific theme set, or NULL if no specific theme is
3506 * set on that object. It will not return inherited themes from parents, only
3507 * the specific theme set for that specific object. See elm_object_theme_set()
3508 * for more information.
3510 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3513 * Get a data item from a theme
3515 * @param th The theme, or NULL for default theme
3516 * @param key The data key to search with
3517 * @return The data value, or NULL on failure
3519 * This function is used to return data items from edc in @p th, an overlay, or an extension.
3520 * It works the same way as edje_file_data_get() except that the return is stringshared.
3522 EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3528 /** @defgroup Win Win
3530 * @image html img/widget/win/preview-00.png
3531 * @image latex img/widget/win/preview-00.eps
3533 * The window class of Elementary. Contains functions to manipulate
3534 * windows. The Evas engine used to render the window contents is specified
3535 * in the system or user elementary config files (whichever is found last),
3536 * and can be overridden with the ELM_ENGINE environment variable for
3537 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3538 * compilation setup and modules actually installed at runtime) are (listed
3539 * in order of best supported and most likely to be complete and work to
3542 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3543 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3545 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3547 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3549 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3551 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3552 * rendering using SDL as the buffer)
3553 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3554 * GDI with software)
3555 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3556 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3557 * grayscale using dedicated 8bit software engine in X11)
3558 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3559 * X11 using 16bit software engine)
3560 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3561 * (Windows CE rendering via GDI with 16bit software renderer)
3562 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3563 * buffer with 16bit software renderer)
3564 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3566 * All engines use a simple string to select the engine to render, EXCEPT
3567 * the "shot" engine. This actually encodes the output of the virtual
3568 * screenshot and how long to delay in the engine string. The engine string
3569 * is encoded in the following way:
3571 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3573 * Where options are separated by a ":" char if more than one option is
3574 * given, with delay, if provided being the first option and file the last
3575 * (order is important). The delay specifies how long to wait after the
3576 * window is shown before doing the virtual "in memory" rendering and then
3577 * save the output to the file specified by the file option (and then exit).
3578 * If no delay is given, the default is 0.5 seconds. If no file is given the
3579 * default output file is "out.png". Repeat option is for continous
3580 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3581 * fixed to "out001.png" Some examples of using the shot engine:
3583 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3584 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3585 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3586 * ELM_ENGINE="shot:delay=2.0" elementary_test
3587 * ELM_ENGINE="shot:" elementary_test
3589 * Signals that you can add callbacks for are:
3591 * @li "delete,request": the user requested to close the window. See
3592 * elm_win_autodel_set().
3593 * @li "focus,in": window got focus
3594 * @li "focus,out": window lost focus
3595 * @li "moved": window that holds the canvas was moved
3598 * @li @ref win_example_01
3603 * Defines the types of window that can be created
3605 * These are hints set on the window so that a running Window Manager knows
3606 * how the window should be handled and/or what kind of decorations it
3609 * Currently, only the X11 backed engines use them.
3611 typedef enum _Elm_Win_Type
3613 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3614 window. Almost every window will be created with this
3616 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3617 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3618 window holding desktop icons. */
3619 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3620 be kept on top of any other window by the Window
3622 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3624 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3625 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3627 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3628 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3629 entry in a menubar is clicked. Typically used
3630 with elm_win_override_set(). This hint exists
3631 for completion only, as the EFL way of
3632 implementing a menu would not normally use a
3633 separate window for its contents. */
3634 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3635 triggered by right-clicking an object. */
3636 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3637 explanatory text that typically appear after the
3638 mouse cursor hovers over an object for a while.
3639 Typically used with elm_win_override_set() and also
3640 not very commonly used in the EFL. */
3641 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3642 battery life or a new E-Mail received. */
3643 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3644 usually used in the EFL. */
3645 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3646 object being dragged across different windows, or even
3647 applications. Typically used with
3648 elm_win_override_set(). */
3649 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3650 buffer. No actual window is created for this
3651 type, instead the window and all of its
3652 contents will be rendered to an image buffer.
3653 This allows to have children window inside a
3654 parent one just like any other object would
3655 be, and do other things like applying @c
3656 Evas_Map effects to it. This is the only type
3657 of window that requires the @c parent
3658 parameter of elm_win_add() to be a valid @c
3663 * The differents layouts that can be requested for the virtual keyboard.
3665 * When the application window is being managed by Illume, it may request
3666 * any of the following layouts for the virtual keyboard.
3668 typedef enum _Elm_Win_Keyboard_Mode
3670 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3671 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3672 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3673 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3674 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3675 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3676 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3677 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3678 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3679 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3680 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3681 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3682 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3683 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3684 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3685 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3686 } Elm_Win_Keyboard_Mode;
3689 * Available commands that can be sent to the Illume manager.
3691 * When running under an Illume session, a window may send commands to the
3692 * Illume manager to perform different actions.
3694 typedef enum _Elm_Illume_Command
3696 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3698 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3700 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3702 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3703 } Elm_Illume_Command;
3706 * Adds a window object. If this is the first window created, pass NULL as
3709 * @param parent Parent object to add the window to, or NULL
3710 * @param name The name of the window
3711 * @param type The window type, one of #Elm_Win_Type.
3713 * The @p parent paramter can be @c NULL for every window @p type except
3714 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3715 * which the image object will be created.
3717 * @return The created object, or NULL on failure
3719 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3721 * Add @p subobj as a resize object of window @p obj.
3724 * Setting an object as a resize object of the window means that the
3725 * @p subobj child's size and position will be controlled by the window
3726 * directly. That is, the object will be resized to match the window size
3727 * and should never be moved or resized manually by the developer.
3729 * In addition, resize objects of the window control what the minimum size
3730 * of it will be, as well as whether it can or not be resized by the user.
3732 * For the end user to be able to resize a window by dragging the handles
3733 * or borders provided by the Window Manager, or using any other similar
3734 * mechanism, all of the resize objects in the window should have their
3735 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3737 * @param obj The window object
3738 * @param subobj The resize object to add
3740 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3742 * Delete @p subobj as a resize object of window @p obj.
3744 * This function removes the object @p subobj from the resize objects of
3745 * the window @p obj. It will not delete the object itself, which will be
3746 * left unmanaged and should be deleted by the developer, manually handled
3747 * or set as child of some other container.
3749 * @param obj The window object
3750 * @param subobj The resize object to add
3752 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3754 * Set the title of the window
3756 * @param obj The window object
3757 * @param title The title to set
3759 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3761 * Get the title of the window
3763 * The returned string is an internal one and should not be freed or
3764 * modified. It will also be rendered invalid if a new title is set or if
3765 * the window is destroyed.
3767 * @param obj The window object
3770 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3772 * Set the window's autodel state.
3774 * When closing the window in any way outside of the program control, like
3775 * pressing the X button in the titlebar or using a command from the
3776 * Window Manager, a "delete,request" signal is emitted to indicate that
3777 * this event occurred and the developer can take any action, which may
3778 * include, or not, destroying the window object.
3780 * When the @p autodel parameter is set, the window will be automatically
3781 * destroyed when this event occurs, after the signal is emitted.
3782 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3783 * and is up to the program to do so when it's required.
3785 * @param obj The window object
3786 * @param autodel If true, the window will automatically delete itself when
3789 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3791 * Get the window's autodel state.
3793 * @param obj The window object
3794 * @return If the window will automatically delete itself when closed
3796 * @see elm_win_autodel_set()
3798 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3800 * Activate a window object.
3802 * This function sends a request to the Window Manager to activate the
3803 * window pointed by @p obj. If honored by the WM, the window will receive
3804 * the keyboard focus.
3806 * @note This is just a request that a Window Manager may ignore, so calling
3807 * this function does not ensure in any way that the window will be the
3808 * active one after it.
3810 * @param obj The window object
3812 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3814 * Lower a window object.
3816 * Places the window pointed by @p obj at the bottom of the stack, so that
3817 * no other window is covered by it.
3819 * If elm_win_override_set() is not set, the Window Manager may ignore this
3822 * @param obj The window object
3824 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3826 * Raise a window object.
3828 * Places the window pointed by @p obj at the top of the stack, so that it's
3829 * not covered by any other window.
3831 * If elm_win_override_set() is not set, the Window Manager may ignore this
3834 * @param obj The window object
3836 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3838 * Set the borderless state of a window.
3840 * This function requests the Window Manager to not draw any decoration
3841 * around the window.
3843 * @param obj The window object
3844 * @param borderless If true, the window is borderless
3846 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3848 * Get the borderless state of a window.
3850 * @param obj The window object
3851 * @return If true, the window is borderless
3853 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3855 * Set the shaped state of a window.
3857 * Shaped windows, when supported, will render the parts of the window that
3858 * has no content, transparent.
3860 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3861 * background object or cover the entire window in any other way, or the
3862 * parts of the canvas that have no data will show framebuffer artifacts.
3864 * @param obj The window object
3865 * @param shaped If true, the window is shaped
3867 * @see elm_win_alpha_set()
3869 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3871 * Get the shaped state of a window.
3873 * @param obj The window object
3874 * @return If true, the window is shaped
3876 * @see elm_win_shaped_set()
3878 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3880 * Set the alpha channel state of a window.
3882 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3883 * possibly making parts of the window completely or partially transparent.
3884 * This is also subject to the underlying system supporting it, like for
3885 * example, running under a compositing manager. If no compositing is
3886 * available, enabling this option will instead fallback to using shaped
3887 * windows, with elm_win_shaped_set().
3889 * @param obj The window object
3890 * @param alpha If true, the window has an alpha channel
3892 * @see elm_win_alpha_set()
3894 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3896 * Get the transparency state of a window.
3898 * @param obj The window object
3899 * @return If true, the window is transparent
3901 * @see elm_win_transparent_set()
3903 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3905 * Set the transparency state of a window.
3907 * Use elm_win_alpha_set() instead.
3909 * @param obj The window object
3910 * @param transparent If true, the window is transparent
3912 * @see elm_win_alpha_set()
3914 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3916 * Get the alpha channel state of a window.
3918 * @param obj The window object
3919 * @return If true, the window has an alpha channel
3921 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3923 * Set the override state of a window.
3925 * A window with @p override set to EINA_TRUE will not be managed by the
3926 * Window Manager. This means that no decorations of any kind will be shown
3927 * for it, moving and resizing must be handled by the application, as well
3928 * as the window visibility.
3930 * This should not be used for normal windows, and even for not so normal
3931 * ones, it should only be used when there's a good reason and with a lot
3932 * of care. Mishandling override windows may result situations that
3933 * disrupt the normal workflow of the end user.
3935 * @param obj The window object
3936 * @param override If true, the window is overridden
3938 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3940 * Get the override state of a window.
3942 * @param obj The window object
3943 * @return If true, the window is overridden
3945 * @see elm_win_override_set()
3947 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3949 * Set the fullscreen state of a window.
3951 * @param obj The window object
3952 * @param fullscreen If true, the window is fullscreen
3954 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3956 * Get the fullscreen state of a window.
3958 * @param obj The window object
3959 * @return If true, the window is fullscreen
3961 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3963 * Set the maximized state of a window.
3965 * @param obj The window object
3966 * @param maximized If true, the window is maximized
3968 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3970 * Get the maximized state of a window.
3972 * @param obj The window object
3973 * @return If true, the window is maximized
3975 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3977 * Set the iconified state of a window.
3979 * @param obj The window object
3980 * @param iconified If true, the window is iconified
3982 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3984 * Get the iconified state of a window.
3986 * @param obj The window object
3987 * @return If true, the window is iconified
3989 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3991 * Set the layer of the window.
3993 * What this means exactly will depend on the underlying engine used.
3995 * In the case of X11 backed engines, the value in @p layer has the
3996 * following meanings:
3997 * @li < 3: The window will be placed below all others.
3998 * @li > 5: The window will be placed above all others.
3999 * @li other: The window will be placed in the default layer.
4001 * @param obj The window object
4002 * @param layer The layer of the window
4004 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4006 * Get the layer of the window.
4008 * @param obj The window object
4009 * @return The layer of the window
4011 * @see elm_win_layer_set()
4013 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4015 * Set the rotation of the window.
4017 * Most engines only work with multiples of 90.
4019 * This function is used to set the orientation of the window @p obj to
4020 * match that of the screen. The window itself will be resized to adjust
4021 * to the new geometry of its contents. If you want to keep the window size,
4022 * see elm_win_rotation_with_resize_set().
4024 * @param obj The window object
4025 * @param rotation The rotation of the window, in degrees (0-360),
4026 * counter-clockwise.
4028 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4030 * Rotates the window and resizes it.
4032 * Like elm_win_rotation_set(), but it also resizes the window's contents so
4033 * that they fit inside the current window geometry.
4035 * @param obj The window object
4036 * @param layer The rotation of the window in degrees (0-360),
4037 * counter-clockwise.
4039 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4041 * Get the rotation of the window.
4043 * @param obj The window object
4044 * @return The rotation of the window in degrees (0-360)
4046 * @see elm_win_rotation_set()
4047 * @see elm_win_rotation_with_resize_set()
4049 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4051 * Set the sticky state of the window.
4053 * Hints the Window Manager that the window in @p obj should be left fixed
4054 * at its position even when the virtual desktop it's on moves or changes.
4056 * @param obj The window object
4057 * @param sticky If true, the window's sticky state is enabled
4059 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4061 * Get the sticky state of the window.
4063 * @param obj The window object
4064 * @return If true, the window's sticky state is enabled
4066 * @see elm_win_sticky_set()
4068 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4070 * Set if this window is an illume conformant window
4072 * @param obj The window object
4073 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4075 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4077 * Get if this window is an illume conformant window
4079 * @param obj The window object
4080 * @return A boolean if this window is illume conformant or not
4082 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4084 * Set a window to be an illume quickpanel window
4086 * By default window objects are not quickpanel windows.
4088 * @param obj The window object
4089 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4091 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4093 * Get if this window is a quickpanel or not
4095 * @param obj The window object
4096 * @return A boolean if this window is a quickpanel or not
4098 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4100 * Set the major priority of a quickpanel window
4102 * @param obj The window object
4103 * @param priority The major priority for this quickpanel
4105 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4107 * Get the major priority of a quickpanel window
4109 * @param obj The window object
4110 * @return The major priority of this quickpanel
4112 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4114 * Set the minor priority of a quickpanel window
4116 * @param obj The window object
4117 * @param priority The minor priority for this quickpanel
4119 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4121 * Get the minor priority of a quickpanel window
4123 * @param obj The window object
4124 * @return The minor priority of this quickpanel
4126 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4128 * Set which zone this quickpanel should appear in
4130 * @param obj The window object
4131 * @param zone The requested zone for this quickpanel
4133 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4135 * Get which zone this quickpanel should appear in
4137 * @param obj The window object
4138 * @return The requested zone for this quickpanel
4140 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4142 * Set the window to be skipped by keyboard focus
4144 * This sets the window to be skipped by normal keyboard input. This means
4145 * a window manager will be asked to not focus this window as well as omit
4146 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4148 * Call this and enable it on a window BEFORE you show it for the first time,
4149 * otherwise it may have no effect.
4151 * Use this for windows that have only output information or might only be
4152 * interacted with by the mouse or fingers, and never for typing input.
4153 * Be careful that this may have side-effects like making the window
4154 * non-accessible in some cases unless the window is specially handled. Use
4157 * @param obj The window object
4158 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4160 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4162 * Send a command to the windowing environment
4164 * This is intended to work in touchscreen or small screen device
4165 * environments where there is a more simplistic window management policy in
4166 * place. This uses the window object indicated to select which part of the
4167 * environment to control (the part that this window lives in), and provides
4168 * a command and an optional parameter structure (use NULL for this if not
4171 * @param obj The window object that lives in the environment to control
4172 * @param command The command to send
4173 * @param params Optional parameters for the command
4175 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4177 * Get the inlined image object handle
4179 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4180 * then the window is in fact an evas image object inlined in the parent
4181 * canvas. You can get this object (be careful to not manipulate it as it
4182 * is under control of elementary), and use it to do things like get pixel
4183 * data, save the image to a file, etc.
4185 * @param obj The window object to get the inlined image from
4186 * @return The inlined image object, or NULL if none exists
4188 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4190 * Set the enabled status for the focus highlight in a window
4192 * This function will enable or disable the focus highlight only for the
4193 * given window, regardless of the global setting for it
4195 * @param obj The window where to enable the highlight
4196 * @param enabled The enabled value for the highlight
4198 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4200 * Get the enabled value of the focus highlight for this window
4202 * @param obj The window in which to check if the focus highlight is enabled
4204 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4206 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4208 * Set the style for the focus highlight on this window
4210 * Sets the style to use for theming the highlight of focused objects on
4211 * the given window. If @p style is NULL, the default will be used.
4213 * @param obj The window where to set the style
4214 * @param style The style to set
4216 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4218 * Get the style set for the focus highlight object
4220 * Gets the style set for this windows highilght object, or NULL if none
4223 * @param obj The window to retrieve the highlights style from
4225 * @return The style set or NULL if none was. Default is used in that case.
4227 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4228 EAPI void elm_win_indicator_state_set(Evas_Object *obj, int show_state);
4229 EAPI int elm_win_indicator_state_get(Evas_Object *obj);
4231 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4232 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4233 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4234 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4235 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4236 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4237 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4239 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4240 * (blank mouse, private mouse obj, defaultmouse)
4244 * Sets the keyboard mode of the window.
4246 * @param obj The window object
4247 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4249 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4251 * Gets the keyboard mode of the window.
4253 * @param obj The window object
4254 * @return The mode, one of #Elm_Win_Keyboard_Mode
4256 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4258 * Sets whether the window is a keyboard.
4260 * @param obj The window object
4261 * @param is_keyboard If true, the window is a virtual keyboard
4263 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4265 * Gets whether the window is a keyboard.
4267 * @param obj The window object
4268 * @return If the window is a virtual keyboard
4270 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4273 * Get the screen position of a window.
4275 * @param obj The window object
4276 * @param x The int to store the x coordinate to
4277 * @param y The int to store the y coordinate to
4279 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4285 * @defgroup Inwin Inwin
4287 * @image html img/widget/inwin/preview-00.png
4288 * @image latex img/widget/inwin/preview-00.eps
4289 * @image html img/widget/inwin/preview-01.png
4290 * @image latex img/widget/inwin/preview-01.eps
4291 * @image html img/widget/inwin/preview-02.png
4292 * @image latex img/widget/inwin/preview-02.eps
4294 * An inwin is a window inside a window that is useful for a quick popup.
4295 * It does not hover.
4297 * It works by creating an object that will occupy the entire window, so it
4298 * must be created using an @ref Win "elm_win" as parent only. The inwin
4299 * object can be hidden or restacked below every other object if it's
4300 * needed to show what's behind it without destroying it. If this is done,
4301 * the elm_win_inwin_activate() function can be used to bring it back to
4302 * full visibility again.
4304 * There are three styles available in the default theme. These are:
4305 * @li default: The inwin is sized to take over most of the window it's
4307 * @li minimal: The size of the inwin will be the minimum necessary to show
4309 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4310 * possible, but it's sized vertically the most it needs to fit its\
4313 * Some examples of Inwin can be found in the following:
4314 * @li @ref inwin_example_01
4319 * Adds an inwin to the current window
4321 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4322 * Never call this function with anything other than the top-most window
4323 * as its parameter, unless you are fond of undefined behavior.
4325 * After creating the object, the widget will set itself as resize object
4326 * for the window with elm_win_resize_object_add(), so when shown it will
4327 * appear to cover almost the entire window (how much of it depends on its
4328 * content and the style used). It must not be added into other container
4329 * objects and it needs not be moved or resized manually.
4331 * @param parent The parent object
4332 * @return The new object or NULL if it cannot be created
4334 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4336 * Activates an inwin object, ensuring its visibility
4338 * This function will make sure that the inwin @p obj is completely visible
4339 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4340 * to the front. It also sets the keyboard focus to it, which will be passed
4343 * The object's theme will also receive the signal "elm,action,show" with
4346 * @param obj The inwin to activate
4348 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4350 * Set the content of an inwin object.
4352 * Once the content object is set, a previously set one will be deleted.
4353 * If you want to keep that old content object, use the
4354 * elm_win_inwin_content_unset() function.
4356 * @param obj The inwin object
4357 * @param content The object to set as content
4359 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4361 * Get the content of an inwin object.
4363 * Return the content object which is set for this widget.
4365 * The returned object is valid as long as the inwin is still alive and no
4366 * other content is set on it. Deleting the object will notify the inwin
4367 * about it and this one will be left empty.
4369 * If you need to remove an inwin's content to be reused somewhere else,
4370 * see elm_win_inwin_content_unset().
4372 * @param obj The inwin object
4373 * @return The content that is being used
4375 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4377 * Unset the content of an inwin object.
4379 * Unparent and return the content object which was set for this widget.
4381 * @param obj The inwin object
4382 * @return The content that was being used
4384 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4388 /* X specific calls - won't work on non-x engines (return 0) */
4391 * Get the Ecore_X_Window of an Evas_Object
4393 * @param obj The object
4395 * @return The Ecore_X_Window of @p obj
4399 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4401 /* smart callbacks called:
4402 * "delete,request" - the user requested to delete the window
4403 * "focus,in" - window got focus
4404 * "focus,out" - window lost focus
4405 * "moved" - window that holds the canvas was moved
4411 * @image html img/widget/bg/preview-00.png
4412 * @image latex img/widget/bg/preview-00.eps
4414 * @brief Background object, used for setting a solid color, image or Edje
4415 * group as background to a window or any container object.
4417 * The bg object is used for setting a solid background to a window or
4418 * packing into any container object. It works just like an image, but has
4419 * some properties useful to a background, like setting it to tiled,
4420 * centered, scaled or stretched.
4422 * Default contents parts of the bg widget that you can use for are:
4423 * @li "elm.swallow.content" - overlay of the bg
4425 * Here is some sample code using it:
4426 * @li @ref bg_01_example_page
4427 * @li @ref bg_02_example_page
4428 * @li @ref bg_03_example_page
4432 typedef enum _Elm_Bg_Option
4434 ELM_BG_OPTION_CENTER, /**< center the background */
4435 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4436 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4437 ELM_BG_OPTION_TILE /**< tile background at its original size */
4441 * Add a new background to the parent
4443 * @param parent The parent object
4444 * @return The new object or NULL if it cannot be created
4448 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4451 * Set the file (image or edje) used for the background
4453 * @param obj The bg object
4454 * @param file The file path
4455 * @param group Optional key (group in Edje) within the file
4457 * This sets the image file used in the background object. The image (or edje)
4458 * will be stretched (retaining aspect if its an image file) to completely fill
4459 * the bg object. This may mean some parts are not visible.
4461 * @note Once the image of @p obj is set, a previously set one will be deleted,
4462 * even if @p file is NULL.
4466 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4469 * Get the file (image or edje) used for the background
4471 * @param obj The bg object
4472 * @param file The file path
4473 * @param group Optional key (group in Edje) within the file
4477 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4480 * Set the option used for the background image
4482 * @param obj The bg object
4483 * @param option The desired background option (TILE, SCALE)
4485 * This sets the option used for manipulating the display of the background
4486 * image. The image can be tiled or scaled.
4490 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4493 * Get the option used for the background image
4495 * @param obj The bg object
4496 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4500 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4502 * Set the option used for the background color
4504 * @param obj The bg object
4509 * This sets the color used for the background rectangle. Its range goes
4514 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4516 * Get the option used for the background color
4518 * @param obj The bg object
4525 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4528 * Set the overlay object used for the background object.
4530 * @param obj The bg object
4531 * @param overlay The overlay object
4533 * This provides a way for elm_bg to have an 'overlay' that will be on top
4534 * of the bg. Once the over object is set, a previously set one will be
4535 * deleted, even if you set the new one to NULL. If you want to keep that
4536 * old content object, use the elm_bg_overlay_unset() function.
4541 EINA_DEPRECATED EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4544 * Get the overlay object used for the background object.
4546 * @param obj The bg object
4547 * @return The content that is being used
4549 * Return the content object which is set for this widget
4553 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4556 * Get the overlay object used for the background object.
4558 * @param obj The bg object
4559 * @return The content that was being used
4561 * Unparent and return the overlay object which was set for this widget
4565 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4568 * Set the size of the pixmap representation of the image.
4570 * This option just makes sense if an image is going to be set in the bg.
4572 * @param obj The bg object
4573 * @param w The new width of the image pixmap representation.
4574 * @param h The new height of the image pixmap representation.
4576 * This function sets a new size for pixmap representation of the given bg
4577 * image. It allows the image to be loaded already in the specified size,
4578 * reducing the memory usage and load time when loading a big image with load
4579 * size set to a smaller size.
4581 * NOTE: this is just a hint, the real size of the pixmap may differ
4582 * depending on the type of image being loaded, being bigger than requested.
4586 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4587 /* smart callbacks called:
4591 * @defgroup Icon Icon
4593 * @image html img/widget/icon/preview-00.png
4594 * @image latex img/widget/icon/preview-00.eps
4596 * An object that provides standard icon images (delete, edit, arrows, etc.)
4597 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4599 * The icon image requested can be in the elementary theme, or in the
4600 * freedesktop.org paths. It's possible to set the order of preference from
4601 * where the image will be used.
4603 * This API is very similar to @ref Image, but with ready to use images.
4605 * Default images provided by the theme are described below.
4607 * The first list contains icons that were first intended to be used in
4608 * toolbars, but can be used in many other places too:
4624 * Now some icons that were designed to be used in menus (but again, you can
4625 * use them anywhere else):
4630 * @li menu/arrow_down
4631 * @li menu/arrow_left
4632 * @li menu/arrow_right
4641 * And here we have some media player specific icons:
4642 * @li media_player/forward
4643 * @li media_player/info
4644 * @li media_player/next
4645 * @li media_player/pause
4646 * @li media_player/play
4647 * @li media_player/prev
4648 * @li media_player/rewind
4649 * @li media_player/stop
4651 * Signals that you can add callbacks for are:
4653 * "clicked" - This is called when a user has clicked the icon
4655 * An example of usage for this API follows:
4656 * @li @ref tutorial_icon
4664 typedef enum _Elm_Icon_Type
4671 * @enum _Elm_Icon_Lookup_Order
4672 * @typedef Elm_Icon_Lookup_Order
4674 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4675 * theme, FDO paths, or both?
4679 typedef enum _Elm_Icon_Lookup_Order
4681 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4682 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4683 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4684 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4685 } Elm_Icon_Lookup_Order;
4688 * Add a new icon object to the parent.
4690 * @param parent The parent object
4691 * @return The new object or NULL if it cannot be created
4693 * @see elm_icon_file_set()
4697 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4699 * Set the file that will be used as icon.
4701 * @param obj The icon object
4702 * @param file The path to file that will be used as icon image
4703 * @param group The group that the icon belongs to an edje file
4705 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4707 * @note The icon image set by this function can be changed by
4708 * elm_icon_standard_set().
4710 * @see elm_icon_file_get()
4714 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4716 * Set a location in memory to be used as an icon
4718 * @param obj The icon object
4719 * @param img The binary data that will be used as an image
4720 * @param size The size of binary data @p img
4721 * @param format Optional format of @p img to pass to the image loader
4722 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4724 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4726 * @note The icon image set by this function can be changed by
4727 * elm_icon_standard_set().
4731 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);
4733 * Get the file that will be used as icon.
4735 * @param obj The icon object
4736 * @param file The path to file that will be used as the icon image
4737 * @param group The group that the icon belongs to, in edje file
4739 * @see elm_icon_file_set()
4743 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4744 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4746 * Set the icon by icon standards names.
4748 * @param obj The icon object
4749 * @param name The icon name
4751 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4753 * For example, freedesktop.org defines standard icon names such as "home",
4754 * "network", etc. There can be different icon sets to match those icon
4755 * keys. The @p name given as parameter is one of these "keys", and will be
4756 * used to look in the freedesktop.org paths and elementary theme. One can
4757 * change the lookup order with elm_icon_order_lookup_set().
4759 * If name is not found in any of the expected locations and it is the
4760 * absolute path of an image file, this image will be used.
4762 * @note The icon image set by this function can be changed by
4763 * elm_icon_file_set().
4765 * @see elm_icon_standard_get()
4766 * @see elm_icon_file_set()
4770 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4772 * Get the icon name set by icon standard names.
4774 * @param obj The icon object
4775 * @return The icon name
4777 * If the icon image was set using elm_icon_file_set() instead of
4778 * elm_icon_standard_set(), then this function will return @c NULL.
4780 * @see elm_icon_standard_set()
4784 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4786 * Set the smooth scaling for an icon object.
4788 * @param obj The icon object
4789 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4790 * otherwise. Default is @c EINA_TRUE.
4792 * Set the scaling algorithm to be used when scaling the icon image. Smooth
4793 * scaling provides a better resulting image, but is slower.
4795 * The smooth scaling should be disabled when making animations that change
4796 * the icon size, since they will be faster. Animations that don't require
4797 * resizing of the icon can keep the smooth scaling enabled (even if the icon
4798 * is already scaled, since the scaled icon image will be cached).
4800 * @see elm_icon_smooth_get()
4804 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4806 * Get whether smooth scaling is enabled for an icon object.
4808 * @param obj The icon object
4809 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4811 * @see elm_icon_smooth_set()
4815 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4817 * Disable scaling of this object.
4819 * @param obj The icon object.
4820 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4821 * otherwise. Default is @c EINA_FALSE.
4823 * This function disables scaling of the icon object through the function
4824 * elm_object_scale_set(). However, this does not affect the object
4825 * size/resize in any way. For that effect, take a look at
4826 * elm_icon_scale_set().
4828 * @see elm_icon_no_scale_get()
4829 * @see elm_icon_scale_set()
4830 * @see elm_object_scale_set()
4834 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4836 * Get whether scaling is disabled on the object.
4838 * @param obj The icon object
4839 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4841 * @see elm_icon_no_scale_set()
4845 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4847 * Set if the object is (up/down) resizable.
4849 * @param obj The icon object
4850 * @param scale_up A bool to set if the object is resizable up. Default is
4852 * @param scale_down A bool to set if the object is resizable down. Default
4855 * This function limits the icon object resize ability. If @p scale_up is set to
4856 * @c EINA_FALSE, the object can't have its height or width resized to a value
4857 * higher than the original icon size. Same is valid for @p scale_down.
4859 * @see elm_icon_scale_get()
4863 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4865 * Get if the object is (up/down) resizable.
4867 * @param obj The icon object
4868 * @param scale_up A bool to set if the object is resizable up
4869 * @param scale_down A bool to set if the object is resizable down
4871 * @see elm_icon_scale_set()
4875 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4877 * Get the object's image size
4879 * @param obj The icon object
4880 * @param w A pointer to store the width in
4881 * @param h A pointer to store the height in
4885 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4887 * Set if the icon fill the entire object area.
4889 * @param obj The icon object
4890 * @param fill_outside @c EINA_TRUE if the object is filled outside,
4891 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4893 * When the icon object is resized to a different aspect ratio from the
4894 * original icon image, the icon image will still keep its aspect. This flag
4895 * tells how the image should fill the object's area. They are: keep the
4896 * entire icon inside the limits of height and width of the object (@p
4897 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4898 * of the object, and the icon will fill the entire object (@p fill_outside
4901 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4902 * retain property to false. Thus, the icon image will always keep its
4903 * original aspect ratio.
4905 * @see elm_icon_fill_outside_get()
4906 * @see elm_image_fill_outside_set()
4910 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4912 * Get if the object is filled outside.
4914 * @param obj The icon object
4915 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4917 * @see elm_icon_fill_outside_set()
4921 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4923 * Set the prescale size for the icon.
4925 * @param obj The icon object
4926 * @param size The prescale size. This value is used for both width and
4929 * This function sets a new size for pixmap representation of the given
4930 * icon. It allows the icon to be loaded already in the specified size,
4931 * reducing the memory usage and load time when loading a big icon with load
4932 * size set to a smaller size.
4934 * It's equivalent to the elm_bg_load_size_set() function for bg.
4936 * @note this is just a hint, the real size of the pixmap may differ
4937 * depending on the type of icon being loaded, being bigger than requested.
4939 * @see elm_icon_prescale_get()
4940 * @see elm_bg_load_size_set()
4944 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4946 * Get the prescale size for the icon.
4948 * @param obj The icon object
4949 * @return The prescale size
4951 * @see elm_icon_prescale_set()
4955 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4957 * Gets the image object of the icon. DO NOT MODIFY THIS.
4959 * @param obj The icon object
4960 * @return The internal icon object
4964 EAPI Evas_Object *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4966 * Sets the icon lookup order used by elm_icon_standard_set().
4968 * @param obj The icon object
4969 * @param order The icon lookup order (can be one of
4970 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
4971 * or ELM_ICON_LOOKUP_THEME)
4973 * @see elm_icon_order_lookup_get()
4974 * @see Elm_Icon_Lookup_Order
4978 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4980 * Gets the icon lookup order.
4982 * @param obj The icon object
4983 * @return The icon lookup order
4985 * @see elm_icon_order_lookup_set()
4986 * @see Elm_Icon_Lookup_Order
4990 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4992 * Get if the icon supports animation or not.
4994 * @param obj The icon object
4995 * @return @c EINA_TRUE if the icon supports animation,
4996 * @c EINA_FALSE otherwise.
4998 * Return if this elm icon's image can be animated. Currently Evas only
4999 * supports gif animation. If the return value is EINA_FALSE, other
5000 * elm_icon_animated_XXX APIs won't work.
5003 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5005 * Set animation mode of the icon.
5007 * @param obj The icon object
5008 * @param anim @c EINA_TRUE if the object do animation job,
5009 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5011 * Since the default animation mode is set to EINA_FALSE,
5012 * the icon is shown without animation.
5013 * This might be desirable when the application developer wants to show
5014 * a snapshot of the animated icon.
5015 * Set it to EINA_TRUE when the icon needs to be animated.
5018 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5020 * Get animation mode of the icon.
5022 * @param obj The icon object
5023 * @return The animation mode of the icon object
5024 * @see elm_icon_animated_set
5027 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5029 * Set animation play mode of the icon.
5031 * @param obj The icon object
5032 * @param play @c EINA_TRUE the object play animation images,
5033 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5035 * To play elm icon's animation, set play to EINA_TURE.
5036 * For example, you make gif player using this set/get API and click event.
5038 * 1. Click event occurs
5039 * 2. Check play flag using elm_icon_animaged_play_get
5040 * 3. If elm icon was playing, set play to EINA_FALSE.
5041 * Then animation will be stopped and vice versa
5044 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5046 * Get animation play mode of the icon.
5048 * @param obj The icon object
5049 * @return The play mode of the icon object
5051 * @see elm_icon_animated_play_get
5054 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5056 /* compatibility code to avoid API and ABI breaks */
5057 EINA_DEPRECATED EAPI extern inline void elm_icon_anim_set(Evas_Object *obj, Eina_Bool animated)
5059 elm_icon_animated_set(obj, animated);
5062 EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_get(const Evas_Object *obj)
5064 return elm_icon_animated_get(obj);
5067 EINA_DEPRECATED EAPI extern inline void elm_icon_anim_play_set(Evas_Object *obj, Eina_Bool play)
5069 elm_icon_animated_play_set(obj, play);
5072 EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_play_get(const Evas_Object *obj)
5074 return elm_icon_animated_play_get(obj);
5082 * @defgroup Image Image
5084 * @image html img/widget/image/preview-00.png
5085 * @image latex img/widget/image/preview-00.eps
5088 * An object that allows one to load an image file to it. It can be used
5089 * anywhere like any other elementary widget.
5091 * This widget provides most of the functionality provided from @ref Bg or @ref
5092 * Icon, but with a slightly different API (use the one that fits better your
5095 * The features not provided by those two other image widgets are:
5096 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5097 * @li change the object orientation with elm_image_orient_set();
5098 * @li and turning the image editable with elm_image_editable_set().
5100 * Signals that you can add callbacks for are:
5102 * @li @c "clicked" - This is called when a user has clicked the image
5104 * An example of usage for this API follows:
5105 * @li @ref tutorial_image
5114 * @enum _Elm_Image_Orient
5115 * @typedef Elm_Image_Orient
5117 * Possible orientation options for elm_image_orient_set().
5119 * @image html elm_image_orient_set.png
5120 * @image latex elm_image_orient_set.eps width=\textwidth
5124 typedef enum _Elm_Image_Orient
5126 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5127 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5128 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5129 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5130 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5131 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5132 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5133 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5137 * Add a new image to the parent.
5139 * @param parent The parent object
5140 * @return The new object or NULL if it cannot be created
5142 * @see elm_image_file_set()
5146 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5148 * Set the file that will be used as image.
5150 * @param obj The image object
5151 * @param file The path to file that will be used as image
5152 * @param group The group that the image belongs in edje file (if it's an
5155 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5157 * @see elm_image_file_get()
5161 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5163 * Get the file that will be used as image.
5165 * @param obj The image object
5166 * @param file The path to file
5167 * @param group The group that the image belongs in edje file
5169 * @see elm_image_file_set()
5173 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5175 * Set the smooth effect for an image.
5177 * @param obj The image object
5178 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5179 * otherwise. Default is @c EINA_TRUE.
5181 * Set the scaling algorithm to be used when scaling the image. Smooth
5182 * scaling provides a better resulting image, but is slower.
5184 * The smooth scaling should be disabled when making animations that change
5185 * the image size, since it will be faster. Animations that don't require
5186 * resizing of the image can keep the smooth scaling enabled (even if the
5187 * image is already scaled, since the scaled image will be cached).
5189 * @see elm_image_smooth_get()
5193 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5195 * Get the smooth effect for an image.
5197 * @param obj The image object
5198 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5200 * @see elm_image_smooth_get()
5204 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5207 * Gets the current size of the image.
5209 * @param obj The image object.
5210 * @param w Pointer to store width, or NULL.
5211 * @param h Pointer to store height, or NULL.
5213 * This is the real size of the image, not the size of the object.
5215 * On error, neither w or h will be written.
5219 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5221 * Disable scaling of this object.
5223 * @param obj The image object.
5224 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5225 * otherwise. Default is @c EINA_FALSE.
5227 * This function disables scaling of the elm_image widget through the
5228 * function elm_object_scale_set(). However, this does not affect the widget
5229 * size/resize in any way. For that effect, take a look at
5230 * elm_image_scale_set().
5232 * @see elm_image_no_scale_get()
5233 * @see elm_image_scale_set()
5234 * @see elm_object_scale_set()
5238 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5240 * Get whether scaling is disabled on the object.
5242 * @param obj The image object
5243 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5245 * @see elm_image_no_scale_set()
5249 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5251 * Set if the object is (up/down) resizable.
5253 * @param obj The image object
5254 * @param scale_up A bool to set if the object is resizable up. Default is
5256 * @param scale_down A bool to set if the object is resizable down. Default
5259 * This function limits the image resize ability. If @p scale_up is set to
5260 * @c EINA_FALSE, the object can't have its height or width resized to a value
5261 * higher than the original image size. Same is valid for @p scale_down.
5263 * @see elm_image_scale_get()
5267 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5269 * Get if the object is (up/down) resizable.
5271 * @param obj The image object
5272 * @param scale_up A bool to set if the object is resizable up
5273 * @param scale_down A bool to set if the object is resizable down
5275 * @see elm_image_scale_set()
5279 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5281 * Set if the image fills the entire object area, when keeping the aspect ratio.
5283 * @param obj The image object
5284 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5285 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5287 * When the image should keep its aspect ratio even if resized to another
5288 * aspect ratio, there are two possibilities to resize it: keep the entire
5289 * image inside the limits of height and width of the object (@p fill_outside
5290 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5291 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5293 * @note This option will have no effect if
5294 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5296 * @see elm_image_fill_outside_get()
5297 * @see elm_image_aspect_ratio_retained_set()
5301 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5303 * Get if the object is filled outside
5305 * @param obj The image object
5306 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5308 * @see elm_image_fill_outside_set()
5312 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5314 * Set the prescale size for the image
5316 * @param obj The image object
5317 * @param size The prescale size. This value is used for both width and
5320 * This function sets a new size for pixmap representation of the given
5321 * image. It allows the image to be loaded already in the specified size,
5322 * reducing the memory usage and load time when loading a big image with load
5323 * size set to a smaller size.
5325 * It's equivalent to the elm_bg_load_size_set() function for bg.
5327 * @note this is just a hint, the real size of the pixmap may differ
5328 * depending on the type of image being loaded, being bigger than requested.
5330 * @see elm_image_prescale_get()
5331 * @see elm_bg_load_size_set()
5335 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5337 * Get the prescale size for the image
5339 * @param obj The image object
5340 * @return The prescale size
5342 * @see elm_image_prescale_set()
5346 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5348 * Set the image orientation.
5350 * @param obj The image object
5351 * @param orient The image orientation @ref Elm_Image_Orient
5352 * Default is #ELM_IMAGE_ORIENT_NONE.
5354 * This function allows to rotate or flip the given image.
5356 * @see elm_image_orient_get()
5357 * @see @ref Elm_Image_Orient
5361 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5363 * Get the image orientation.
5365 * @param obj The image object
5366 * @return The image orientation @ref Elm_Image_Orient
5368 * @see elm_image_orient_set()
5369 * @see @ref Elm_Image_Orient
5373 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5375 * Make the image 'editable'.
5377 * @param obj Image object.
5378 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5380 * This means the image is a valid drag target for drag and drop, and can be
5381 * cut or pasted too.
5385 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5387 * Check if the image 'editable'.
5389 * @param obj Image object.
5390 * @return Editability.
5392 * A return value of EINA_TRUE means the image is a valid drag target
5393 * for drag and drop, and can be cut or pasted too.
5397 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5399 * Get the basic Evas_Image object from this object (widget).
5401 * @param obj The image object to get the inlined image from
5402 * @return The inlined image object, or NULL if none exists
5404 * This function allows one to get the underlying @c Evas_Object of type
5405 * Image from this elementary widget. It can be useful to do things like get
5406 * the pixel data, save the image to a file, etc.
5408 * @note Be careful to not manipulate it, as it is under control of
5413 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5415 * Set whether the original aspect ratio of the image should be kept on resize.
5417 * @param obj The image object.
5418 * @param retained @c EINA_TRUE if the image should retain the aspect,
5419 * @c EINA_FALSE otherwise.
5421 * The original aspect ratio (width / height) of the image is usually
5422 * distorted to match the object's size. Enabling this option will retain
5423 * this original aspect, and the way that the image is fit into the object's
5424 * area depends on the option set by elm_image_fill_outside_set().
5426 * @see elm_image_aspect_ratio_retained_get()
5427 * @see elm_image_fill_outside_set()
5431 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5433 * Get if the object retains the original aspect ratio.
5435 * @param obj The image object.
5436 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5441 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5448 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5450 /* old API compatibility */
5451 typedef Elm_GLView_Func_Cb Elm_GLView_Func;
5453 typedef enum _Elm_GLView_Mode
5455 ELM_GLVIEW_ALPHA = 1,
5456 ELM_GLVIEW_DEPTH = 2,
5457 ELM_GLVIEW_STENCIL = 4
5461 * Defines a policy for the glview resizing.
5463 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5465 typedef enum _Elm_GLView_Resize_Policy
5467 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5468 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5469 } Elm_GLView_Resize_Policy;
5471 typedef enum _Elm_GLView_Render_Policy
5473 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5474 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5475 } Elm_GLView_Render_Policy;
5480 * A simple GLView widget that allows GL rendering.
5482 * Signals that you can add callbacks for are:
5488 * Add a new glview to the parent
5490 * @param parent The parent object
5491 * @return The new object or NULL if it cannot be created
5495 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5498 * Sets the size of the glview
5500 * @param obj The glview object
5501 * @param width width of the glview object
5502 * @param height height of the glview object
5506 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5509 * Gets the size of the glview.
5511 * @param obj The glview object
5512 * @param width width of the glview object
5513 * @param height height of the glview object
5515 * Note that this function returns the actual image size of the
5516 * glview. This means that when the scale policy is set to
5517 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5522 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5525 * Gets the gl api struct for gl rendering
5527 * @param obj The glview object
5528 * @return The api object or NULL if it cannot be created
5532 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5535 * Set the mode of the GLView. Supports Three simple modes.
5537 * @param obj The glview object
5538 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5539 * @return True if set properly.
5543 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5546 * Set the resize policy for the glview object.
5548 * @param obj The glview object.
5549 * @param policy The scaling policy.
5551 * By default, the resize policy is set to
5552 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5553 * destroys the previous surface and recreates the newly specified
5554 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5555 * however, glview only scales the image object and not the underlying
5560 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5563 * Set the render policy for the glview object.
5565 * @param obj The glview object.
5566 * @param policy The render policy.
5568 * By default, the render policy is set to
5569 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5570 * that during the render loop, glview is only redrawn if it needs
5571 * to be redrawn. (i.e. When it is visible) If the policy is set to
5572 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5573 * whether it is visible/need redrawing or not.
5577 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5580 * Set the init function that runs once in the main loop.
5582 * @param obj The glview object.
5583 * @param func The init function to be registered.
5585 * The registered init function gets called once during the render loop.
5589 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5592 * Set the render function that runs in the main loop.
5594 * @param obj The glview object.
5595 * @param func The delete function to be registered.
5597 * The registered del function gets called when GLView object is deleted.
5601 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5604 * Set the resize function that gets called when resize happens.
5606 * @param obj The glview object.
5607 * @param func The resize function to be registered.
5611 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5614 * Set the render function that runs in the main loop.
5616 * @param obj The glview object.
5617 * @param func The render function to be registered.
5621 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5624 * Notifies that there has been changes in the GLView.
5626 * @param obj The glview object.
5630 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5640 * @image html img/widget/box/preview-00.png
5641 * @image latex img/widget/box/preview-00.eps width=\textwidth
5643 * @image html img/box.png
5644 * @image latex img/box.eps width=\textwidth
5646 * A box arranges objects in a linear fashion, governed by a layout function
5647 * that defines the details of this arrangement.
5649 * By default, the box will use an internal function to set the layout to
5650 * a single row, either vertical or horizontal. This layout is affected
5651 * by a number of parameters, such as the homogeneous flag set by
5652 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5653 * elm_box_align_set() and the hints set to each object in the box.
5655 * For this default layout, it's possible to change the orientation with
5656 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5657 * placing its elements ordered from top to bottom. When horizontal is set,
5658 * the order will go from left to right. If the box is set to be
5659 * homogeneous, every object in it will be assigned the same space, that
5660 * of the largest object. Padding can be used to set some spacing between
5661 * the cell given to each object. The alignment of the box, set with
5662 * elm_box_align_set(), determines how the bounding box of all the elements
5663 * will be placed within the space given to the box widget itself.
5665 * The size hints of each object also affect how they are placed and sized
5666 * within the box. evas_object_size_hint_min_set() will give the minimum
5667 * size the object can have, and the box will use it as the basis for all
5668 * latter calculations. Elementary widgets set their own minimum size as
5669 * needed, so there's rarely any need to use it manually.
5671 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5672 * used to tell whether the object will be allocated the minimum size it
5673 * needs or if the space given to it should be expanded. It's important
5674 * to realize that expanding the size given to the object is not the same
5675 * thing as resizing the object. It could very well end being a small
5676 * widget floating in a much larger empty space. If not set, the weight
5677 * for objects will normally be 0.0 for both axis, meaning the widget will
5678 * not be expanded. To take as much space possible, set the weight to
5679 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5681 * Besides how much space each object is allocated, it's possible to control
5682 * how the widget will be placed within that space using
5683 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5684 * for both axis, meaning the object will be centered, but any value from
5685 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5686 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5687 * is -1.0, means the object will be resized to fill the entire space it
5690 * In addition, customized functions to define the layout can be set, which
5691 * allow the application developer to organize the objects within the box
5692 * in any number of ways.
5694 * The special elm_box_layout_transition() function can be used
5695 * to switch from one layout to another, animating the motion of the
5696 * children of the box.
5698 * @note Objects should not be added to box objects using _add() calls.
5700 * Some examples on how to use boxes follow:
5701 * @li @ref box_example_01
5702 * @li @ref box_example_02
5707 * @typedef Elm_Box_Transition
5709 * Opaque handler containing the parameters to perform an animated
5710 * transition of the layout the box uses.
5712 * @see elm_box_transition_new()
5713 * @see elm_box_layout_set()
5714 * @see elm_box_layout_transition()
5716 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5719 * Add a new box to the parent
5721 * By default, the box will be in vertical mode and non-homogeneous.
5723 * @param parent The parent object
5724 * @return The new object or NULL if it cannot be created
5726 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5728 * Set the horizontal orientation
5730 * By default, box object arranges their contents vertically from top to
5732 * By calling this function with @p horizontal as EINA_TRUE, the box will
5733 * become horizontal, arranging contents from left to right.
5735 * @note This flag is ignored if a custom layout function is set.
5737 * @param obj The box object
5738 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5739 * EINA_FALSE = vertical)
5741 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5743 * Get the horizontal orientation
5745 * @param obj The box object
5746 * @return EINA_TRUE if the box is set to horizintal mode, EINA_FALSE otherwise
5748 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5750 * Set the box to arrange its children homogeneously
5752 * If enabled, homogeneous layout makes all items the same size, according
5753 * to the size of the largest of its children.
5755 * @note This flag is ignored if a custom layout function is set.
5757 * @param obj The box object
5758 * @param homogeneous The homogeneous flag
5760 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5762 * Get whether the box is using homogeneous mode or not
5764 * @param obj The box object
5765 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5767 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5768 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5769 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5771 * Add an object to the beginning of the pack list
5773 * Pack @p subobj into the box @p obj, placing it first in the list of
5774 * children objects. The actual position the object will get on screen
5775 * depends on the layout used. If no custom layout is set, it will be at
5776 * the top or left, depending if the box is vertical or horizontal,
5779 * @param obj The box object
5780 * @param subobj The object to add to the box
5782 * @see elm_box_pack_end()
5783 * @see elm_box_pack_before()
5784 * @see elm_box_pack_after()
5785 * @see elm_box_unpack()
5786 * @see elm_box_unpack_all()
5787 * @see elm_box_clear()
5789 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5791 * Add an object at the end of the pack list
5793 * Pack @p subobj into the box @p obj, placing it last in the list of
5794 * children objects. The actual position the object will get on screen
5795 * depends on the layout used. If no custom layout is set, it will be at
5796 * the bottom or right, depending if the box is vertical or horizontal,
5799 * @param obj The box object
5800 * @param subobj The object to add to the box
5802 * @see elm_box_pack_start()
5803 * @see elm_box_pack_before()
5804 * @see elm_box_pack_after()
5805 * @see elm_box_unpack()
5806 * @see elm_box_unpack_all()
5807 * @see elm_box_clear()
5809 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5811 * Adds an object to the box before the indicated object
5813 * This will add the @p subobj to the box indicated before the object
5814 * indicated with @p before. If @p before is not already in the box, results
5815 * are undefined. Before means either to the left of the indicated object or
5816 * above it depending on orientation.
5818 * @param obj The box object
5819 * @param subobj The object to add to the box
5820 * @param before The object before which to add it
5822 * @see elm_box_pack_start()
5823 * @see elm_box_pack_end()
5824 * @see elm_box_pack_after()
5825 * @see elm_box_unpack()
5826 * @see elm_box_unpack_all()
5827 * @see elm_box_clear()
5829 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5831 * Adds an object to the box after the indicated object
5833 * This will add the @p subobj to the box indicated after the object
5834 * indicated with @p after. If @p after is not already in the box, results
5835 * are undefined. After means either to the right of the indicated object or
5836 * below it depending on orientation.
5838 * @param obj The box object
5839 * @param subobj The object to add to the box
5840 * @param after The object after which to add it
5842 * @see elm_box_pack_start()
5843 * @see elm_box_pack_end()
5844 * @see elm_box_pack_before()
5845 * @see elm_box_unpack()
5846 * @see elm_box_unpack_all()
5847 * @see elm_box_clear()
5849 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5851 * Clear the box of all children
5853 * Remove all the elements contained by the box, deleting the respective
5856 * @param obj The box object
5858 * @see elm_box_unpack()
5859 * @see elm_box_unpack_all()
5861 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5865 * Remove the object given by @p subobj from the box @p obj without
5868 * @param obj The box object
5870 * @see elm_box_unpack_all()
5871 * @see elm_box_clear()
5873 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5875 * Remove all items from the box, without deleting them
5877 * Clear the box from all children, but don't delete the respective objects.
5878 * If no other references of the box children exist, the objects will never
5879 * be deleted, and thus the application will leak the memory. Make sure
5880 * when using this function that you hold a reference to all the objects
5881 * in the box @p obj.
5883 * @param obj The box object
5885 * @see elm_box_clear()
5886 * @see elm_box_unpack()
5888 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5890 * Retrieve a list of the objects packed into the box
5892 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5893 * The order of the list corresponds to the packing order the box uses.
5895 * You must free this list with eina_list_free() once you are done with it.
5897 * @param obj The box object
5899 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5901 * Set the space (padding) between the box's elements.
5903 * Extra space in pixels that will be added between a box child and its
5904 * neighbors after its containing cell has been calculated. This padding
5905 * is set for all elements in the box, besides any possible padding that
5906 * individual elements may have through their size hints.
5908 * @param obj The box object
5909 * @param horizontal The horizontal space between elements
5910 * @param vertical The vertical space between elements
5912 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5914 * Get the space (padding) between the box's elements.
5916 * @param obj The box object
5917 * @param horizontal The horizontal space between elements
5918 * @param vertical The vertical space between elements
5920 * @see elm_box_padding_set()
5922 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5924 * Set the alignment of the whole bouding box of contents.
5926 * Sets how the bounding box containing all the elements of the box, after
5927 * their sizes and position has been calculated, will be aligned within
5928 * the space given for the whole box widget.
5930 * @param obj The box object
5931 * @param horizontal The horizontal alignment of elements
5932 * @param vertical The vertical alignment of elements
5934 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5936 * Get the alignment of the whole bouding box of contents.
5938 * @param obj The box object
5939 * @param horizontal The horizontal alignment of elements
5940 * @param vertical The vertical alignment of elements
5942 * @see elm_box_align_set()
5944 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5947 * Set the layout defining function to be used by the box
5949 * Whenever anything changes that requires the box in @p obj to recalculate
5950 * the size and position of its elements, the function @p cb will be called
5951 * to determine what the layout of the children will be.
5953 * Once a custom function is set, everything about the children layout
5954 * is defined by it. The flags set by elm_box_horizontal_set() and
5955 * elm_box_homogeneous_set() no longer have any meaning, and the values
5956 * given by elm_box_padding_set() and elm_box_align_set() are up to this
5957 * layout function to decide if they are used and how. These last two
5958 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5959 * passed to @p cb. The @c Evas_Object the function receives is not the
5960 * Elementary widget, but the internal Evas Box it uses, so none of the
5961 * functions described here can be used on it.
5963 * Any of the layout functions in @c Evas can be used here, as well as the
5964 * special elm_box_layout_transition().
5966 * The final @p data argument received by @p cb is the same @p data passed
5967 * here, and the @p free_data function will be called to free it
5968 * whenever the box is destroyed or another layout function is set.
5970 * Setting @p cb to NULL will revert back to the default layout function.
5972 * @param obj The box object
5973 * @param cb The callback function used for layout
5974 * @param data Data that will be passed to layout function
5975 * @param free_data Function called to free @p data
5977 * @see elm_box_layout_transition()
5979 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);
5981 * Special layout function that animates the transition from one layout to another
5983 * Normally, when switching the layout function for a box, this will be
5984 * reflected immediately on screen on the next render, but it's also
5985 * possible to do this through an animated transition.
5987 * This is done by creating an ::Elm_Box_Transition and setting the box
5988 * layout to this function.
5992 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5993 * evas_object_box_layout_vertical, // start
5994 * NULL, // data for initial layout
5995 * NULL, // free function for initial data
5996 * evas_object_box_layout_horizontal, // end
5997 * NULL, // data for final layout
5998 * NULL, // free function for final data
5999 * anim_end, // will be called when animation ends
6000 * NULL); // data for anim_end function\
6001 * elm_box_layout_set(box, elm_box_layout_transition, t,
6002 * elm_box_transition_free);
6005 * @note This function can only be used with elm_box_layout_set(). Calling
6006 * it directly will not have the expected results.
6008 * @see elm_box_transition_new
6009 * @see elm_box_transition_free
6010 * @see elm_box_layout_set
6012 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6014 * Create a new ::Elm_Box_Transition to animate the switch of layouts
6016 * If you want to animate the change from one layout to another, you need
6017 * to set the layout function of the box to elm_box_layout_transition(),
6018 * passing as user data to it an instance of ::Elm_Box_Transition with the
6019 * necessary information to perform this animation. The free function to
6020 * set for the layout is elm_box_transition_free().
6022 * The parameters to create an ::Elm_Box_Transition sum up to how long
6023 * will it be, in seconds, a layout function to describe the initial point,
6024 * another for the final position of the children and one function to be
6025 * called when the whole animation ends. This last function is useful to
6026 * set the definitive layout for the box, usually the same as the end
6027 * layout for the animation, but could be used to start another transition.
6029 * @param start_layout The layout function that will be used to start the animation
6030 * @param start_layout_data The data to be passed the @p start_layout function
6031 * @param start_layout_free_data Function to free @p start_layout_data
6032 * @param end_layout The layout function that will be used to end the animation
6033 * @param end_layout_free_data The data to be passed the @p end_layout function
6034 * @param end_layout_free_data Function to free @p end_layout_data
6035 * @param transition_end_cb Callback function called when animation ends
6036 * @param transition_end_data Data to be passed to @p transition_end_cb
6037 * @return An instance of ::Elm_Box_Transition
6039 * @see elm_box_transition_new
6040 * @see elm_box_layout_transition
6042 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);
6044 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6046 * This function is mostly useful as the @c free_data parameter in
6047 * elm_box_layout_set() when elm_box_layout_transition().
6049 * @param data The Elm_Box_Transition instance to be freed.
6051 * @see elm_box_transition_new
6052 * @see elm_box_layout_transition
6054 EAPI void elm_box_transition_free(void *data);
6061 * @defgroup Button Button
6063 * @image html img/widget/button/preview-00.png
6064 * @image latex img/widget/button/preview-00.eps
6065 * @image html img/widget/button/preview-01.png
6066 * @image latex img/widget/button/preview-01.eps
6067 * @image html img/widget/button/preview-02.png
6068 * @image latex img/widget/button/preview-02.eps
6070 * This is a push-button. Press it and run some function. It can contain
6071 * a simple label and icon object and it also has an autorepeat feature.
6073 * This widgets emits the following signals:
6074 * @li "clicked": the user clicked the button (press/release).
6075 * @li "repeated": the user pressed the button without releasing it.
6076 * @li "pressed": button was pressed.
6077 * @li "unpressed": button was released after being pressed.
6078 * In all three cases, the @c event parameter of the callback will be
6081 * Also, defined in the default theme, the button has the following styles
6083 * @li default: a normal button.
6084 * @li anchor: Like default, but the button fades away when the mouse is not
6085 * over it, leaving only the text or icon.
6086 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6087 * continuous look across its options.
6088 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6090 * Default contents parts of the button widget that you can use for are:
6091 * @li "elm.swallow.content" - A icon of the button
6093 * Default text parts of the button widget that you can use for are:
6094 * @li "elm.text" - Label of the button
6096 * Follow through a complete example @ref button_example_01 "here".
6102 UIControlStateDefault,
6103 UIControlStateHighlighted,
6104 UIControlStateDisabled,
6105 UIControlStateFocused,
6106 UIControlStateReserved
6110 * Add a new button to the parent's canvas
6112 * @param parent The parent object
6113 * @return The new object or NULL if it cannot be created
6115 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6117 * Set the label used in the button
6119 * The passed @p label can be NULL to clean any existing text in it and
6120 * leave the button as an icon only object.
6122 * @param obj The button object
6123 * @param label The text will be written on the button
6124 * @deprecated use elm_object_text_set() instead.
6126 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6128 * Get the label set for the button
6130 * The string returned is an internal pointer and should not be freed or
6131 * altered. It will also become invalid when the button is destroyed.
6132 * The string returned, if not NULL, is a stringshare, so if you need to
6133 * keep it around even after the button is destroyed, you can use
6134 * eina_stringshare_ref().
6136 * @param obj The button object
6137 * @return The text set to the label, or NULL if nothing is set
6138 * @deprecated use elm_object_text_set() instead.
6140 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6142 * Set the label for each state of button
6144 * The passed @p label can be NULL to clean any existing text in it and
6145 * leave the button as an icon only object for the state.
6147 * @param obj The button object
6148 * @param label The text will be written on the button
6149 * @param state The state of button
6153 EINA_DEPRECATED EAPI void elm_button_label_set_for_state(Evas_Object *obj, const char *label, UIControlState state) EINA_ARG_NONNULL(1);
6155 * Get the label of button for each state
6157 * The string returned is an internal pointer and should not be freed or
6158 * altered. It will also become invalid when the button is destroyed.
6159 * The string returned, if not NULL, is a stringshare, so if you need to
6160 * keep it around even after the button is destroyed, you can use
6161 * eina_stringshare_ref().
6163 * @param obj The button object
6164 * @param state The state of button
6165 * @return The title of button for state
6169 EINA_DEPRECATED EAPI const char *elm_button_label_get_for_state(const Evas_Object *obj, UIControlState state) EINA_ARG_NONNULL(1);
6171 * Set the icon used for the button
6173 * Setting a new icon will delete any other that was previously set, making
6174 * any reference to them invalid. If you need to maintain the previous
6175 * object alive, unset it first with elm_button_icon_unset().
6177 * @param obj The button object
6178 * @param icon The icon object for the button
6180 EINA_DEPRECATED EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6182 * Get the icon used for the button
6184 * Return the icon object which is set for this widget. If the button is
6185 * destroyed or another icon is set, the returned object will be deleted
6186 * and any reference to it will be invalid.
6188 * @param obj The button object
6189 * @return The icon object that is being used
6191 * @see elm_button_icon_unset()
6193 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6195 * Remove the icon set without deleting it and return the object
6197 * This function drops the reference the button holds of the icon object
6198 * and returns this last object. It is used in case you want to remove any
6199 * icon, or set another one, without deleting the actual object. The button
6200 * will be left without an icon set.
6202 * @param obj The button object
6203 * @return The icon object that was being used
6205 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6207 * Turn on/off the autorepeat event generated when the button is kept pressed
6209 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6210 * signal when they are clicked.
6212 * When on, keeping a button pressed will continuously emit a @c repeated
6213 * signal until the button is released. The time it takes until it starts
6214 * emitting the signal is given by
6215 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6216 * new emission by elm_button_autorepeat_gap_timeout_set().
6218 * @param obj The button object
6219 * @param on A bool to turn on/off the event
6221 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6223 * Get whether the autorepeat feature is enabled
6225 * @param obj The button object
6226 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6228 * @see elm_button_autorepeat_set()
6230 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6232 * Set the initial timeout before the autorepeat event is generated
6234 * Sets the timeout, in seconds, since the button is pressed until the
6235 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6236 * won't be any delay and the even will be fired the moment the button is
6239 * @param obj The button object
6240 * @param t Timeout in seconds
6242 * @see elm_button_autorepeat_set()
6243 * @see elm_button_autorepeat_gap_timeout_set()
6245 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6247 * Get the initial timeout before the autorepeat event is generated
6249 * @param obj The button object
6250 * @return Timeout in seconds
6252 * @see elm_button_autorepeat_initial_timeout_set()
6254 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6256 * Set the interval between each generated autorepeat event
6258 * After the first @c repeated event is fired, all subsequent ones will
6259 * follow after a delay of @p t seconds for each.
6261 * @param obj The button object
6262 * @param t Interval in seconds
6264 * @see elm_button_autorepeat_initial_timeout_set()
6266 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6268 * Get the interval between each generated autorepeat event
6270 * @param obj The button object
6271 * @return Interval in seconds
6273 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6279 * @defgroup File_Selector_Button File Selector Button
6281 * @image html img/widget/fileselector_button/preview-00.png
6282 * @image latex img/widget/fileselector_button/preview-00.eps
6283 * @image html img/widget/fileselector_button/preview-01.png
6284 * @image latex img/widget/fileselector_button/preview-01.eps
6285 * @image html img/widget/fileselector_button/preview-02.png
6286 * @image latex img/widget/fileselector_button/preview-02.eps
6288 * This is a button that, when clicked, creates an Elementary
6289 * window (or inner window) <b> with a @ref Fileselector "file
6290 * selector widget" within</b>. When a file is chosen, the (inner)
6291 * window is closed and the button emits a signal having the
6292 * selected file as it's @c event_info.
6294 * This widget encapsulates operations on its internal file
6295 * selector on its own API. There is less control over its file
6296 * selector than that one would have instatiating one directly.
6298 * The following styles are available for this button:
6301 * @li @c "hoversel_vertical"
6302 * @li @c "hoversel_vertical_entry"
6304 * Smart callbacks one can register to:
6305 * - @c "file,chosen" - the user has selected a path, whose string
6306 * pointer comes as the @c event_info data (a stringshared
6309 * Here is an example on its usage:
6310 * @li @ref fileselector_button_example
6312 * @see @ref File_Selector_Entry for a similar widget.
6317 * Add a new file selector button widget to the given parent
6318 * Elementary (container) object
6320 * @param parent The parent object
6321 * @return a new file selector button widget handle or @c NULL, on
6324 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6327 * Set the label for a given file selector button widget
6329 * @param obj The file selector button widget
6330 * @param label The text label to be displayed on @p obj
6332 * @deprecated use elm_object_text_set() instead.
6334 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6337 * Get the label set for a given file selector button widget
6339 * @param obj The file selector button widget
6340 * @return The button label
6342 * @deprecated use elm_object_text_set() instead.
6344 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6347 * Set the icon on a given file selector button widget
6349 * @param obj The file selector button widget
6350 * @param icon The icon object for the button
6352 * Once the icon object is set, a previously set one will be
6353 * deleted. If you want to keep the latter, use the
6354 * elm_fileselector_button_icon_unset() function.
6356 * @see elm_fileselector_button_icon_get()
6358 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6361 * Get the icon set for a given file selector button widget
6363 * @param obj The file selector button widget
6364 * @return The icon object currently set on @p obj or @c NULL, if
6367 * @see elm_fileselector_button_icon_set()
6369 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6372 * Unset the icon used in a given file selector button widget
6374 * @param obj The file selector button widget
6375 * @return The icon object that was being used on @p obj or @c
6378 * Unparent and return the icon object which was set for this
6381 * @see elm_fileselector_button_icon_set()
6383 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6386 * Set the title for a given file selector button widget's window
6388 * @param obj The file selector button widget
6389 * @param title The title string
6391 * This will change the window's title, when the file selector pops
6392 * out after a click on the button. Those windows have the default
6393 * (unlocalized) value of @c "Select a file" as titles.
6395 * @note It will only take any effect if the file selector
6396 * button widget is @b not under "inwin mode".
6398 * @see elm_fileselector_button_window_title_get()
6400 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6403 * Get the title set for a given file selector button widget's
6406 * @param obj The file selector button widget
6407 * @return Title of the file selector button's window
6409 * @see elm_fileselector_button_window_title_get() for more details
6411 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6414 * Set the size of a given file selector button widget's window,
6415 * holding the file selector itself.
6417 * @param obj The file selector button widget
6418 * @param width The window's width
6419 * @param height The window's height
6421 * @note it will only take any effect if the file selector button
6422 * widget is @b not under "inwin mode". The default size for the
6423 * window (when applicable) is 400x400 pixels.
6425 * @see elm_fileselector_button_window_size_get()
6427 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6430 * Get the size of a given file selector button widget's window,
6431 * holding the file selector itself.
6433 * @param obj The file selector button widget
6434 * @param width Pointer into which to store the width value
6435 * @param height Pointer into which to store the height value
6437 * @note Use @c NULL pointers on the size values you're not
6438 * interested in: they'll be ignored by the function.
6440 * @see elm_fileselector_button_window_size_set(), for more details
6442 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6445 * Set the initial file system path for a given file selector
6448 * @param obj The file selector button widget
6449 * @param path The path string
6451 * It must be a <b>directory</b> path, which will have the contents
6452 * displayed initially in the file selector's view, when invoked
6453 * from @p obj. The default initial path is the @c "HOME"
6454 * environment variable's value.
6456 * @see elm_fileselector_button_path_get()
6458 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6461 * Get the initial file system path set for a given file selector
6464 * @param obj The file selector button widget
6465 * @return path The path string
6467 * @see elm_fileselector_button_path_set() for more details
6469 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6472 * Enable/disable a tree view in the given file selector button
6473 * widget's internal file selector
6475 * @param obj The file selector button widget
6476 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6479 * This has the same effect as elm_fileselector_expandable_set(),
6480 * but now applied to a file selector button's internal file
6483 * @note There's no way to put a file selector button's internal
6484 * file selector in "grid mode", as one may do with "pure" file
6487 * @see elm_fileselector_expandable_get()
6489 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6492 * Get whether tree view is enabled for the given file selector
6493 * button widget's internal file selector
6495 * @param obj The file selector button widget
6496 * @return @c EINA_TRUE if @p obj widget's internal file selector
6497 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6499 * @see elm_fileselector_expandable_set() for more details
6501 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6504 * Set whether a given file selector button widget's internal file
6505 * selector is to display folders only or the directory contents,
6508 * @param obj The file selector button widget
6509 * @param only @c EINA_TRUE to make @p obj widget's internal file
6510 * selector only display directories, @c EINA_FALSE to make files
6511 * to be displayed in it too
6513 * This has the same effect as elm_fileselector_folder_only_set(),
6514 * but now applied to a file selector button's internal file
6517 * @see elm_fileselector_folder_only_get()
6519 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6522 * Get whether a given file selector button widget's internal file
6523 * selector is displaying folders only or the directory contents,
6526 * @param obj The file selector button widget
6527 * @return @c EINA_TRUE if @p obj widget's internal file
6528 * selector is only displaying directories, @c EINA_FALSE if files
6529 * are being displayed in it too (and on errors)
6531 * @see elm_fileselector_button_folder_only_set() for more details
6533 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6536 * Enable/disable the file name entry box where the user can type
6537 * in a name for a file, in a given file selector button widget's
6538 * internal file selector.
6540 * @param obj The file selector button widget
6541 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6542 * file selector a "saving dialog", @c EINA_FALSE otherwise
6544 * This has the same effect as elm_fileselector_is_save_set(),
6545 * but now applied to a file selector button's internal file
6548 * @see elm_fileselector_is_save_get()
6550 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6553 * Get whether the given file selector button widget's internal
6554 * file selector is in "saving dialog" mode
6556 * @param obj The file selector button widget
6557 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6558 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6561 * @see elm_fileselector_button_is_save_set() for more details
6563 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6566 * Set whether a given file selector button widget's internal file
6567 * selector will raise an Elementary "inner window", instead of a
6568 * dedicated Elementary window. By default, it won't.
6570 * @param obj The file selector button widget
6571 * @param value @c EINA_TRUE to make it use an inner window, @c
6572 * EINA_TRUE to make it use a dedicated window
6574 * @see elm_win_inwin_add() for more information on inner windows
6575 * @see elm_fileselector_button_inwin_mode_get()
6577 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6580 * Get whether a given file selector button widget's internal file
6581 * selector will raise an Elementary "inner window", instead of a
6582 * dedicated Elementary window.
6584 * @param obj The file selector button widget
6585 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6586 * if it will use a dedicated window
6588 * @see elm_fileselector_button_inwin_mode_set() for more details
6590 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6597 * @defgroup File_Selector_Entry File Selector Entry
6599 * @image html img/widget/fileselector_entry/preview-00.png
6600 * @image latex img/widget/fileselector_entry/preview-00.eps
6602 * This is an entry made to be filled with or display a <b>file
6603 * system path string</b>. Besides the entry itself, the widget has
6604 * a @ref File_Selector_Button "file selector button" on its side,
6605 * which will raise an internal @ref Fileselector "file selector widget",
6606 * when clicked, for path selection aided by file system
6609 * This file selector may appear in an Elementary window or in an
6610 * inner window. When a file is chosen from it, the (inner) window
6611 * is closed and the selected file's path string is exposed both as
6612 * an smart event and as the new text on the entry.
6614 * This widget encapsulates operations on its internal file
6615 * selector on its own API. There is less control over its file
6616 * selector than that one would have instatiating one directly.
6618 * Smart callbacks one can register to:
6619 * - @c "changed" - The text within the entry was changed
6620 * - @c "activated" - The entry has had editing finished and
6621 * changes are to be "committed"
6622 * - @c "press" - The entry has been clicked
6623 * - @c "longpressed" - The entry has been clicked (and held) for a
6625 * - @c "clicked" - The entry has been clicked
6626 * - @c "clicked,double" - The entry has been double clicked
6627 * - @c "focused" - The entry has received focus
6628 * - @c "unfocused" - The entry has lost focus
6629 * - @c "selection,paste" - A paste action has occurred on the
6631 * - @c "selection,copy" - A copy action has occurred on the entry
6632 * - @c "selection,cut" - A cut action has occurred on the entry
6633 * - @c "unpressed" - The file selector entry's button was released
6634 * after being pressed.
6635 * - @c "file,chosen" - The user has selected a path via the file
6636 * selector entry's internal file selector, whose string pointer
6637 * comes as the @c event_info data (a stringshared string)
6639 * Here is an example on its usage:
6640 * @li @ref fileselector_entry_example
6642 * @see @ref File_Selector_Button for a similar widget.
6647 * Add a new file selector entry widget to the given parent
6648 * Elementary (container) object
6650 * @param parent The parent object
6651 * @return a new file selector entry widget handle or @c NULL, on
6654 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6657 * Set the label for a given file selector entry widget's button
6659 * @param obj The file selector entry widget
6660 * @param label The text label to be displayed on @p obj widget's
6663 * @deprecated use elm_object_text_set() instead.
6665 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6668 * Get the label set for a given file selector entry widget's button
6670 * @param obj The file selector entry widget
6671 * @return The widget button's label
6673 * @deprecated use elm_object_text_set() instead.
6675 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6678 * Set the icon on a given file selector entry widget's button
6680 * @param obj The file selector entry widget
6681 * @param icon The icon object for the entry's button
6683 * Once the icon object is set, a previously set one will be
6684 * deleted. If you want to keep the latter, use the
6685 * elm_fileselector_entry_button_icon_unset() function.
6687 * @see elm_fileselector_entry_button_icon_get()
6689 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6692 * Get the icon set for a given file selector entry widget's button
6694 * @param obj The file selector entry widget
6695 * @return The icon object currently set on @p obj widget's button
6696 * or @c NULL, if none is
6698 * @see elm_fileselector_entry_button_icon_set()
6700 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6703 * Unset the icon used in a given file selector entry widget's
6706 * @param obj The file selector entry widget
6707 * @return The icon object that was being used on @p obj widget's
6708 * button or @c NULL, on errors
6710 * Unparent and return the icon object which was set for this
6713 * @see elm_fileselector_entry_button_icon_set()
6715 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6718 * Set the title for a given file selector entry widget's window
6720 * @param obj The file selector entry widget
6721 * @param title The title string
6723 * This will change the window's title, when the file selector pops
6724 * out after a click on the entry's button. Those windows have the
6725 * default (unlocalized) value of @c "Select a file" as titles.
6727 * @note It will only take any effect if the file selector
6728 * entry widget is @b not under "inwin mode".
6730 * @see elm_fileselector_entry_window_title_get()
6732 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6735 * Get the title set for a given file selector entry widget's
6738 * @param obj The file selector entry widget
6739 * @return Title of the file selector entry's window
6741 * @see elm_fileselector_entry_window_title_get() for more details
6743 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6746 * Set the size of a given file selector entry widget's window,
6747 * holding the file selector itself.
6749 * @param obj The file selector entry widget
6750 * @param width The window's width
6751 * @param height The window's height
6753 * @note it will only take any effect if the file selector entry
6754 * widget is @b not under "inwin mode". The default size for the
6755 * window (when applicable) is 400x400 pixels.
6757 * @see elm_fileselector_entry_window_size_get()
6759 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6762 * Get the size of a given file selector entry widget's window,
6763 * holding the file selector itself.
6765 * @param obj The file selector entry widget
6766 * @param width Pointer into which to store the width value
6767 * @param height Pointer into which to store the height value
6769 * @note Use @c NULL pointers on the size values you're not
6770 * interested in: they'll be ignored by the function.
6772 * @see elm_fileselector_entry_window_size_set(), for more details
6774 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6777 * Set the initial file system path and the entry's path string for
6778 * a given file selector entry widget
6780 * @param obj The file selector entry widget
6781 * @param path The path string
6783 * It must be a <b>directory</b> path, which will have the contents
6784 * displayed initially in the file selector's view, when invoked
6785 * from @p obj. The default initial path is the @c "HOME"
6786 * environment variable's value.
6788 * @see elm_fileselector_entry_path_get()
6790 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6793 * Get the entry's path string for a given file selector entry
6796 * @param obj The file selector entry widget
6797 * @return path The path string
6799 * @see elm_fileselector_entry_path_set() for more details
6801 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6804 * Enable/disable a tree view in the given file selector entry
6805 * widget's internal file selector
6807 * @param obj The file selector entry widget
6808 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6811 * This has the same effect as elm_fileselector_expandable_set(),
6812 * but now applied to a file selector entry's internal file
6815 * @note There's no way to put a file selector entry's internal
6816 * file selector in "grid mode", as one may do with "pure" file
6819 * @see elm_fileselector_expandable_get()
6821 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6824 * Get whether tree view is enabled for the given file selector
6825 * entry widget's internal file selector
6827 * @param obj The file selector entry widget
6828 * @return @c EINA_TRUE if @p obj widget's internal file selector
6829 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6831 * @see elm_fileselector_expandable_set() for more details
6833 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6836 * Set whether a given file selector entry widget's internal file
6837 * selector is to display folders only or the directory contents,
6840 * @param obj The file selector entry widget
6841 * @param only @c EINA_TRUE to make @p obj widget's internal file
6842 * selector only display directories, @c EINA_FALSE to make files
6843 * to be displayed in it too
6845 * This has the same effect as elm_fileselector_folder_only_set(),
6846 * but now applied to a file selector entry's internal file
6849 * @see elm_fileselector_folder_only_get()
6851 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6854 * Get whether a given file selector entry widget's internal file
6855 * selector is displaying folders only or the directory contents,
6858 * @param obj The file selector entry widget
6859 * @return @c EINA_TRUE if @p obj widget's internal file
6860 * selector is only displaying directories, @c EINA_FALSE if files
6861 * are being displayed in it too (and on errors)
6863 * @see elm_fileselector_entry_folder_only_set() for more details
6865 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6868 * Enable/disable the file name entry box where the user can type
6869 * in a name for a file, in a given file selector entry widget's
6870 * internal file selector.
6872 * @param obj The file selector entry widget
6873 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6874 * file selector a "saving dialog", @c EINA_FALSE otherwise
6876 * This has the same effect as elm_fileselector_is_save_set(),
6877 * but now applied to a file selector entry's internal file
6880 * @see elm_fileselector_is_save_get()
6882 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6885 * Get whether the given file selector entry widget's internal
6886 * file selector is in "saving dialog" mode
6888 * @param obj The file selector entry widget
6889 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6890 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6893 * @see elm_fileselector_entry_is_save_set() for more details
6895 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6898 * Set whether a given file selector entry widget's internal file
6899 * selector will raise an Elementary "inner window", instead of a
6900 * dedicated Elementary window. By default, it won't.
6902 * @param obj The file selector entry widget
6903 * @param value @c EINA_TRUE to make it use an inner window, @c
6904 * EINA_TRUE to make it use a dedicated window
6906 * @see elm_win_inwin_add() for more information on inner windows
6907 * @see elm_fileselector_entry_inwin_mode_get()
6909 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6912 * Get whether a given file selector entry widget's internal file
6913 * selector will raise an Elementary "inner window", instead of a
6914 * dedicated Elementary window.
6916 * @param obj The file selector entry widget
6917 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6918 * if it will use a dedicated window
6920 * @see elm_fileselector_entry_inwin_mode_set() for more details
6922 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6925 * Set the initial file system path for a given file selector entry
6928 * @param obj The file selector entry widget
6929 * @param path The path string
6931 * It must be a <b>directory</b> path, which will have the contents
6932 * displayed initially in the file selector's view, when invoked
6933 * from @p obj. The default initial path is the @c "HOME"
6934 * environment variable's value.
6936 * @see elm_fileselector_entry_path_get()
6938 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6941 * Get the parent directory's path to the latest file selection on
6942 * a given filer selector entry widget
6944 * @param obj The file selector object
6945 * @return The (full) path of the directory of the last selection
6946 * on @p obj widget, a @b stringshared string
6948 * @see elm_fileselector_entry_path_set()
6950 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6957 * @defgroup Scroller Scroller
6959 * A scroller holds a single object and "scrolls it around". This means that
6960 * it allows the user to use a scrollbar (or a finger) to drag the viewable
6961 * region around, allowing to move through a much larger object that is
6962 * contained in the scroller. The scroller will always have a small minimum
6963 * size by default as it won't be limited by the contents of the scroller.
6965 * Signals that you can add callbacks for are:
6966 * @li "edge,left" - the left edge of the content has been reached
6967 * @li "edge,right" - the right edge of the content has been reached
6968 * @li "edge,top" - the top edge of the content has been reached
6969 * @li "edge,bottom" - the bottom edge of the content has been reached
6970 * @li "scroll" - the content has been scrolled (moved)
6971 * @li "scroll,anim,start" - scrolling animation has started
6972 * @li "scroll,anim,stop" - scrolling animation has stopped
6973 * @li "scroll,drag,start" - dragging the contents around has started
6974 * @li "scroll,drag,stop" - dragging the contents around has stopped
6975 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6978 * @note When Elemementary is in embedded mode the scrollbars will not be
6979 * dragable, they appear merely as indicators of how much has been scrolled.
6980 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6981 * fingerscroll) won't work.
6983 * To set/get/unset the content of the panel, you can use
6984 * elm_object_content_set/get/unset APIs.
6985 * Once the content object is set, a previously set one will be deleted.
6986 * If you want to keep that old content object, use the
6987 * elm_object_content_unset() function
6989 * In @ref tutorial_scroller you'll find an example of how to use most of
6994 * @brief Type that controls when scrollbars should appear.
6996 * @see elm_scroller_policy_set()
6998 typedef enum _Elm_Scroller_Policy
7000 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7001 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7002 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7003 ELM_SCROLLER_POLICY_LAST
7004 } Elm_Scroller_Policy;
7006 * @brief Add a new scroller to the parent
7008 * @param parent The parent object
7009 * @return The new object or NULL if it cannot be created
7011 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7013 * @brief Set the content of the scroller widget (the object to be scrolled around).
7015 * @param obj The scroller object
7016 * @param content The new content object
7018 * Once the content object is set, a previously set one will be deleted.
7019 * If you want to keep that old content object, use the
7020 * elm_scroller_content_unset() function.
7021 * @deprecated See elm_object_content_set()
7023 EINA_DEPRECATED EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7025 * @brief Get the content of the scroller widget
7027 * @param obj The slider object
7028 * @return The content that is being used
7030 * Return the content object which is set for this widget
7032 * @see elm_scroller_content_set()
7033 * @deprecated use elm_object_content_get() instead.
7035 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7037 * @brief Unset the content of the scroller widget
7039 * @param obj The slider object
7040 * @return The content that was being used
7042 * Unparent and return the content object which was set for this widget
7044 * @see elm_scroller_content_set()
7045 * @deprecated use elm_object_content_unset() instead.
7047 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7049 * @brief Set custom theme elements for the scroller
7051 * @param obj The scroller object
7052 * @param widget The widget name to use (default is "scroller")
7053 * @param base The base name to use (default is "base")
7055 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7057 * @brief Make the scroller minimum size limited to the minimum size of the content
7059 * @param obj The scroller object
7060 * @param w Enable limiting minimum size horizontally
7061 * @param h Enable limiting minimum size vertically
7063 * By default the scroller will be as small as its design allows,
7064 * irrespective of its content. This will make the scroller minimum size the
7065 * right size horizontally and/or vertically to perfectly fit its content in
7068 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7070 * @brief Show a specific virtual region within the scroller content object
7072 * @param obj The scroller object
7073 * @param x X coordinate of the region
7074 * @param y Y coordinate of the region
7075 * @param w Width of the region
7076 * @param h Height of the region
7078 * This will ensure all (or part if it does not fit) of the designated
7079 * region in the virtual content object (0, 0 starting at the top-left of the
7080 * virtual content object) is shown within the scroller.
7082 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);
7084 * @brief Set the scrollbar visibility policy
7086 * @param obj The scroller object
7087 * @param policy_h Horizontal scrollbar policy
7088 * @param policy_v Vertical scrollbar policy
7090 * This sets the scrollbar visibility policy for the given scroller.
7091 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7092 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7093 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7094 * respectively for the horizontal and vertical scrollbars.
7096 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7098 * @brief Gets scrollbar visibility policy
7100 * @param obj The scroller object
7101 * @param policy_h Horizontal scrollbar policy
7102 * @param policy_v Vertical scrollbar policy
7104 * @see elm_scroller_policy_set()
7106 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7108 * @brief Get the currently visible content region
7110 * @param obj The scroller object
7111 * @param x X coordinate of the region
7112 * @param y Y coordinate of the region
7113 * @param w Width of the region
7114 * @param h Height of the region
7116 * This gets the current region in the content object that is visible through
7117 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7118 * w, @p h values pointed to.
7120 * @note All coordinates are relative to the content.
7122 * @see elm_scroller_region_show()
7124 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);
7126 * @brief Get the size of the content object
7128 * @param obj The scroller object
7129 * @param w Width of the content object.
7130 * @param h Height of the content object.
7132 * This gets the size of the content object of the scroller.
7134 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7136 * @brief Set bouncing behavior
7138 * @param obj The scroller object
7139 * @param h_bounce Allow bounce horizontally
7140 * @param v_bounce Allow bounce vertically
7142 * When scrolling, the scroller may "bounce" when reaching an edge of the
7143 * content object. This is a visual way to indicate the end has been reached.
7144 * This is enabled by default for both axis. This API will set if it is enabled
7145 * for the given axis with the boolean parameters for each axis.
7147 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7149 * @brief Get the bounce behaviour
7151 * @param obj The Scroller object
7152 * @param h_bounce Will the scroller bounce horizontally or not
7153 * @param v_bounce Will the scroller bounce vertically or not
7155 * @see elm_scroller_bounce_set()
7157 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7159 * @brief Set scroll page size relative to viewport size.
7161 * @param obj The scroller object
7162 * @param h_pagerel The horizontal page relative size
7163 * @param v_pagerel The vertical page relative size
7165 * The scroller is capable of limiting scrolling by the user to "pages". That
7166 * is to jump by and only show a "whole page" at a time as if the continuous
7167 * area of the scroller content is split into page sized pieces. This sets
7168 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7169 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7170 * axis. This is mutually exclusive with page size
7171 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7172 * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7173 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7176 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7178 * @brief Set scroll page size.
7180 * @param obj The scroller object
7181 * @param h_pagesize The horizontal page size
7182 * @param v_pagesize The vertical page size
7184 * This sets the page size to an absolute fixed value, with 0 turning it off
7187 * @see elm_scroller_page_relative_set()
7189 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7191 * @brief Show a specific virtual region within the scroller content object.
7193 * @param obj The scroller object
7194 * @param x X coordinate of the region
7195 * @param y Y coordinate of the region
7196 * @param w Width of the region
7197 * @param h Height of the region
7199 * This will ensure all (or part if it does not fit) of the designated
7200 * region in the virtual content object (0, 0 starting at the top-left of the
7201 * virtual content object) is shown within the scroller. Unlike
7202 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7203 * to this location (if configuration in general calls for transitions). It
7204 * may not jump immediately to the new location and make take a while and
7205 * show other content along the way.
7207 * @see elm_scroller_region_show()
7209 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);
7211 * @brief Set event propagation on a scroller
7213 * @param obj The scroller object
7214 * @param propagation If propagation is enabled or not
7216 * This enables or disabled event propagation from the scroller content to
7217 * the scroller and its parent. By default event propagation is disabled.
7219 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7221 * @brief Get event propagation for a scroller
7223 * @param obj The scroller object
7224 * @return The propagation state
7226 * This gets the event propagation for a scroller.
7228 * @see elm_scroller_propagate_events_set()
7230 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7232 * @brief Set scrolling gravity on a scroller
7234 * @param obj The scroller object
7235 * @param x The scrolling horizontal gravity
7236 * @param y The scrolling vertical gravity
7238 * The gravity, defines how the scroller will adjust its view
7239 * when the size of the scroller contents increase.
7241 * The scroller will adjust the view to glue itself as follows.
7243 * x=0.0, for showing the left most region of the content.
7244 * x=1.0, for showing the right most region of the content.
7245 * y=0.0, for showing the bottom most region of the content.
7246 * y=1.0, for showing the top most region of the content.
7248 * Default values for x and y are 0.0
7250 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7252 * @brief Get scrolling gravity values for a scroller
7254 * @param obj The scroller object
7255 * @param x The scrolling horizontal gravity
7256 * @param y The scrolling vertical gravity
7258 * This gets gravity values for a scroller.
7260 * @see elm_scroller_gravity_set()
7263 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7269 * @defgroup Label Label
7271 * @image html img/widget/label/preview-00.png
7272 * @image latex img/widget/label/preview-00.eps
7274 * @brief Widget to display text, with simple html-like markup.
7276 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7277 * text doesn't fit the geometry of the label it will be ellipsized or be
7278 * cut. Elementary provides several themes for this widget:
7279 * @li default - No animation
7280 * @li marker - Centers the text in the label and make it bold by default
7281 * @li slide_long - The entire text appears from the right of the screen and
7282 * slides until it disappears in the left of the screen(reappering on the
7284 * @li slide_short - The text appears in the left of the label and slides to
7285 * the right to show the overflow. When all of the text has been shown the
7286 * position is reset.
7287 * @li slide_bounce - The text appears in the left of the label and slides to
7288 * the right to show the overflow. When all of the text has been shown the
7289 * animation reverses, moving the text to the left.
7291 * Custom themes can of course invent new markup tags and style them any way
7294 * The following signals may be emitted by the label widget:
7295 * @li "language,changed": The program's language changed.
7297 * See @ref tutorial_label for a demonstration of how to use a label widget.
7301 * @brief Add a new label to the parent
7303 * @param parent The parent object
7304 * @return The new object or NULL if it cannot be created
7306 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7308 * @brief Set the label on the label object
7310 * @param obj The label object
7311 * @param label The label will be used on the label object
7312 * @deprecated See elm_object_text_set()
7314 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 */
7316 * @brief Get the label used on the label object
7318 * @param obj The label object
7319 * @return The string inside the label
7320 * @deprecated See elm_object_text_get()
7322 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7324 * @brief Set the wrapping behavior of the label
7326 * @param obj The label object
7327 * @param wrap To wrap text or not
7329 * By default no wrapping is done. Possible values for @p wrap are:
7330 * @li ELM_WRAP_NONE - No wrapping
7331 * @li ELM_WRAP_CHAR - wrap between characters
7332 * @li ELM_WRAP_WORD - wrap between words
7333 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7335 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7337 * @brief Get the wrapping behavior of the label
7339 * @param obj The label object
7342 * @see elm_label_line_wrap_set()
7344 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7346 * @brief Set wrap width of the label
7348 * @param obj The label object
7349 * @param w The wrap width in pixels at a minimum where words need to wrap
7351 * This function sets the maximum width size hint of the label.
7353 * @warning This is only relevant if the label is inside a container.
7355 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7357 * @brief Get wrap width of the label
7359 * @param obj The label object
7360 * @return The wrap width in pixels at a minimum where words need to wrap
7362 * @see elm_label_wrap_width_set()
7364 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7366 * @brief Set wrap height of the label
7368 * @param obj The label object
7369 * @param h The wrap height in pixels at a minimum where words need to wrap
7371 * This function sets the maximum height size hint of the label.
7373 * @warning This is only relevant if the label is inside a container.
7375 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7377 * @brief get wrap width of the label
7379 * @param obj The label object
7380 * @return The wrap height in pixels at a minimum where words need to wrap
7382 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7384 * @brief Set the font size on the label object.
7386 * @param obj The label object
7387 * @param size font size
7389 * @warning NEVER use this. It is for hyper-special cases only. use styles
7390 * instead. e.g. "big", "medium", "small" - or better name them by use:
7391 * "title", "footnote", "quote" etc.
7393 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7395 * @brief Set the text color on the label object
7397 * @param obj The label object
7398 * @param r Red property background color of The label object
7399 * @param g Green property background color of The label object
7400 * @param b Blue property background color of The label object
7401 * @param a Alpha property background color of The label object
7403 * @warning NEVER use this. It is for hyper-special cases only. use styles
7404 * instead. e.g. "big", "medium", "small" - or better name them by use:
7405 * "title", "footnote", "quote" etc.
7407 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);
7409 * @brief Set the text align on the label object
7411 * @param obj The label object
7412 * @param align align mode ("left", "center", "right")
7414 * @warning NEVER use this. It is for hyper-special cases only. use styles
7415 * instead. e.g. "big", "medium", "small" - or better name them by use:
7416 * "title", "footnote", "quote" etc.
7418 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7420 * @brief Set background color of the label
7422 * @param obj The label object
7423 * @param r Red property background color of The label object
7424 * @param g Green property background color of The label object
7425 * @param b Blue property background color of The label object
7426 * @param a Alpha property background alpha of The label object
7428 * @warning NEVER use this. It is for hyper-special cases only. use styles
7429 * instead. e.g. "big", "medium", "small" - or better name them by use:
7430 * "title", "footnote", "quote" etc.
7432 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);
7434 * @brief Set the ellipsis behavior of the label
7436 * @param obj The label object
7437 * @param ellipsis To ellipsis text or not
7439 * If set to true and the text doesn't fit in the label an ellipsis("...")
7440 * will be shown at the end of the widget.
7442 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7443 * choosen wrap method was ELM_WRAP_WORD.
7445 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7446 EINA_DEPRECATED EAPI void elm_label_wrap_mode_set(Evas_Object *obj, Eina_Bool wrapmode) EINA_ARG_NONNULL(1);
7448 * @brief Set the text slide of the label
7450 * @param obj The label object
7451 * @param slide To start slide or stop
7453 * If set to true, the text of the label will slide/scroll through the length of
7456 * @warning This only works with the themes "slide_short", "slide_long" and
7459 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7461 * @brief Get the text slide mode of the label
7463 * @param obj The label object
7464 * @return slide slide mode value
7466 * @see elm_label_slide_set()
7468 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7470 * @brief Set the slide duration(speed) of the label
7472 * @param obj The label object
7473 * @return The duration in seconds in moving text from slide begin position
7474 * to slide end position
7476 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7478 * @brief Get the slide duration(speed) of the label
7480 * @param obj The label object
7481 * @return The duration time in moving text from slide begin position to slide end position
7483 * @see elm_label_slide_duration_set()
7485 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7491 * @defgroup Toggle Toggle
7493 * @image html img/widget/toggle/preview-00.png
7494 * @image latex img/widget/toggle/preview-00.eps
7496 * @brief A toggle is a slider which can be used to toggle between
7497 * two values. It has two states: on and off.
7499 * This widget is deprecated. Please use elm_check_add() instead using the
7500 * toggle style like:
7503 * obj = elm_check_add(parent);
7504 * elm_object_style_set(obj, "toggle");
7505 * elm_object_text_part_set(obj, "on", "ON");
7506 * elm_object_text_part_set(obj, "off", "OFF");
7509 * Signals that you can add callbacks for are:
7510 * @li "changed" - Whenever the toggle value has been changed. Is not called
7511 * until the toggle is released by the cursor (assuming it
7512 * has been triggered by the cursor in the first place).
7514 * @ref tutorial_toggle show how to use a toggle.
7518 * @brief Add a toggle to @p parent.
7520 * @param parent The parent object
7522 * @return The toggle object
7524 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7526 * @brief Sets the label to be displayed with the toggle.
7528 * @param obj The toggle object
7529 * @param label The label to be displayed
7531 * @deprecated use elm_object_text_set() instead.
7533 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7535 * @brief Gets the label of the toggle
7537 * @param obj toggle object
7538 * @return The label of the toggle
7540 * @deprecated use elm_object_text_get() instead.
7542 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7544 * @brief Set the icon used for the toggle
7546 * @param obj The toggle object
7547 * @param icon The icon object for the button
7549 * Once the icon object is set, a previously set one will be deleted
7550 * If you want to keep that old content object, use the
7551 * elm_toggle_icon_unset() function.
7553 * @deprecated use elm_object_content_set() instead.
7555 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7557 * @brief Get the icon used for the toggle
7559 * @param obj The toggle object
7560 * @return The icon object that is being used
7562 * Return the icon object which is set for this widget.
7564 * @see elm_toggle_icon_set()
7566 * @deprecated use elm_object_content_get() instead.
7568 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7570 * @brief Unset the icon used for the toggle
7572 * @param obj The toggle object
7573 * @return The icon object that was being used
7575 * Unparent and return the icon object which was set for this widget.
7577 * @see elm_toggle_icon_set()
7579 * @deprecated use elm_object_content_unset() instead.
7581 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7583 * @brief Sets the labels to be associated with the on and off states of the toggle.
7585 * @param obj The toggle object
7586 * @param onlabel The label displayed when the toggle is in the "on" state
7587 * @param offlabel The label displayed when the toggle is in the "off" state
7589 * @deprecated use elm_object_text_part_set() for "on" and "off" parts
7592 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7594 * @brief Gets the labels associated with the on and off states of the
7597 * @param obj The toggle object
7598 * @param onlabel A char** to place the onlabel of @p obj into
7599 * @param offlabel A char** to place the offlabel of @p obj into
7601 * @deprecated use elm_object_text_part_get() for "on" and "off" parts
7604 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7606 * @brief Sets the state of the toggle to @p state.
7608 * @param obj The toggle object
7609 * @param state The state of @p obj
7611 * @deprecated use elm_check_state_set() instead.
7613 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7615 * @brief Gets the state of the toggle to @p state.
7617 * @param obj The toggle object
7618 * @return The state of @p obj
7620 * @deprecated use elm_check_state_get() instead.
7622 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7624 * @brief Sets the state pointer of the toggle to @p statep.
7626 * @param obj The toggle object
7627 * @param statep The state pointer of @p obj
7629 * @deprecated use elm_check_state_pointer_set() instead.
7631 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7637 * @page tutorial_frame Frame example
7638 * @dontinclude frame_example_01.c
7640 * In this example we are going to create 4 Frames with different styles and
7641 * add a rectangle of different color in each.
7643 * We start we the usual setup code:
7646 * And then create one rectangle:
7649 * To add it in our first frame, which since it doesn't have it's style
7650 * specifically set uses the default style:
7653 * And then create another rectangle:
7656 * To add it in our second frame, which uses the "pad_small" style, note that
7657 * even tough we are setting a text for this frame it won't be show, only the
7658 * default style shows the Frame's title:
7660 * @note The "pad_small", "pad_medium", "pad_large" and "pad_huge" styles are
7661 * very similar, their only difference is the size of the empty area around
7662 * the content of the frame.
7664 * And then create yet another rectangle:
7667 * To add it in our third frame, which uses the "outdent_top" style, note
7668 * that even tough we are setting a text for this frame it won't be show,
7669 * only the default style shows the Frame's title:
7672 * And then create one last rectangle:
7675 * To add it in our fourth and final frame, which uses the "outdent_bottom"
7676 * style, note that even tough we are setting a text for this frame it won't
7677 * be show, only the default style shows the Frame's title:
7680 * And now we are left with just some more setup code:
7683 * Our example will look like this:
7684 * @image html screenshots/frame_example_01.png
7685 * @image latex screenshots/frame_example_01.eps
7687 * @example frame_example_01.c
7690 * @defgroup Frame Frame
7692 * @brief Frame is a widget that holds some content and has a title.
7694 * The default look is a frame with a title, but Frame supports multple
7702 * @li outdent_bottom
7704 * Of all this styles only default shows the title. Frame emits no signals.
7706 * Default contents parts of the frame widget that you can use for are:
7707 * @li "elm.swallow.content" - A content of the frame
7709 * Default text parts of the frame widget that you can use for are:
7710 * @li "elm.text" - Label of the frame
7712 * For a detailed example see the @ref tutorial_frame.
7717 * @brief Add a new frame to the parent
7719 * @param parent The parent object
7720 * @return The new object or NULL if it cannot be created
7722 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7724 * @brief Set the frame label
7726 * @param obj The frame object
7727 * @param label The label of this frame object
7729 * @deprecated use elm_object_text_set() instead.
7731 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7733 * @brief Get the frame label
7735 * @param obj The frame object
7737 * @return The label of this frame objet or NULL if unable to get frame
7739 * @deprecated use elm_object_text_get() instead.
7741 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7743 * @brief Set the content of the frame widget
7745 * Once the content object is set, a previously set one will be deleted.
7746 * If you want to keep that old content object, use the
7747 * elm_frame_content_unset() function.
7749 * @param obj The frame object
7750 * @param content The content will be filled in this frame object
7752 EINA_DEPRECATED EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7754 * @brief Get the content of the frame widget
7756 * Return the content object which is set for this widget
7758 * @param obj The frame object
7759 * @return The content that is being used
7761 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7763 * @brief Unset the content of the frame widget
7765 * Unparent and return the content object which was set for this widget
7767 * @param obj The frame object
7768 * @return The content that was being used
7770 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7776 * @defgroup Table Table
7778 * A container widget to arrange other widgets in a table where items can
7779 * also span multiple columns or rows - even overlap (and then be raised or
7780 * lowered accordingly to adjust stacking if they do overlap).
7782 * For a Table widget the row/column count is not fixed.
7783 * The table widget adjusts itself when subobjects are added to it dynamically.
7785 * The followin are examples of how to use a table:
7786 * @li @ref tutorial_table_01
7787 * @li @ref tutorial_table_02
7792 * @brief Add a new table to the parent
7794 * @param parent The parent object
7795 * @return The new object or NULL if it cannot be created
7797 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7799 * @brief Set the homogeneous layout in the table
7801 * @param obj The layout object
7802 * @param homogeneous A boolean to set if the layout is homogeneous in the
7803 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7805 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7807 * @brief Get the current table homogeneous mode.
7809 * @param obj The table object
7810 * @return A boolean to indicating if the layout is homogeneous in the table
7811 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7813 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7815 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7817 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7819 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7821 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7823 * @brief Set padding between cells.
7825 * @param obj The layout object.
7826 * @param horizontal set the horizontal padding.
7827 * @param vertical set the vertical padding.
7829 * Default value is 0.
7831 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7833 * @brief Get padding between cells.
7835 * @param obj The layout object.
7836 * @param horizontal set the horizontal padding.
7837 * @param vertical set the vertical padding.
7839 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7841 * @brief Add a subobject on the table with the coordinates passed
7843 * @param obj The table object
7844 * @param subobj The subobject to be added to the table
7845 * @param x Row number
7846 * @param y Column number
7850 * @note All positioning inside the table is relative to rows and columns, so
7851 * a value of 0 for x and y, means the top left cell of the table, and a
7852 * value of 1 for w and h means @p subobj only takes that 1 cell.
7854 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7856 * @brief Remove child from table.
7858 * @param obj The table object
7859 * @param subobj The subobject
7861 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7863 * @brief Faster way to remove all child objects from a table object.
7865 * @param obj The table object
7866 * @param clear If true, will delete children, else just remove from table.
7868 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7870 * @brief Set the packing location of an existing child of the table
7872 * @param subobj The subobject to be modified in the table
7873 * @param x Row number
7874 * @param y Column number
7878 * Modifies the position of an object already in the table.
7880 * @note All positioning inside the table is relative to rows and columns, so
7881 * a value of 0 for x and y, means the top left cell of the table, and a
7882 * value of 1 for w and h means @p subobj only takes that 1 cell.
7884 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7886 * @brief Get the packing location of an existing child of the table
7888 * @param subobj The subobject to be modified in the table
7889 * @param x Row number
7890 * @param y Column number
7894 * @see elm_table_pack_set()
7896 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7902 * @defgroup Gengrid Gengrid (Generic grid)
7904 * This widget aims to position objects in a grid layout while
7905 * actually creating and rendering only the visible ones, using the
7906 * same idea as the @ref Genlist "genlist": the user defines a @b
7907 * class for each item, specifying functions that will be called at
7908 * object creation, deletion, etc. When those items are selected by
7909 * the user, a callback function is issued. Users may interact with
7910 * a gengrid via the mouse (by clicking on items to select them and
7911 * clicking on the grid's viewport and swiping to pan the whole
7912 * view) or via the keyboard, navigating through item with the
7915 * @section Gengrid_Layouts Gengrid layouts
7917 * Gengrid may layout its items in one of two possible layouts:
7921 * When in "horizontal mode", items will be placed in @b columns,
7922 * from top to bottom and, when the space for a column is filled,
7923 * another one is started on the right, thus expanding the grid
7924 * horizontally, making for horizontal scrolling. When in "vertical
7925 * mode" , though, items will be placed in @b rows, from left to
7926 * right and, when the space for a row is filled, another one is
7927 * started below, thus expanding the grid vertically (and making
7928 * for vertical scrolling).
7930 * @section Gengrid_Items Gengrid items
7932 * An item in a gengrid can have 0 or more text labels (they can be
7933 * regular text or textblock Evas objects - that's up to the style
7934 * to determine), 0 or more icons (which are simply objects
7935 * swallowed into the gengrid item's theming Edje object) and 0 or
7936 * more <b>boolean states</b>, which have the behavior left to the
7937 * user to define. The Edje part names for each of these properties
7938 * will be looked up, in the theme file for the gengrid, under the
7939 * Edje (string) data items named @c "labels", @c "icons" and @c
7940 * "states", respectively. For each of those properties, if more
7941 * than one part is provided, they must have names listed separated
7942 * by spaces in the data fields. For the default gengrid item
7943 * theme, we have @b one label part (@c "elm.text"), @b two icon
7944 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7947 * A gengrid item may be at one of several styles. Elementary
7948 * provides one by default - "default", but this can be extended by
7949 * system or application custom themes/overlays/extensions (see
7950 * @ref Theme "themes" for more details).
7952 * @section Gengrid_Item_Class Gengrid item classes
7954 * In order to have the ability to add and delete items on the fly,
7955 * gengrid implements a class (callback) system where the
7956 * application provides a structure with information about that
7957 * type of item (gengrid may contain multiple different items with
7958 * different classes, states and styles). Gengrid will call the
7959 * functions in this struct (methods) when an item is "realized"
7960 * (i.e., created dynamically, while the user is scrolling the
7961 * grid). All objects will simply be deleted when no longer needed
7962 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7963 * contains the following members:
7964 * - @c item_style - This is a constant string and simply defines
7965 * the name of the item style. It @b must be specified and the
7966 * default should be @c "default".
7967 * - @c func.label_get - This function is called when an item
7968 * object is actually created. The @c data parameter will point to
7969 * the same data passed to elm_gengrid_item_append() and related
7970 * item creation functions. The @c obj parameter is the gengrid
7971 * object itself, while the @c part one is the name string of one
7972 * of the existing text parts in the Edje group implementing the
7973 * item's theme. This function @b must return a strdup'()ed string,
7974 * as the caller will free() it when done. See
7975 * #Elm_Gengrid_Item_Label_Get_Cb.
7976 * - @c func.content_get - This function is called when an item object
7977 * is actually created. The @c data parameter will point to the
7978 * same data passed to elm_gengrid_item_append() and related item
7979 * creation functions. The @c obj parameter is the gengrid object
7980 * itself, while the @c part one is the name string of one of the
7981 * existing (content) swallow parts in the Edje group implementing the
7982 * item's theme. It must return @c NULL, when no content is desired,
7983 * or a valid object handle, otherwise. The object will be deleted
7984 * by the gengrid on its deletion or when the item is "unrealized".
7985 * See #Elm_Gengrid_Item_Content_Get_Cb.
7986 * - @c func.state_get - This function is called when an item
7987 * object is actually created. The @c data parameter will point to
7988 * the same data passed to elm_gengrid_item_append() and related
7989 * item creation functions. The @c obj parameter is the gengrid
7990 * object itself, while the @c part one is the name string of one
7991 * of the state parts in the Edje group implementing the item's
7992 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7993 * true/on. Gengrids will emit a signal to its theming Edje object
7994 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7995 * "source" arguments, respectively, when the state is true (the
7996 * default is false), where @c XXX is the name of the (state) part.
7997 * See #Elm_Gengrid_Item_State_Get_Cb.
7998 * - @c func.del - This is called when elm_gengrid_item_del() is
7999 * called on an item or elm_gengrid_clear() is called on the
8000 * gengrid. This is intended for use when gengrid items are
8001 * deleted, so any data attached to the item (e.g. its data
8002 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8004 * @section Gengrid_Usage_Hints Usage hints
8006 * If the user wants to have multiple items selected at the same
8007 * time, elm_gengrid_multi_select_set() will permit it. If the
8008 * gengrid is single-selection only (the default), then
8009 * elm_gengrid_select_item_get() will return the selected item or
8010 * @c NULL, if none is selected. If the gengrid is under
8011 * multi-selection, then elm_gengrid_selected_items_get() will
8012 * return a list (that is only valid as long as no items are
8013 * modified (added, deleted, selected or unselected) of child items
8016 * If an item changes (internal (boolean) state, label or content
8017 * changes), then use elm_gengrid_item_update() to have gengrid
8018 * update the item with the new state. A gengrid will re-"realize"
8019 * the item, thus calling the functions in the
8020 * #Elm_Gengrid_Item_Class set for that item.
8022 * To programmatically (un)select an item, use
8023 * elm_gengrid_item_selected_set(). To get its selected state use
8024 * elm_gengrid_item_selected_get(). To make an item disabled
8025 * (unable to be selected and appear differently) use
8026 * elm_gengrid_item_disabled_set() to set this and
8027 * elm_gengrid_item_disabled_get() to get the disabled state.
8029 * Grid cells will only have their selection smart callbacks called
8030 * when firstly getting selected. Any further clicks will do
8031 * nothing, unless you enable the "always select mode", with
8032 * elm_gengrid_always_select_mode_set(), thus making every click to
8033 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8034 * turn off the ability to select items entirely in the widget and
8035 * they will neither appear selected nor call the selection smart
8038 * Remember that you can create new styles and add your own theme
8039 * augmentation per application with elm_theme_extension_add(). If
8040 * you absolutely must have a specific style that overrides any
8041 * theme the user or system sets up you can use
8042 * elm_theme_overlay_add() to add such a file.
8044 * @section Gengrid_Smart_Events Gengrid smart events
8046 * Smart events that you can add callbacks for are:
8047 * - @c "activated" - The user has double-clicked or pressed
8048 * (enter|return|spacebar) on an item. The @c event_info parameter
8049 * is the gengrid item that was activated.
8050 * - @c "clicked,double" - The user has double-clicked an item.
8051 * The @c event_info parameter is the gengrid item that was double-clicked.
8052 * - @c "longpressed" - This is called when the item is pressed for a certain
8053 * amount of time. By default it's 1 second.
8054 * - @c "selected" - The user has made an item selected. The
8055 * @c event_info parameter is the gengrid item that was selected.
8056 * - @c "unselected" - The user has made an item unselected. The
8057 * @c event_info parameter is the gengrid item that was unselected.
8058 * - @c "realized" - This is called when the item in the gengrid
8059 * has its implementing Evas object instantiated, de facto. @c
8060 * event_info is the gengrid item that was created. The object
8061 * may be deleted at any time, so it is highly advised to the
8062 * caller @b not to use the object pointer returned from
8063 * elm_gengrid_item_object_get(), because it may point to freed
8065 * - @c "unrealized" - This is called when the implementing Evas
8066 * object for this item is deleted. @c event_info is the gengrid
8067 * item that was deleted.
8068 * - @c "changed" - Called when an item is added, removed, resized
8069 * or moved and when the gengrid is resized or gets "horizontal"
8071 * - @c "scroll,anim,start" - This is called when scrolling animation has
8073 * - @c "scroll,anim,stop" - This is called when scrolling animation has
8075 * - @c "drag,start,up" - Called when the item in the gengrid has
8076 * been dragged (not scrolled) up.
8077 * - @c "drag,start,down" - Called when the item in the gengrid has
8078 * been dragged (not scrolled) down.
8079 * - @c "drag,start,left" - Called when the item in the gengrid has
8080 * been dragged (not scrolled) left.
8081 * - @c "drag,start,right" - Called when the item in the gengrid has
8082 * been dragged (not scrolled) right.
8083 * - @c "drag,stop" - Called when the item in the gengrid has
8084 * stopped being dragged.
8085 * - @c "drag" - Called when the item in the gengrid is being
8087 * - @c "scroll" - called when the content has been scrolled
8089 * - @c "scroll,drag,start" - called when dragging the content has
8091 * - @c "scroll,drag,stop" - called when dragging the content has
8093 * - @c "edge,top" - This is called when the gengrid is scrolled until
8095 * - @c "edge,bottom" - This is called when the gengrid is scrolled
8096 * until the bottom edge.
8097 * - @c "edge,left" - This is called when the gengrid is scrolled
8098 * until the left edge.
8099 * - @c "edge,right" - This is called when the gengrid is scrolled
8100 * until the right edge.
8102 * List of gengrid examples:
8103 * @li @ref gengrid_example
8107 * @addtogroup Gengrid
8111 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8112 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8113 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8114 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
8115 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. */
8116 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. */
8117 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
8119 /* temporary compatibility code */
8120 typedef Elm_Gengrid_Item_Label_Get_Cb GridItemLabelGetFunc EINA_DEPRECATED;
8121 typedef Elm_Gengrid_Item_Content_Get_Cb GridItemIconGetFunc EINA_DEPRECATED;
8122 typedef Elm_Gengrid_Item_State_Get_Cb GridItemStateGetFunc EINA_DEPRECATED;
8123 typedef Elm_Gengrid_Item_Del_Cb GridItemDelFunc EINA_DEPRECATED;
8126 * @struct _Elm_Gengrid_Item_Class
8128 * Gengrid item class definition. See @ref Gengrid_Item_Class for
8131 struct _Elm_Gengrid_Item_Class
8133 const char *item_style;
8134 struct _Elm_Gengrid_Item_Class_Func
8136 Elm_Gengrid_Item_Label_Get_Cb label_get;
8137 Elm_Gengrid_Item_Content_Get_Cb icon_get;
8138 Elm_Gengrid_Item_State_Get_Cb state_get;
8139 Elm_Gengrid_Item_Del_Cb del;
8141 }; /**< #Elm_Gengrid_Item_Class member definitions */
8143 * Add a new gengrid widget to the given parent Elementary
8144 * (container) object
8146 * @param parent The parent object
8147 * @return a new gengrid widget handle or @c NULL, on errors
8149 * This function inserts a new gengrid widget on the canvas.
8151 * @see elm_gengrid_item_size_set()
8152 * @see elm_gengrid_group_item_size_set()
8153 * @see elm_gengrid_horizontal_set()
8154 * @see elm_gengrid_item_append()
8155 * @see elm_gengrid_item_del()
8156 * @see elm_gengrid_clear()
8160 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8163 * Set the size for the items of a given gengrid widget
8165 * @param obj The gengrid object.
8166 * @param w The items' width.
8167 * @param h The items' height;
8169 * A gengrid, after creation, has still no information on the size
8170 * to give to each of its cells. So, you most probably will end up
8171 * with squares one @ref Fingers "finger" wide, the default
8172 * size. Use this function to force a custom size for you items,
8173 * making them as big as you wish.
8175 * @see elm_gengrid_item_size_get()
8179 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8182 * Get the size set for the items of a given gengrid widget
8184 * @param obj The gengrid object.
8185 * @param w Pointer to a variable where to store the items' width.
8186 * @param h Pointer to a variable where to store the items' height.
8188 * @note Use @c NULL pointers on the size values you're not
8189 * interested in: they'll be ignored by the function.
8191 * @see elm_gengrid_item_size_get() for more details
8195 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8198 * Set the items grid's alignment within a given gengrid widget
8200 * @param obj The gengrid object.
8201 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8202 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8204 * This sets the alignment of the whole grid of items of a gengrid
8205 * within its given viewport. By default, those values are both
8206 * 0.5, meaning that the gengrid will have its items grid placed
8207 * exactly in the middle of its viewport.
8209 * @note If given alignment values are out of the cited ranges,
8210 * they'll be changed to the nearest boundary values on the valid
8213 * @see elm_gengrid_align_get()
8217 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8220 * Get the items grid's alignment values within a given gengrid
8223 * @param obj The gengrid object.
8224 * @param align_x Pointer to a variable where to store the
8225 * horizontal alignment.
8226 * @param align_y Pointer to a variable where to store the vertical
8229 * @note Use @c NULL pointers on the alignment values you're not
8230 * interested in: they'll be ignored by the function.
8232 * @see elm_gengrid_align_set() for more details
8236 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8239 * Set whether a given gengrid widget is or not able have items
8242 * @param obj The gengrid object
8243 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8244 * @c EINA_FALSE to turn it off
8246 * If a gengrid is set to allow reordering, a click held for more
8247 * than 0.5 over a given item will highlight it specially,
8248 * signalling the gengrid has entered the reordering state. From
8249 * that time on, the user will be able to, while still holding the
8250 * mouse button down, move the item freely in the gengrid's
8251 * viewport, replacing to said item to the locations it goes to.
8252 * The replacements will be animated and, whenever the user
8253 * releases the mouse button, the item being replaced gets a new
8254 * definitive place in the grid.
8256 * @see elm_gengrid_reorder_mode_get()
8260 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8263 * Get whether a given gengrid widget is or not able have items
8266 * @param obj The gengrid object
8267 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8270 * @see elm_gengrid_reorder_mode_set() for more details
8274 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8277 * Append a new item in a given gengrid widget.
8279 * @param obj The gengrid object.
8280 * @param gic The item class for the item.
8281 * @param data The item data.
8282 * @param func Convenience function called when the item is
8284 * @param func_data Data to be passed to @p func.
8285 * @return A handle to the item added or @c NULL, on errors.
8287 * This adds an item to the beginning of the gengrid.
8289 * @see elm_gengrid_item_prepend()
8290 * @see elm_gengrid_item_insert_before()
8291 * @see elm_gengrid_item_insert_after()
8292 * @see elm_gengrid_item_del()
8296 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);
8299 * Prepend a new item in a given gengrid widget.
8301 * @param obj The gengrid object.
8302 * @param gic The item class for the item.
8303 * @param data The item data.
8304 * @param func Convenience function called when the item is
8306 * @param func_data Data to be passed to @p func.
8307 * @return A handle to the item added or @c NULL, on errors.
8309 * This adds an item to the end of the gengrid.
8311 * @see elm_gengrid_item_append()
8312 * @see elm_gengrid_item_insert_before()
8313 * @see elm_gengrid_item_insert_after()
8314 * @see elm_gengrid_item_del()
8318 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);
8321 * Insert an item before another in a gengrid widget
8323 * @param obj The gengrid object.
8324 * @param gic The item class for the item.
8325 * @param data The item data.
8326 * @param relative The item to place this new one before.
8327 * @param func Convenience function called when the item is
8329 * @param func_data Data to be passed to @p func.
8330 * @return A handle to the item added or @c NULL, on errors.
8332 * This inserts an item before another in the gengrid.
8334 * @see elm_gengrid_item_append()
8335 * @see elm_gengrid_item_prepend()
8336 * @see elm_gengrid_item_insert_after()
8337 * @see elm_gengrid_item_del()
8341 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);
8344 * Insert an item after another in a gengrid widget
8346 * @param obj The gengrid object.
8347 * @param gic The item class for the item.
8348 * @param data The item data.
8349 * @param relative The item to place this new one after.
8350 * @param func Convenience function called when the item is
8352 * @param func_data Data to be passed to @p func.
8353 * @return A handle to the item added or @c NULL, on errors.
8355 * This inserts an item after another in the gengrid.
8357 * @see elm_gengrid_item_append()
8358 * @see elm_gengrid_item_prepend()
8359 * @see elm_gengrid_item_insert_after()
8360 * @see elm_gengrid_item_del()
8364 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);
8367 * Insert an item in a gengrid widget using a user-defined sort function.
8369 * @param obj The gengrid object.
8370 * @param gic The item class for the item.
8371 * @param data The item data.
8372 * @param comp User defined comparison function that defines the sort order based on
8373 * Elm_Gen_Item and its data param.
8374 * @param func Convenience function called when the item is selected.
8375 * @param func_data Data to be passed to @p func.
8376 * @return A handle to the item added or @c NULL, on errors.
8378 * This inserts an item in the gengrid based on user defined comparison function.
8380 * @see elm_gengrid_item_append()
8381 * @see elm_gengrid_item_prepend()
8382 * @see elm_gengrid_item_insert_after()
8383 * @see elm_gengrid_item_del()
8384 * @see elm_gengrid_item_direct_sorted_insert()
8388 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);
8391 * Insert an item in a gengrid widget using a user-defined sort function.
8393 * @param obj The gengrid object.
8394 * @param gic The item class for the item.
8395 * @param data The item data.
8396 * @param comp User defined comparison function that defines the sort order based on
8398 * @param func Convenience function called when the item is selected.
8399 * @param func_data Data to be passed to @p func.
8400 * @return A handle to the item added or @c NULL, on errors.
8402 * This inserts an item in the gengrid based on user defined comparison function.
8404 * @see elm_gengrid_item_append()
8405 * @see elm_gengrid_item_prepend()
8406 * @see elm_gengrid_item_insert_after()
8407 * @see elm_gengrid_item_del()
8408 * @see elm_gengrid_item_sorted_insert()
8412 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);
8415 * Set whether items on a given gengrid widget are to get their
8416 * selection callbacks issued for @b every subsequent selection
8417 * click on them or just for the first click.
8419 * @param obj The gengrid object
8420 * @param always_select @c EINA_TRUE to make items "always
8421 * selected", @c EINA_FALSE, otherwise
8423 * By default, grid items will only call their selection callback
8424 * function when firstly getting selected, any subsequent further
8425 * clicks will do nothing. With this call, you make those
8426 * subsequent clicks also to issue the selection callbacks.
8428 * @note <b>Double clicks</b> will @b always be reported on items.
8430 * @see elm_gengrid_always_select_mode_get()
8434 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8437 * Get whether items on a given gengrid widget have their selection
8438 * callbacks issued for @b every subsequent selection click on them
8439 * or just for the first click.
8441 * @param obj The gengrid object.
8442 * @return @c EINA_TRUE if the gengrid items are "always selected",
8443 * @c EINA_FALSE, otherwise
8445 * @see elm_gengrid_always_select_mode_set() for more details
8449 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8452 * Set whether items on a given gengrid widget can be selected or not.
8454 * @param obj The gengrid object
8455 * @param no_select @c EINA_TRUE to make items selectable,
8456 * @c EINA_FALSE otherwise
8458 * This will make items in @p obj selectable or not. In the latter
8459 * case, any user interaction on the gengrid items will neither make
8460 * them appear selected nor them call their selection callback
8463 * @see elm_gengrid_no_select_mode_get()
8467 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8470 * Get whether items on a given gengrid widget can be selected or
8473 * @param obj The gengrid object
8474 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8477 * @see elm_gengrid_no_select_mode_set() for more details
8481 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8484 * Enable or disable multi-selection in a given gengrid widget
8486 * @param obj The gengrid object.
8487 * @param multi @c EINA_TRUE, to enable multi-selection,
8488 * @c EINA_FALSE to disable it.
8490 * Multi-selection is the ability to have @b more than one
8491 * item selected, on a given gengrid, simultaneously. When it is
8492 * enabled, a sequence of clicks on different items will make them
8493 * all selected, progressively. A click on an already selected item
8494 * will unselect it. If interacting via the keyboard,
8495 * multi-selection is enabled while holding the "Shift" key.
8497 * @note By default, multi-selection is @b disabled on gengrids
8499 * @see elm_gengrid_multi_select_get()
8503 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8506 * Get whether multi-selection is enabled or disabled for a given
8509 * @param obj The gengrid object.
8510 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8511 * EINA_FALSE otherwise
8513 * @see elm_gengrid_multi_select_set() for more details
8517 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8520 * Enable or disable bouncing effect for a given gengrid widget
8522 * @param obj The gengrid object
8523 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8524 * @c EINA_FALSE to disable it
8525 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8526 * @c EINA_FALSE to disable it
8528 * The bouncing effect occurs whenever one reaches the gengrid's
8529 * edge's while panning it -- it will scroll past its limits a
8530 * little bit and return to the edge again, in a animated for,
8533 * @note By default, gengrids have bouncing enabled on both axis
8535 * @see elm_gengrid_bounce_get()
8539 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8542 * Get whether bouncing effects are enabled or disabled, for a
8543 * given gengrid widget, on each axis
8545 * @param obj The gengrid object
8546 * @param h_bounce Pointer to a variable where to store the
8547 * horizontal bouncing flag.
8548 * @param v_bounce Pointer to a variable where to store the
8549 * vertical bouncing flag.
8551 * @see elm_gengrid_bounce_set() for more details
8555 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8558 * Set a given gengrid widget's scrolling page size, relative to
8559 * its viewport size.
8561 * @param obj The gengrid object
8562 * @param h_pagerel The horizontal page (relative) size
8563 * @param v_pagerel The vertical page (relative) size
8565 * The gengrid's scroller is capable of binding scrolling by the
8566 * user to "pages". It means that, while scrolling and, specially
8567 * after releasing the mouse button, the grid will @b snap to the
8568 * nearest displaying page's area. When page sizes are set, the
8569 * grid's continuous content area is split into (equal) page sized
8572 * This function sets the size of a page <b>relatively to the
8573 * viewport dimensions</b> of the gengrid, for each axis. A value
8574 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8575 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8576 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8577 * 1.0. Values beyond those will make it behave behave
8578 * inconsistently. If you only want one axis to snap to pages, use
8579 * the value @c 0.0 for the other one.
8581 * There is a function setting page size values in @b absolute
8582 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8583 * is mutually exclusive to this one.
8585 * @see elm_gengrid_page_relative_get()
8589 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8592 * Get a given gengrid widget's scrolling page size, relative to
8593 * its viewport size.
8595 * @param obj The gengrid object
8596 * @param h_pagerel Pointer to a variable where to store the
8597 * horizontal page (relative) size
8598 * @param v_pagerel Pointer to a variable where to store the
8599 * vertical page (relative) size
8601 * @see elm_gengrid_page_relative_set() for more details
8605 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8608 * Set a given gengrid widget's scrolling page size
8610 * @param obj The gengrid object
8611 * @param h_pagerel The horizontal page size, in pixels
8612 * @param v_pagerel The vertical page size, in pixels
8614 * The gengrid's scroller is capable of binding scrolling by the
8615 * user to "pages". It means that, while scrolling and, specially
8616 * after releasing the mouse button, the grid will @b snap to the
8617 * nearest displaying page's area. When page sizes are set, the
8618 * grid's continuous content area is split into (equal) page sized
8621 * This function sets the size of a page of the gengrid, in pixels,
8622 * for each axis. Sane usable values are, between @c 0 and the
8623 * dimensions of @p obj, for each axis. Values beyond those will
8624 * make it behave behave inconsistently. If you only want one axis
8625 * to snap to pages, use the value @c 0 for the other one.
8627 * There is a function setting page size values in @b relative
8628 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8629 * use is mutually exclusive to this one.
8633 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8636 * Set the direction in which a given gengrid widget will expand while
8637 * placing its items.
8639 * @param obj The gengrid object.
8640 * @param setting @c EINA_TRUE to make the gengrid expand
8641 * horizontally, @c EINA_FALSE to expand vertically.
8643 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8644 * in @b columns, from top to bottom and, when the space for a
8645 * column is filled, another one is started on the right, thus
8646 * expanding the grid horizontally. When in "vertical mode"
8647 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8648 * to right and, when the space for a row is filled, another one is
8649 * started below, thus expanding the grid vertically.
8651 * @see elm_gengrid_horizontal_get()
8655 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8658 * Get for what direction a given gengrid widget will expand while
8659 * placing its items.
8661 * @param obj The gengrid object.
8662 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8663 * @c EINA_FALSE if it's set to expand vertically.
8665 * @see elm_gengrid_horizontal_set() for more detais
8669 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8672 * Get the first item in a given gengrid widget
8674 * @param obj The gengrid object
8675 * @return The first item's handle or @c NULL, if there are no
8676 * items in @p obj (and on errors)
8678 * This returns the first item in the @p obj's internal list of
8681 * @see elm_gengrid_last_item_get()
8685 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8688 * Get the last item in a given gengrid widget
8690 * @param obj The gengrid object
8691 * @return The last item's handle or @c NULL, if there are no
8692 * items in @p obj (and on errors)
8694 * This returns the last item in the @p obj's internal list of
8697 * @see elm_gengrid_first_item_get()
8701 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8704 * Get the @b next item in a gengrid widget's internal list of items,
8705 * given a handle to one of those items.
8707 * @param item The gengrid item to fetch next from
8708 * @return The item after @p item, or @c NULL if there's none (and
8711 * This returns the item placed after the @p item, on the container
8714 * @see elm_gengrid_item_prev_get()
8718 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8721 * Get the @b previous item in a gengrid widget's internal list of items,
8722 * given a handle to one of those items.
8724 * @param item The gengrid item to fetch previous from
8725 * @return The item before @p item, or @c NULL if there's none (and
8728 * This returns the item placed before the @p item, on the container
8731 * @see elm_gengrid_item_next_get()
8735 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8738 * Get the gengrid object's handle which contains a given gengrid
8741 * @param item The item to fetch the container from
8742 * @return The gengrid (parent) object
8744 * This returns the gengrid object itself that an item belongs to.
8748 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8751 * Remove a gengrid item from its parent, deleting it.
8753 * @param item The item to be removed.
8754 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8756 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8761 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8764 * Update the contents of a given gengrid item
8766 * @param item The gengrid item
8768 * This updates an item by calling all the item class functions
8769 * again to get the contents, labels and states. Use this when the
8770 * original item data has changed and you want the changes to be
8775 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8778 * Get the Gengrid Item class for the given Gengrid Item.
8780 * @param item The gengrid item
8782 * This returns the Gengrid_Item_Class for the given item. It can be used to examine
8783 * the function pointers and item_style.
8787 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8790 * Get the Gengrid Item class for the given Gengrid Item.
8792 * This sets the Gengrid_Item_Class for the given item. It can be used to examine
8793 * the function pointers and item_style.
8795 * @param item The gengrid item
8796 * @param gic The gengrid item class describing the function pointers and the item style.
8800 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8803 * Return the data associated to a given gengrid item
8805 * @param item The gengrid item.
8806 * @return the data associated with this item.
8808 * This returns the @c data value passed on the
8809 * elm_gengrid_item_append() and related item addition calls.
8811 * @see elm_gengrid_item_append()
8812 * @see elm_gengrid_item_data_set()
8816 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8819 * Set the data associated with a given gengrid item
8821 * @param item The gengrid item
8822 * @param data The data pointer to set on it
8824 * This @b overrides the @c data value passed on the
8825 * elm_gengrid_item_append() and related item addition calls. This
8826 * function @b won't call elm_gengrid_item_update() automatically,
8827 * so you'd issue it afterwards if you want to have the item
8828 * updated to reflect the new data.
8830 * @see elm_gengrid_item_data_get()
8831 * @see elm_gengrid_item_update()
8835 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8838 * Get a given gengrid item's position, relative to the whole
8839 * gengrid's grid area.
8841 * @param item The Gengrid item.
8842 * @param x Pointer to variable to store the item's <b>row number</b>.
8843 * @param y Pointer to variable to store the item's <b>column number</b>.
8845 * This returns the "logical" position of the item within the
8846 * gengrid. For example, @c (0, 1) would stand for first row,
8851 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8854 * Set whether a given gengrid item is selected or not
8856 * @param item The gengrid item
8857 * @param selected Use @c EINA_TRUE, to make it selected, @c
8858 * EINA_FALSE to make it unselected
8860 * This sets the selected state of an item. If multi-selection is
8861 * not enabled on the containing gengrid and @p selected is @c
8862 * EINA_TRUE, any other previously selected items will get
8863 * unselected in favor of this new one.
8865 * @see elm_gengrid_item_selected_get()
8869 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8872 * Get whether a given gengrid item is selected or not
8874 * @param item The gengrid item
8875 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8877 * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
8879 * @see elm_gengrid_item_selected_set() for more details
8883 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8886 * Get the real Evas object created to implement the view of a
8887 * given gengrid item
8889 * @param item The gengrid item.
8890 * @return the Evas object implementing this item's view.
8892 * This returns the actual Evas object used to implement the
8893 * specified gengrid item's view. This may be @c NULL, as it may
8894 * not have been created or may have been deleted, at any time, by
8895 * the gengrid. <b>Do not modify this object</b> (move, resize,
8896 * show, hide, etc.), as the gengrid is controlling it. This
8897 * function is for querying, emitting custom signals or hooking
8898 * lower level callbacks for events on that object. Do not delete
8899 * this object under any circumstances.
8901 * @see elm_gengrid_item_data_get()
8905 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8908 * Show the portion of a gengrid's internal grid containing a given
8909 * item, @b immediately.
8911 * @param item The item to display
8913 * This causes gengrid to @b redraw its viewport's contents to the
8914 * region contining the given @p item item, if it is not fully
8917 * @see elm_gengrid_item_bring_in()
8921 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8924 * Animatedly bring in, to the visible area of a gengrid, a given
8927 * @param item The gengrid item to display
8929 * This causes gengrid to jump to the given @p item and show
8930 * it (by scrolling), if it is not fully visible. This will use
8931 * animation to do so and take a period of time to complete.
8933 * @see elm_gengrid_item_show()
8937 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8940 * Set whether a given gengrid item is disabled or not.
8942 * @param item The gengrid item
8943 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8944 * to enable it back.
8946 * A disabled item cannot be selected or unselected. It will also
8947 * change its appearance, to signal the user it's disabled.
8949 * @see elm_gengrid_item_disabled_get()
8953 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8956 * Get whether a given gengrid item is disabled or not.
8958 * @param item The gengrid item
8959 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8962 * @see elm_gengrid_item_disabled_set() for more details
8966 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8969 * Set the text to be shown in a given gengrid item's tooltips.
8971 * @param item The gengrid item
8972 * @param text The text to set in the content
8974 * This call will setup the text to be used as tooltip to that item
8975 * (analogous to elm_object_tooltip_text_set(), but being item
8976 * tooltips with higher precedence than object tooltips). It can
8977 * have only one tooltip at a time, so any previous tooltip data
8982 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8985 * Set the content to be shown in a given gengrid item's tooltip
8987 * @param item The gengrid item.
8988 * @param func The function returning the tooltip contents.
8989 * @param data What to provide to @a func as callback data/context.
8990 * @param del_cb Called when data is not needed anymore, either when
8991 * another callback replaces @p func, the tooltip is unset with
8992 * elm_gengrid_item_tooltip_unset() or the owner @p item
8993 * dies. This callback receives as its first parameter the
8994 * given @p data, being @c event_info the item handle.
8996 * This call will setup the tooltip's contents to @p item
8997 * (analogous to elm_object_tooltip_content_cb_set(), but being
8998 * item tooltips with higher precedence than object tooltips). It
8999 * can have only one tooltip at a time, so any previous tooltip
9000 * content will get removed. @p func (with @p data) will be called
9001 * every time Elementary needs to show the tooltip and it should
9002 * return a valid Evas object, which will be fully managed by the
9003 * tooltip system, getting deleted when the tooltip is gone.
9007 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);
9010 * Unset a tooltip from a given gengrid item
9012 * @param item gengrid item to remove a previously set tooltip from.
9014 * This call removes any tooltip set on @p item. The callback
9015 * provided as @c del_cb to
9016 * elm_gengrid_item_tooltip_content_cb_set() will be called to
9017 * notify it is not used anymore (and have resources cleaned, if
9020 * @see elm_gengrid_item_tooltip_content_cb_set()
9024 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9027 * Set a different @b style for a given gengrid item's tooltip.
9029 * @param item gengrid item with tooltip set
9030 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9031 * "default", @c "transparent", etc)
9033 * Tooltips can have <b>alternate styles</b> to be displayed on,
9034 * which are defined by the theme set on Elementary. This function
9035 * works analogously as elm_object_tooltip_style_set(), but here
9036 * applied only to gengrid item objects. The default style for
9037 * tooltips is @c "default".
9039 * @note before you set a style you should define a tooltip with
9040 * elm_gengrid_item_tooltip_content_cb_set() or
9041 * elm_gengrid_item_tooltip_text_set()
9043 * @see elm_gengrid_item_tooltip_style_get()
9047 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9050 * Get the style set a given gengrid item's tooltip.
9052 * @param item gengrid item with tooltip already set on.
9053 * @return style the theme style in use, which defaults to
9054 * "default". If the object does not have a tooltip set,
9055 * then @c NULL is returned.
9057 * @see elm_gengrid_item_tooltip_style_set() for more details
9061 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9063 * Set the type of mouse pointer/cursor decoration to be shown,
9064 * when the mouse pointer is over the given gengrid widget item
9066 * @param item gengrid item to customize cursor on
9067 * @param cursor the cursor type's name
9069 * This function works analogously as elm_object_cursor_set(), but
9070 * here the cursor's changing area is restricted to the item's
9071 * area, and not the whole widget's. Note that that item cursors
9072 * have precedence over widget cursors, so that a mouse over @p
9073 * item will always show cursor @p type.
9075 * If this function is called twice for an object, a previously set
9076 * cursor will be unset on the second call.
9078 * @see elm_object_cursor_set()
9079 * @see elm_gengrid_item_cursor_get()
9080 * @see elm_gengrid_item_cursor_unset()
9084 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9087 * Get the type of mouse pointer/cursor decoration set to be shown,
9088 * when the mouse pointer is over the given gengrid widget item
9090 * @param item gengrid item with custom cursor set
9091 * @return the cursor type's name or @c NULL, if no custom cursors
9092 * were set to @p item (and on errors)
9094 * @see elm_object_cursor_get()
9095 * @see elm_gengrid_item_cursor_set() for more details
9096 * @see elm_gengrid_item_cursor_unset()
9100 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9103 * Unset any custom mouse pointer/cursor decoration set to be
9104 * shown, when the mouse pointer is over the given gengrid widget
9105 * item, thus making it show the @b default cursor again.
9107 * @param item a gengrid item
9109 * Use this call to undo any custom settings on this item's cursor
9110 * decoration, bringing it back to defaults (no custom style set).
9112 * @see elm_object_cursor_unset()
9113 * @see elm_gengrid_item_cursor_set() for more details
9117 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9120 * Set a different @b style for a given custom cursor set for a
9123 * @param item gengrid item with custom cursor set
9124 * @param style the <b>theme style</b> to use (e.g. @c "default",
9125 * @c "transparent", etc)
9127 * This function only makes sense when one is using custom mouse
9128 * cursor decorations <b>defined in a theme file</b> , which can
9129 * have, given a cursor name/type, <b>alternate styles</b> on
9130 * it. It works analogously as elm_object_cursor_style_set(), but
9131 * here applied only to gengrid item objects.
9133 * @warning Before you set a cursor style you should have defined a
9134 * custom cursor previously on the item, with
9135 * elm_gengrid_item_cursor_set()
9137 * @see elm_gengrid_item_cursor_engine_only_set()
9138 * @see elm_gengrid_item_cursor_style_get()
9142 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9145 * Get the current @b style set for a given gengrid item's custom
9148 * @param item gengrid item with custom cursor set.
9149 * @return style the cursor style in use. If the object does not
9150 * have a cursor set, then @c NULL is returned.
9152 * @see elm_gengrid_item_cursor_style_set() for more details
9156 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9159 * Set if the (custom) cursor for a given gengrid item should be
9160 * searched in its theme, also, or should only rely on the
9163 * @param item item with custom (custom) cursor already set on
9164 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9165 * only on those provided by the rendering engine, @c EINA_FALSE to
9166 * have them searched on the widget's theme, as well.
9168 * @note This call is of use only if you've set a custom cursor
9169 * for gengrid items, with elm_gengrid_item_cursor_set().
9171 * @note By default, cursors will only be looked for between those
9172 * provided by the rendering engine.
9176 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9179 * Get if the (custom) cursor for a given gengrid item is being
9180 * searched in its theme, also, or is only relying on the rendering
9183 * @param item a gengrid item
9184 * @return @c EINA_TRUE, if cursors are being looked for only on
9185 * those provided by the rendering engine, @c EINA_FALSE if they
9186 * are being searched on the widget's theme, as well.
9188 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9192 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9195 * Remove all items from a given gengrid widget
9197 * @param obj The gengrid object.
9199 * This removes (and deletes) all items in @p obj, leaving it
9202 * @see elm_gengrid_item_del(), to remove just one item.
9206 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9209 * Get the selected item in a given gengrid widget
9211 * @param obj The gengrid object.
9212 * @return The selected item's handleor @c NULL, if none is
9213 * selected at the moment (and on errors)
9215 * This returns the selected item in @p obj. If multi selection is
9216 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9217 * the first item in the list is selected, which might not be very
9218 * useful. For that case, see elm_gengrid_selected_items_get().
9222 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9225 * Get <b>a list</b> of selected items in a given gengrid
9227 * @param obj The gengrid object.
9228 * @return The list of selected items or @c NULL, if none is
9229 * selected at the moment (and on errors)
9231 * This returns a list of the selected items, in the order that
9232 * they appear in the grid. This list is only valid as long as no
9233 * more items are selected or unselected (or unselected implictly
9234 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9237 * @see elm_gengrid_selected_item_get()
9241 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9248 * @defgroup Clock Clock
9250 * @image html img/widget/clock/preview-00.png
9251 * @image latex img/widget/clock/preview-00.eps
9253 * This is a @b digital clock widget. In its default theme, it has a
9254 * vintage "flipping numbers clock" appearance, which will animate
9255 * sheets of individual algarisms individually as time goes by.
9257 * A newly created clock will fetch system's time (already
9258 * considering local time adjustments) to start with, and will tick
9259 * accondingly. It may or may not show seconds.
9261 * Clocks have an @b edition mode. When in it, the sheets will
9262 * display extra arrow indications on the top and bottom and the
9263 * user may click on them to raise or lower the time values. After
9264 * it's told to exit edition mode, it will keep ticking with that
9265 * new time set (it keeps the difference from local time).
9267 * Also, when under edition mode, user clicks on the cited arrows
9268 * which are @b held for some time will make the clock to flip the
9269 * sheet, thus editing the time, continuosly and automatically for
9270 * the user. The interval between sheet flips will keep growing in
9271 * time, so that it helps the user to reach a time which is distant
9274 * The time display is, by default, in military mode (24h), but an
9275 * am/pm indicator may be optionally shown, too, when it will
9278 * Smart callbacks one can register to:
9279 * - "changed" - the clock's user changed the time
9281 * Here is an example on its usage:
9282 * @li @ref clock_example
9291 * Identifiers for which clock digits should be editable, when a
9292 * clock widget is in edition mode. Values may be ORed together to
9293 * make a mask, naturally.
9295 * @see elm_clock_edit_set()
9296 * @see elm_clock_digit_edit_set()
9298 typedef enum _Elm_Clock_Digedit
9300 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9301 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9302 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9303 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9304 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9305 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9306 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9307 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9308 } Elm_Clock_Digedit;
9311 * Add a new clock widget to the given parent Elementary
9312 * (container) object
9314 * @param parent The parent object
9315 * @return a new clock widget handle or @c NULL, on errors
9317 * This function inserts a new clock widget on the canvas.
9321 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9324 * Set a clock widget's time, programmatically
9326 * @param obj The clock widget object
9327 * @param hrs The hours to set
9328 * @param min The minutes to set
9329 * @param sec The secondes to set
9331 * This function updates the time that is showed by the clock
9334 * Values @b must be set within the following ranges:
9335 * - 0 - 23, for hours
9336 * - 0 - 59, for minutes
9337 * - 0 - 59, for seconds,
9339 * even if the clock is not in "military" mode.
9341 * @warning The behavior for values set out of those ranges is @b
9346 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9349 * Get a clock widget's time values
9351 * @param obj The clock object
9352 * @param[out] hrs Pointer to the variable to get the hours value
9353 * @param[out] min Pointer to the variable to get the minutes value
9354 * @param[out] sec Pointer to the variable to get the seconds value
9356 * This function gets the time set for @p obj, returning
9357 * it on the variables passed as the arguments to function
9359 * @note Use @c NULL pointers on the time values you're not
9360 * interested in: they'll be ignored by the function.
9364 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9367 * Set whether a given clock widget is under <b>edition mode</b> or
9368 * under (default) displaying-only mode.
9370 * @param obj The clock object
9371 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9372 * put it back to "displaying only" mode
9374 * This function makes a clock's time to be editable or not <b>by
9375 * user interaction</b>. When in edition mode, clocks @b stop
9376 * ticking, until one brings them back to canonical mode. The
9377 * elm_clock_digit_edit_set() function will influence which digits
9378 * of the clock will be editable. By default, all of them will be
9379 * (#ELM_CLOCK_NONE).
9381 * @note am/pm sheets, if being shown, will @b always be editable
9382 * under edition mode.
9384 * @see elm_clock_edit_get()
9388 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9391 * Retrieve whether a given clock widget is under <b>edition
9392 * mode</b> or under (default) displaying-only mode.
9394 * @param obj The clock object
9395 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9398 * This function retrieves whether the clock's time can be edited
9399 * or not by user interaction.
9401 * @see elm_clock_edit_set() for more details
9405 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9408 * Set what digits of the given clock widget should be editable
9409 * when in edition mode.
9411 * @param obj The clock object
9412 * @param digedit Bit mask indicating the digits to be editable
9413 * (values in #Elm_Clock_Digedit).
9415 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9416 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9419 * @see elm_clock_digit_edit_get()
9423 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9426 * Retrieve what digits of the given clock widget should be
9427 * editable when in edition mode.
9429 * @param obj The clock object
9430 * @return Bit mask indicating the digits to be editable
9431 * (values in #Elm_Clock_Digedit).
9433 * @see elm_clock_digit_edit_set() for more details
9437 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9440 * Set if the given clock widget must show hours in military or
9443 * @param obj The clock object
9444 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9447 * This function sets if the clock must show hours in military or
9448 * am/pm mode. In some countries like Brazil the military mode
9449 * (00-24h-format) is used, in opposition to the USA, where the
9450 * am/pm mode is more commonly used.
9452 * @see elm_clock_show_am_pm_get()
9456 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9459 * Get if the given clock widget shows hours in military or am/pm
9462 * @param obj The clock object
9463 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9466 * This function gets if the clock shows hours in military or am/pm
9469 * @see elm_clock_show_am_pm_set() for more details
9473 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9476 * Set if the given clock widget must show time with seconds or not
9478 * @param obj The clock object
9479 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9481 * This function sets if the given clock must show or not elapsed
9482 * seconds. By default, they are @b not shown.
9484 * @see elm_clock_show_seconds_get()
9488 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9491 * Get whether the given clock widget is showing time with seconds
9494 * @param obj The clock object
9495 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9497 * This function gets whether @p obj is showing or not the elapsed
9500 * @see elm_clock_show_seconds_set()
9504 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9507 * Set the interval on time updates for an user mouse button hold
9508 * on clock widgets' time edition.
9510 * @param obj The clock object
9511 * @param interval The (first) interval value in seconds
9513 * This interval value is @b decreased while the user holds the
9514 * mouse pointer either incrementing or decrementing a given the
9515 * clock digit's value.
9517 * This helps the user to get to a given time distant from the
9518 * current one easier/faster, as it will start to flip quicker and
9519 * quicker on mouse button holds.
9521 * The calculation for the next flip interval value, starting from
9522 * the one set with this call, is the previous interval divided by
9523 * 1.05, so it decreases a little bit.
9525 * The default starting interval value for automatic flips is
9528 * @see elm_clock_interval_get()
9532 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9535 * Get the interval on time updates for an user mouse button hold
9536 * on clock widgets' time edition.
9538 * @param obj The clock object
9539 * @return The (first) interval value, in seconds, set on it
9541 * @see elm_clock_interval_set() for more details
9545 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9552 * @defgroup Layout Layout
9554 * @image html img/widget/layout/preview-00.png
9555 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9557 * @image html img/layout-predefined.png
9558 * @image latex img/layout-predefined.eps width=\textwidth
9560 * This is a container widget that takes a standard Edje design file and
9561 * wraps it very thinly in a widget.
9563 * An Edje design (theme) file has a very wide range of possibilities to
9564 * describe the behavior of elements added to the Layout. Check out the Edje
9565 * documentation and the EDC reference to get more information about what can
9566 * be done with Edje.
9568 * Just like @ref List, @ref Box, and other container widgets, any
9569 * object added to the Layout will become its child, meaning that it will be
9570 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9572 * The Layout widget can contain as many Contents, Boxes or Tables as
9573 * described in its theme file. For instance, objects can be added to
9574 * different Tables by specifying the respective Table part names. The same
9575 * is valid for Content and Box.
9577 * The objects added as child of the Layout will behave as described in the
9578 * part description where they were added. There are 3 possible types of
9579 * parts where a child can be added:
9581 * @section secContent Content (SWALLOW part)
9583 * Only one object can be added to the @c SWALLOW part (but you still can
9584 * have many @c SWALLOW parts and one object on each of them). Use the @c
9585 * elm_object_content_set/get/unset functions to set, retrieve and unset
9586 * objects as content of the @c SWALLOW. After being set to this part, the
9587 * object size, position, visibility, clipping and other description
9588 * properties will be totally controled by the description of the given part
9589 * (inside the Edje theme file).
9591 * One can use @c evas_object_size_hint_* functions on the child to have some
9592 * kind of control over its behavior, but the resulting behavior will still
9593 * depend heavily on the @c SWALLOW part description.
9595 * The Edje theme also can change the part description, based on signals or
9596 * scripts running inside the theme. This change can also be animated. All of
9597 * this will affect the child object set as content accordingly. The object
9598 * size will be changed if the part size is changed, it will animate move if
9599 * the part is moving, and so on.
9601 * The following picture demonstrates a Layout widget with a child object
9602 * added to its @c SWALLOW:
9604 * @image html layout_swallow.png
9605 * @image latex layout_swallow.eps width=\textwidth
9607 * @section secBox Box (BOX part)
9609 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9610 * allows one to add objects to the box and have them distributed along its
9611 * area, accordingly to the specified @a layout property (now by @a layout we
9612 * mean the chosen layouting design of the Box, not the Layout widget
9615 * A similar effect for having a box with its position, size and other things
9616 * controled by the Layout theme would be to create an Elementary @ref Box
9617 * widget and add it as a Content in the @c SWALLOW part.
9619 * The main difference of using the Layout Box is that its behavior, the box
9620 * properties like layouting format, padding, align, etc. will be all
9621 * controled by the theme. This means, for example, that a signal could be
9622 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9623 * handled the signal by changing the box padding, or align, or both. Using
9624 * the Elementary @ref Box widget is not necessarily harder or easier, it
9625 * just depends on the circunstances and requirements.
9627 * The Layout Box can be used through the @c elm_layout_box_* set of
9630 * The following picture demonstrates a Layout widget with many child objects
9631 * added to its @c BOX part:
9633 * @image html layout_box.png
9634 * @image latex layout_box.eps width=\textwidth
9636 * @section secTable Table (TABLE part)
9638 * Just like the @ref secBox, the Layout Table is very similar to the
9639 * Elementary @ref Table widget. It allows one to add objects to the Table
9640 * specifying the row and column where the object should be added, and any
9641 * column or row span if necessary.
9643 * Again, we could have this design by adding a @ref Table widget to the @c
9644 * SWALLOW part using elm_object_content_part_set(). The same difference happens
9645 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9646 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9648 * The Layout Table can be used through the @c elm_layout_table_* set of
9651 * The following picture demonstrates a Layout widget with many child objects
9652 * added to its @c TABLE part:
9654 * @image html layout_table.png
9655 * @image latex layout_table.eps width=\textwidth
9657 * @section secPredef Predefined Layouts
9659 * Another interesting thing about the Layout widget is that it offers some
9660 * predefined themes that come with the default Elementary theme. These
9661 * themes can be set by the call elm_layout_theme_set(), and provide some
9662 * basic functionality depending on the theme used.
9664 * Most of them already send some signals, some already provide a toolbar or
9665 * back and next buttons.
9667 * These are available predefined theme layouts. All of them have class = @c
9668 * layout, group = @c application, and style = one of the following options:
9670 * @li @c toolbar-content - application with toolbar and main content area
9671 * @li @c toolbar-content-back - application with toolbar and main content
9672 * area with a back button and title area
9673 * @li @c toolbar-content-back-next - application with toolbar and main
9674 * content area with a back and next buttons and title area
9675 * @li @c content-back - application with a main content area with a back
9676 * button and title area
9677 * @li @c content-back-next - application with a main content area with a
9678 * back and next buttons and title area
9679 * @li @c toolbar-vbox - application with toolbar and main content area as a
9681 * @li @c toolbar-table - application with toolbar and main content area as a
9684 * @section secExamples Examples
9686 * Some examples of the Layout widget can be found here:
9687 * @li @ref layout_example_01
9688 * @li @ref layout_example_02
9689 * @li @ref layout_example_03
9690 * @li @ref layout_example_edc
9695 * Add a new layout to the parent
9697 * @param parent The parent object
9698 * @return The new object or NULL if it cannot be created
9700 * @see elm_layout_file_set()
9701 * @see elm_layout_theme_set()
9705 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9707 * Set the file that will be used as layout
9709 * @param obj The layout object
9710 * @param file The path to file (edj) that will be used as layout
9711 * @param group The group that the layout belongs in edje file
9713 * @return (1 = success, 0 = error)
9717 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9719 * Set the edje group from the elementary theme that will be used as layout
9721 * @param obj The layout object
9722 * @param clas the clas of the group
9723 * @param group the group
9724 * @param style the style to used
9726 * @return (1 = success, 0 = error)
9730 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9732 * Set the layout content.
9734 * @param obj The layout object
9735 * @param swallow The swallow part name in the edje file
9736 * @param content The child that will be added in this layout object
9738 * Once the content object is set, a previously set one will be deleted.
9739 * If you want to keep that old content object, use the
9740 * elm_object_content_part_unset() function.
9742 * @note In an Edje theme, the part used as a content container is called @c
9743 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9744 * expected to be a part name just like the second parameter of
9745 * elm_layout_box_append().
9747 * @see elm_layout_box_append()
9748 * @see elm_object_content_part_get()
9749 * @see elm_object_content_part_unset()
9754 EINA_DEPRECATED EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9756 * Get the child object in the given content part.
9758 * @param obj The layout object
9759 * @param swallow The SWALLOW part to get its content
9761 * @return The swallowed object or NULL if none or an error occurred
9763 * @see elm_object_content_part_set()
9767 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9769 * Unset the layout content.
9771 * @param obj The layout object
9772 * @param swallow The swallow part name in the edje file
9773 * @return The content that was being used
9775 * Unparent and return the content object which was set for this part.
9777 * @see elm_object_content_part_set()
9781 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9783 * Set the text of the given part
9785 * @param obj The layout object
9786 * @param part The TEXT part where to set the text
9787 * @param text The text to set
9790 * @deprecated use elm_object_text_* instead.
9792 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9794 * Get the text set in the given part
9796 * @param obj The layout object
9797 * @param part The TEXT part to retrieve the text off
9799 * @return The text set in @p part
9802 * @deprecated use elm_object_text_* instead.
9804 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9806 * Append child to layout box part.
9808 * @param obj the layout object
9809 * @param part the box part to which the object will be appended.
9810 * @param child the child object to append to box.
9812 * Once the object is appended, it will become child of the layout. Its
9813 * lifetime will be bound to the layout, whenever the layout dies the child
9814 * will be deleted automatically. One should use elm_layout_box_remove() to
9815 * make this layout forget about the object.
9817 * @see elm_layout_box_prepend()
9818 * @see elm_layout_box_insert_before()
9819 * @see elm_layout_box_insert_at()
9820 * @see elm_layout_box_remove()
9824 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9826 * Prepend child to layout box part.
9828 * @param obj the layout object
9829 * @param part the box part to prepend.
9830 * @param child the child object to prepend to box.
9832 * Once the object is prepended, it will become child of the layout. Its
9833 * lifetime will be bound to the layout, whenever the layout dies the child
9834 * will be deleted automatically. One should use elm_layout_box_remove() to
9835 * make this layout forget about the object.
9837 * @see elm_layout_box_append()
9838 * @see elm_layout_box_insert_before()
9839 * @see elm_layout_box_insert_at()
9840 * @see elm_layout_box_remove()
9844 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9846 * Insert child to layout box part before a reference object.
9848 * @param obj the layout object
9849 * @param part the box part to insert.
9850 * @param child the child object to insert into box.
9851 * @param reference another reference object to insert before in box.
9853 * Once the object is inserted, it will become child of the layout. Its
9854 * lifetime will be bound to the layout, whenever the layout dies the child
9855 * will be deleted automatically. One should use elm_layout_box_remove() to
9856 * make this layout forget about the object.
9858 * @see elm_layout_box_append()
9859 * @see elm_layout_box_prepend()
9860 * @see elm_layout_box_insert_before()
9861 * @see elm_layout_box_remove()
9865 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9867 * Insert child to layout box part at a given position.
9869 * @param obj the layout object
9870 * @param part the box part to insert.
9871 * @param child the child object to insert into box.
9872 * @param pos the numeric position >=0 to insert the child.
9874 * Once the object is inserted, it will become child of the layout. Its
9875 * lifetime will be bound to the layout, whenever the layout dies the child
9876 * will be deleted automatically. One should use elm_layout_box_remove() to
9877 * make this layout forget about the object.
9879 * @see elm_layout_box_append()
9880 * @see elm_layout_box_prepend()
9881 * @see elm_layout_box_insert_before()
9882 * @see elm_layout_box_remove()
9886 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9888 * Remove a child of the given part box.
9890 * @param obj The layout object
9891 * @param part The box part name to remove child.
9892 * @param child The object to remove from box.
9893 * @return The object that was being used, or NULL if not found.
9895 * The object will be removed from the box part and its lifetime will
9896 * not be handled by the layout anymore. This is equivalent to
9897 * elm_object_content_part_unset() for box.
9899 * @see elm_layout_box_append()
9900 * @see elm_layout_box_remove_all()
9904 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9906 * Remove all child of the given part box.
9908 * @param obj The layout object
9909 * @param part The box part name to remove child.
9910 * @param clear If EINA_TRUE, then all objects will be deleted as
9911 * well, otherwise they will just be removed and will be
9912 * dangling on the canvas.
9914 * The objects will be removed from the box part and their lifetime will
9915 * not be handled by the layout anymore. This is equivalent to
9916 * elm_layout_box_remove() for all box children.
9918 * @see elm_layout_box_append()
9919 * @see elm_layout_box_remove()
9923 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9925 * Insert child to layout table part.
9927 * @param obj the layout object
9928 * @param part the box part to pack child.
9929 * @param child_obj the child object to pack into table.
9930 * @param col the column to which the child should be added. (>= 0)
9931 * @param row the row to which the child should be added. (>= 0)
9932 * @param colspan how many columns should be used to store this object. (>=
9934 * @param rowspan how many rows should be used to store this object. (>= 1)
9936 * Once the object is inserted, it will become child of the table. Its
9937 * lifetime will be bound to the layout, and whenever the layout dies the
9938 * child will be deleted automatically. One should use
9939 * elm_layout_table_remove() to make this layout forget about the object.
9941 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9942 * more space than a single cell. For instance, the following code:
9944 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9947 * Would result in an object being added like the following picture:
9949 * @image html layout_colspan.png
9950 * @image latex layout_colspan.eps width=\textwidth
9952 * @see elm_layout_table_unpack()
9953 * @see elm_layout_table_clear()
9957 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);
9959 * Unpack (remove) a child of the given part table.
9961 * @param obj The layout object
9962 * @param part The table part name to remove child.
9963 * @param child_obj The object to remove from table.
9964 * @return The object that was being used, or NULL if not found.
9966 * The object will be unpacked from the table part and its lifetime
9967 * will not be handled by the layout anymore. This is equivalent to
9968 * elm_object_content_part_unset() for table.
9970 * @see elm_layout_table_pack()
9971 * @see elm_layout_table_clear()
9975 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9977 * Remove all child of the given part table.
9979 * @param obj The layout object
9980 * @param part The table part name to remove child.
9981 * @param clear If EINA_TRUE, then all objects will be deleted as
9982 * well, otherwise they will just be removed and will be
9983 * dangling on the canvas.
9985 * The objects will be removed from the table part and their lifetime will
9986 * not be handled by the layout anymore. This is equivalent to
9987 * elm_layout_table_unpack() for all table children.
9989 * @see elm_layout_table_pack()
9990 * @see elm_layout_table_unpack()
9994 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9996 * Get the edje layout
9998 * @param obj The layout object
10000 * @return A Evas_Object with the edje layout settings loaded
10001 * with function elm_layout_file_set
10003 * This returns the edje object. It is not expected to be used to then
10004 * swallow objects via edje_object_part_swallow() for example. Use
10005 * elm_object_content_part_set() instead so child object handling and sizing is
10008 * @note This function should only be used if you really need to call some
10009 * low level Edje function on this edje object. All the common stuff (setting
10010 * text, emitting signals, hooking callbacks to signals, etc.) can be done
10011 * with proper elementary functions.
10013 * @see elm_object_signal_callback_add()
10014 * @see elm_object_signal_emit()
10015 * @see elm_object_text_part_set()
10016 * @see elm_object_content_part_set()
10017 * @see elm_layout_box_append()
10018 * @see elm_layout_table_pack()
10019 * @see elm_layout_data_get()
10023 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10025 * Get the edje data from the given layout
10027 * @param obj The layout object
10028 * @param key The data key
10030 * @return The edje data string
10032 * This function fetches data specified inside the edje theme of this layout.
10033 * This function return NULL if data is not found.
10035 * In EDC this comes from a data block within the group block that @p
10036 * obj was loaded from. E.g.
10043 * item: "key1" "value1";
10044 * item: "key2" "value2";
10052 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10056 * @param obj The layout object
10058 * Manually forces a sizing re-evaluation. This is useful when the minimum
10059 * size required by the edje theme of this layout has changed. The change on
10060 * the minimum size required by the edje theme is not immediately reported to
10061 * the elementary layout, so one needs to call this function in order to tell
10062 * the widget (layout) that it needs to reevaluate its own size.
10064 * The minimum size of the theme is calculated based on minimum size of
10065 * parts, the size of elements inside containers like box and table, etc. All
10066 * of this can change due to state changes, and that's when this function
10067 * should be called.
10069 * Also note that a standard signal of "size,eval" "elm" emitted from the
10070 * edje object will cause this to happen too.
10074 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10077 * Sets a specific cursor for an edje part.
10079 * @param obj The layout object.
10080 * @param part_name a part from loaded edje group.
10081 * @param cursor cursor name to use, see Elementary_Cursor.h
10083 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10084 * part not exists or it has "mouse_events: 0".
10088 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10091 * Get the cursor to be shown when mouse is over an edje part
10093 * @param obj The layout object.
10094 * @param part_name a part from loaded edje group.
10095 * @return the cursor name.
10099 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10102 * Unsets a cursor previously set with elm_layout_part_cursor_set().
10104 * @param obj The layout object.
10105 * @param part_name a part from loaded edje group, that had a cursor set
10106 * with elm_layout_part_cursor_set().
10110 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10113 * Sets a specific cursor style for an edje part.
10115 * @param obj The layout object.
10116 * @param part_name a part from loaded edje group.
10117 * @param style the theme style to use (default, transparent, ...)
10119 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10120 * part not exists or it did not had a cursor set.
10124 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10127 * Gets a specific cursor style for an edje part.
10129 * @param obj The layout object.
10130 * @param part_name a part from loaded edje group.
10132 * @return the theme style in use, defaults to "default". If the
10133 * object does not have a cursor set, then NULL is returned.
10137 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10140 * Sets if the cursor set should be searched on the theme or should use
10141 * the provided by the engine, only.
10143 * @note before you set if should look on theme you should define a
10144 * cursor with elm_layout_part_cursor_set(). By default it will only
10145 * look for cursors provided by the engine.
10147 * @param obj The layout object.
10148 * @param part_name a part from loaded edje group.
10149 * @param engine_only if cursors should be just provided by the engine
10150 * or should also search on widget's theme as well
10152 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10153 * part not exists or it did not had a cursor set.
10157 EAPI Eina_Bool elm_layout_part_cursor_engine_only_set(Evas_Object *obj, const char *part_name, Eina_Bool engine_only) EINA_ARG_NONNULL(1, 2);
10160 * Gets a specific cursor engine_only for an edje part.
10162 * @param obj The layout object.
10163 * @param part_name a part from loaded edje group.
10165 * @return whenever the cursor is just provided by engine or also from theme.
10169 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10172 * @def elm_layout_icon_set
10173 * Convienience macro to set the icon object in a layout that follows the
10174 * Elementary naming convention for its parts.
10178 #define elm_layout_icon_set(_ly, _obj) \
10181 elm_object_content_part_set((_ly), "elm.swallow.icon", (_obj)); \
10182 if ((_obj)) sig = "elm,state,icon,visible"; \
10183 else sig = "elm,state,icon,hidden"; \
10184 elm_object_signal_emit((_ly), sig, "elm"); \
10188 * @def elm_layout_icon_get
10189 * Convienience macro to get the icon object from a layout that follows the
10190 * Elementary naming convention for its parts.
10194 #define elm_layout_icon_get(_ly) \
10195 elm_object_content_part_get((_ly), "elm.swallow.icon")
10198 * @def elm_layout_end_set
10199 * Convienience macro to set the end object in a layout that follows the
10200 * Elementary naming convention for its parts.
10204 #define elm_layout_end_set(_ly, _obj) \
10207 elm_object_content_part_set((_ly), "elm.swallow.end", (_obj)); \
10208 if ((_obj)) sig = "elm,state,end,visible"; \
10209 else sig = "elm,state,end,hidden"; \
10210 elm_object_signal_emit((_ly), sig, "elm"); \
10214 * @def elm_layout_end_get
10215 * Convienience macro to get the end object in a layout that follows the
10216 * Elementary naming convention for its parts.
10220 #define elm_layout_end_get(_ly) \
10221 elm_object_content_part_get((_ly), "elm.swallow.end")
10224 * @def elm_layout_label_set
10225 * Convienience macro to set the label in a layout that follows the
10226 * Elementary naming convention for its parts.
10229 * @deprecated use elm_object_text_* instead.
10231 #define elm_layout_label_set(_ly, _txt) \
10232 elm_layout_text_set((_ly), "elm.text", (_txt))
10235 * @def elm_layout_label_get
10236 * Convenience macro to get the label in a layout that follows the
10237 * Elementary naming convention for its parts.
10240 * @deprecated use elm_object_text_* instead.
10242 #define elm_layout_label_get(_ly) \
10243 elm_layout_text_get((_ly), "elm.text")
10245 /* smart callbacks called:
10246 * "theme,changed" - when elm theme is changed.
10250 * @defgroup Notify Notify
10252 * @image html img/widget/notify/preview-00.png
10253 * @image latex img/widget/notify/preview-00.eps
10255 * Display a container in a particular region of the parent(top, bottom,
10256 * etc). A timeout can be set to automatically hide the notify. This is so
10257 * that, after an evas_object_show() on a notify object, if a timeout was set
10258 * on it, it will @b automatically get hidden after that time.
10260 * Signals that you can add callbacks for are:
10261 * @li "timeout" - when timeout happens on notify and it's hidden
10262 * @li "block,clicked" - when a click outside of the notify happens
10264 * Default contents parts of the notify widget that you can use for are:
10265 * @li "elm.swallow.content" - A content of the notify
10267 * @ref tutorial_notify show usage of the API.
10272 * @brief Possible orient values for notify.
10274 * This values should be used in conjunction to elm_notify_orient_set() to
10275 * set the position in which the notify should appear(relative to its parent)
10276 * and in conjunction with elm_notify_orient_get() to know where the notify
10279 typedef enum _Elm_Notify_Orient
10281 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10282 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10283 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10284 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10285 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10286 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10287 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10288 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10289 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10290 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10291 } Elm_Notify_Orient;
10293 * @brief Add a new notify to the parent
10295 * @param parent The parent object
10296 * @return The new object or NULL if it cannot be created
10298 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10300 * @brief Set the content of the notify widget
10302 * @param obj The notify object
10303 * @param content The content will be filled in this notify object
10305 * Once the content object is set, a previously set one will be deleted. If
10306 * you want to keep that old content object, use the
10307 * elm_notify_content_unset() function.
10309 EINA_DEPRECATED EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10311 * @brief Unset the content of the notify widget
10313 * @param obj The notify object
10314 * @return The content that was being used
10316 * Unparent and return the content object which was set for this widget
10318 * @see elm_notify_content_set()
10320 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10322 * @brief Return the content of the notify widget
10324 * @param obj The notify object
10325 * @return The content that is being used
10327 * @see elm_notify_content_set()
10329 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10331 * @brief Set the notify parent
10333 * @param obj The notify object
10334 * @param content The new parent
10336 * Once the parent object is set, a previously set one will be disconnected
10339 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10341 * @brief Get the notify parent
10343 * @param obj The notify object
10344 * @return The parent
10346 * @see elm_notify_parent_set()
10348 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10350 * @brief Set the orientation
10352 * @param obj The notify object
10353 * @param orient The new orientation
10355 * Sets the position in which the notify will appear in its parent.
10357 * @see @ref Elm_Notify_Orient for possible values.
10359 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10361 * @brief Return the orientation
10362 * @param obj The notify object
10363 * @return The orientation of the notification
10365 * @see elm_notify_orient_set()
10366 * @see Elm_Notify_Orient
10368 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10370 * @brief Set the time interval after which the notify window is going to be
10373 * @param obj The notify object
10374 * @param time The timeout in seconds
10376 * This function sets a timeout and starts the timer controlling when the
10377 * notify is hidden. Since calling evas_object_show() on a notify restarts
10378 * the timer controlling when the notify is hidden, setting this before the
10379 * notify is shown will in effect mean starting the timer when the notify is
10382 * @note Set a value <= 0.0 to disable a running timer.
10384 * @note If the value > 0.0 and the notify is previously visible, the
10385 * timer will be started with this value, canceling any running timer.
10387 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10389 * @brief Return the timeout value (in seconds)
10390 * @param obj the notify object
10392 * @see elm_notify_timeout_set()
10394 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10396 * @brief Sets whether events should be passed to by a click outside
10399 * @param obj The notify object
10400 * @param repeats EINA_TRUE Events are repeats, else no
10402 * When true if the user clicks outside the window the events will be caught
10403 * by the others widgets, else the events are blocked.
10405 * @note The default value is EINA_TRUE.
10407 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10409 * @brief Return true if events are repeat below the notify object
10410 * @param obj the notify object
10412 * @see elm_notify_repeat_events_set()
10414 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10420 * @defgroup Hover Hover
10422 * @image html img/widget/hover/preview-00.png
10423 * @image latex img/widget/hover/preview-00.eps
10425 * A Hover object will hover over its @p parent object at the @p target
10426 * location. Anything in the background will be given a darker coloring to
10427 * indicate that the hover object is on top (at the default theme). When the
10428 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10429 * clicked that @b doesn't cause the hover to be dismissed.
10431 * A Hover object has two parents. One parent that owns it during creation
10432 * and the other parent being the one over which the hover object spans.
10435 * @note The hover object will take up the entire space of @p target
10438 * Elementary has the following styles for the hover widget:
10442 * @li hoversel_vertical
10444 * The following are the available position for content:
10456 * Signals that you can add callbacks for are:
10457 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10458 * @li "smart,changed" - a content object placed under the "smart"
10459 * policy was replaced to a new slot direction.
10461 * See @ref tutorial_hover for more information.
10465 typedef enum _Elm_Hover_Axis
10467 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10468 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10469 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10470 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10473 * @brief Adds a hover object to @p parent
10475 * @param parent The parent object
10476 * @return The hover object or NULL if one could not be created
10478 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10480 * @brief Sets the target object for the hover.
10482 * @param obj The hover object
10483 * @param target The object to center the hover onto. The hover
10485 * This function will cause the hover to be centered on the target object.
10487 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10489 * @brief Gets the target object for the hover.
10491 * @param obj The hover object
10492 * @param parent The object to locate the hover over.
10494 * @see elm_hover_target_set()
10496 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10498 * @brief Sets the parent object for the hover.
10500 * @param obj The hover object
10501 * @param parent The object to locate the hover over.
10503 * This function will cause the hover to take up the entire space that the
10504 * parent object fills.
10506 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10508 * @brief Gets the parent object for the hover.
10510 * @param obj The hover object
10511 * @return The parent object to locate the hover over.
10513 * @see elm_hover_parent_set()
10515 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10517 * @brief Sets the content of the hover object and the direction in which it
10520 * @param obj The hover object
10521 * @param swallow The direction that the object will be displayed
10522 * at. Accepted values are "left", "top-left", "top", "top-right",
10523 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10525 * @param content The content to place at @p swallow
10527 * Once the content object is set for a given direction, a previously
10528 * set one (on the same direction) will be deleted. If you want to
10529 * keep that old content object, use the elm_hover_content_unset()
10532 * All directions may have contents at the same time, except for
10533 * "smart". This is a special placement hint and its use case
10534 * independs of the calculations coming from
10535 * elm_hover_best_content_location_get(). Its use is for cases when
10536 * one desires only one hover content, but with a dinamic special
10537 * placement within the hover area. The content's geometry, whenever
10538 * it changes, will be used to decide on a best location not
10539 * extrapolating the hover's parent object view to show it in (still
10540 * being the hover's target determinant of its medium part -- move and
10541 * resize it to simulate finger sizes, for example). If one of the
10542 * directions other than "smart" are used, a previously content set
10543 * using it will be deleted, and vice-versa.
10545 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10547 * @brief Get the content of the hover object, in a given direction.
10549 * Return the content object which was set for this widget in the
10550 * @p swallow direction.
10552 * @param obj The hover object
10553 * @param swallow The direction that the object was display at.
10554 * @return The content that was being used
10556 * @see elm_hover_content_set()
10558 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10560 * @brief Unset the content of the hover object, in a given direction.
10562 * Unparent and return the content object set at @p swallow direction.
10564 * @param obj The hover object
10565 * @param swallow The direction that the object was display at.
10566 * @return The content that was being used.
10568 * @see elm_hover_content_set()
10570 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10572 * @brief Returns the best swallow location for content in the hover.
10574 * @param obj The hover object
10575 * @param pref_axis The preferred orientation axis for the hover object to use
10576 * @return The edje location to place content into the hover or @c
10579 * Best is defined here as the location at which there is the most available
10582 * @p pref_axis may be one of
10583 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10584 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10585 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10586 * - @c ELM_HOVER_AXIS_BOTH -- both
10588 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10589 * nescessarily be along the horizontal axis("left" or "right"). If
10590 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10591 * be along the vertical axis("top" or "bottom"). Chossing
10592 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10593 * returned position may be in either axis.
10595 * @see elm_hover_content_set()
10597 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10604 * @defgroup Entry Entry
10606 * @image html img/widget/entry/preview-00.png
10607 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10608 * @image html img/widget/entry/preview-01.png
10609 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10610 * @image html img/widget/entry/preview-02.png
10611 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10612 * @image html img/widget/entry/preview-03.png
10613 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10615 * An entry is a convenience widget which shows a box that the user can
10616 * enter text into. Entries by default don't scroll, so they grow to
10617 * accomodate the entire text, resizing the parent window as needed. This
10618 * can be changed with the elm_entry_scrollable_set() function.
10620 * They can also be single line or multi line (the default) and when set
10621 * to multi line mode they support text wrapping in any of the modes
10622 * indicated by #Elm_Wrap_Type.
10624 * Other features include password mode, filtering of inserted text with
10625 * elm_entry_text_filter_append() and related functions, inline "items" and
10626 * formatted markup text.
10628 * @section entry-markup Formatted text
10630 * The markup tags supported by the Entry are defined by the theme, but
10631 * even when writing new themes or extensions it's a good idea to stick to
10632 * a sane default, to maintain coherency and avoid application breakages.
10633 * Currently defined by the default theme are the following tags:
10634 * @li \<br\>: Inserts a line break.
10635 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10637 * @li \<tab\>: Inserts a tab.
10638 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10640 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10641 * @li \<link\>...\</link\>: Underlines the enclosed text.
10642 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10644 * @section entry-special Special markups
10646 * Besides those used to format text, entries support two special markup
10647 * tags used to insert clickable portions of text or items inlined within
10650 * @subsection entry-anchors Anchors
10652 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10653 * \</a\> tags and an event will be generated when this text is clicked,
10657 * This text is outside <a href=anc-01>but this one is an anchor</a>
10660 * The @c href attribute in the opening tag gives the name that will be
10661 * used to identify the anchor and it can be any valid utf8 string.
10663 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10664 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10665 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10666 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10669 * @subsection entry-items Items
10671 * Inlined in the text, any other @c Evas_Object can be inserted by using
10672 * \<item\> tags this way:
10675 * <item size=16x16 vsize=full href=emoticon/haha></item>
10678 * Just like with anchors, the @c href identifies each item, but these need,
10679 * in addition, to indicate their size, which is done using any one of
10680 * @c size, @c absize or @c relsize attributes. These attributes take their
10681 * value in the WxH format, where W is the width and H the height of the
10684 * @li absize: Absolute pixel size for the item. Whatever value is set will
10685 * be the item's size regardless of any scale value the object may have
10686 * been set to. The final line height will be adjusted to fit larger items.
10687 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10689 * @li relsize: Size is adjusted for the item to fit within the current
10692 * Besides their size, items are specificed a @c vsize value that affects
10693 * how their final size and position are calculated. The possible values
10695 * @li ascent: Item will be placed within the line's baseline and its
10696 * ascent. That is, the height between the line where all characters are
10697 * positioned and the highest point in the line. For @c size and @c absize
10698 * items, the descent value will be added to the total line height to make
10699 * them fit. @c relsize items will be adjusted to fit within this space.
10700 * @li full: Items will be placed between the descent and ascent, or the
10701 * lowest point in the line and its highest.
10703 * The next image shows different configurations of items and how they
10704 * are the previously mentioned options affect their sizes. In all cases,
10705 * the green line indicates the ascent, blue for the baseline and red for
10708 * @image html entry_item.png
10709 * @image latex entry_item.eps width=\textwidth
10711 * And another one to show how size differs from absize. In the first one,
10712 * the scale value is set to 1.0, while the second one is using one of 2.0.
10714 * @image html entry_item_scale.png
10715 * @image latex entry_item_scale.eps width=\textwidth
10717 * After the size for an item is calculated, the entry will request an
10718 * object to place in its space. For this, the functions set with
10719 * elm_entry_item_provider_append() and related functions will be called
10720 * in order until one of them returns a @c non-NULL value. If no providers
10721 * are available, or all of them return @c NULL, then the entry falls back
10722 * to one of the internal defaults, provided the name matches with one of
10725 * All of the following are currently supported:
10728 * - emoticon/angry-shout
10729 * - emoticon/crazy-laugh
10730 * - emoticon/evil-laugh
10732 * - emoticon/goggle-smile
10733 * - emoticon/grumpy
10734 * - emoticon/grumpy-smile
10735 * - emoticon/guilty
10736 * - emoticon/guilty-smile
10738 * - emoticon/half-smile
10739 * - emoticon/happy-panting
10741 * - emoticon/indifferent
10743 * - emoticon/knowing-grin
10745 * - emoticon/little-bit-sorry
10746 * - emoticon/love-lots
10748 * - emoticon/minimal-smile
10749 * - emoticon/not-happy
10750 * - emoticon/not-impressed
10752 * - emoticon/opensmile
10755 * - emoticon/squint-laugh
10756 * - emoticon/surprised
10757 * - emoticon/suspicious
10758 * - emoticon/tongue-dangling
10759 * - emoticon/tongue-poke
10761 * - emoticon/unhappy
10762 * - emoticon/very-sorry
10765 * - emoticon/worried
10768 * Alternatively, an item may reference an image by its path, using
10769 * the URI form @c file:///path/to/an/image.png and the entry will then
10770 * use that image for the item.
10772 * @section entry-files Loading and saving files
10774 * Entries have convinience functions to load text from a file and save
10775 * changes back to it after a short delay. The automatic saving is enabled
10776 * by default, but can be disabled with elm_entry_autosave_set() and files
10777 * can be loaded directly as plain text or have any markup in them
10778 * recognized. See elm_entry_file_set() for more details.
10780 * @section entry-signals Emitted signals
10782 * This widget emits the following signals:
10784 * @li "changed": The text within the entry was changed.
10785 * @li "changed,user": The text within the entry was changed because of user interaction.
10786 * @li "activated": The enter key was pressed on a single line entry.
10787 * @li "press": A mouse button has been pressed on the entry.
10788 * @li "longpressed": A mouse button has been pressed and held for a couple
10790 * @li "clicked": The entry has been clicked (mouse press and release).
10791 * @li "clicked,double": The entry has been double clicked.
10792 * @li "clicked,triple": The entry has been triple clicked.
10793 * @li "focused": The entry has received focus.
10794 * @li "unfocused": The entry has lost focus.
10795 * @li "selection,paste": A paste of the clipboard contents was requested.
10796 * @li "selection,copy": A copy of the selected text into the clipboard was
10798 * @li "selection,cut": A cut of the selected text into the clipboard was
10800 * @li "selection,start": A selection has begun and no previous selection
10802 * @li "selection,changed": The current selection has changed.
10803 * @li "selection,cleared": The current selection has been cleared.
10804 * @li "cursor,changed": The cursor has changed position.
10805 * @li "anchor,clicked": An anchor has been clicked. The event_info
10806 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10807 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10808 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10809 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10810 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10811 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10812 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10813 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10814 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10815 * @li "preedit,changed": The preedit string has changed.
10816 * @li "language,changed": Program language changed.
10818 * @section entry-examples
10820 * An overview of the Entry API can be seen in @ref entry_example_01
10825 * @typedef Elm_Entry_Anchor_Info
10827 * The info sent in the callback for the "anchor,clicked" signals emitted
10830 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10832 * @struct _Elm_Entry_Anchor_Info
10834 * The info sent in the callback for the "anchor,clicked" signals emitted
10837 struct _Elm_Entry_Anchor_Info
10839 const char *name; /**< The name of the anchor, as stated in its href */
10840 int button; /**< The mouse button used to click on it */
10841 Evas_Coord x, /**< Anchor geometry, relative to canvas */
10842 y, /**< Anchor geometry, relative to canvas */
10843 w, /**< Anchor geometry, relative to canvas */
10844 h; /**< Anchor geometry, relative to canvas */
10847 * @typedef Elm_Entry_Filter_Cb
10848 * This callback type is used by entry filters to modify text.
10849 * @param data The data specified as the last param when adding the filter
10850 * @param entry The entry object
10851 * @param text A pointer to the location of the text being filtered. This data can be modified,
10852 * but any additional allocations must be managed by the user.
10853 * @see elm_entry_text_filter_append
10854 * @see elm_entry_text_filter_prepend
10856 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10859 * This adds an entry to @p parent object.
10861 * By default, entries are:
10865 * @li autosave is enabled
10867 * @param parent The parent object
10868 * @return The new object or NULL if it cannot be created
10870 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10872 * Sets the entry to single line mode.
10874 * In single line mode, entries don't ever wrap when the text reaches the
10875 * edge, and instead they keep growing horizontally. Pressing the @c Enter
10876 * key will generate an @c "activate" event instead of adding a new line.
10878 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10879 * and pressing enter will break the text into a different line
10880 * without generating any events.
10882 * @param obj The entry object
10883 * @param single_line If true, the text in the entry
10884 * will be on a single line.
10886 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10888 * Gets whether the entry is set to be single line.
10890 * @param obj The entry object
10891 * @return single_line If true, the text in the entry is set to display
10892 * on a single line.
10894 * @see elm_entry_single_line_set()
10896 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10898 * Sets the entry to password mode.
10900 * In password mode, entries are implicitly single line and the display of
10901 * any text in them is replaced with asterisks (*).
10903 * @param obj The entry object
10904 * @param password If true, password mode is enabled.
10906 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10908 * Gets whether the entry is set to password mode.
10910 * @param obj The entry object
10911 * @return If true, the entry is set to display all characters
10912 * as asterisks (*).
10914 * @see elm_entry_password_set()
10916 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10918 * This sets the text displayed within the entry to @p entry.
10920 * @param obj The entry object
10921 * @param entry The text to be displayed
10923 * @deprecated Use elm_object_text_set() instead.
10924 * @note Using this function bypasses text filters
10926 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10928 * This returns the text currently shown in object @p entry.
10929 * See also elm_entry_entry_set().
10931 * @param obj The entry object
10932 * @return The currently displayed text or NULL on failure
10934 * @deprecated Use elm_object_text_get() instead.
10936 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10938 * Appends @p entry to the text of the entry.
10940 * Adds the text in @p entry to the end of any text already present in the
10943 * The appended text is subject to any filters set for the widget.
10945 * @param obj The entry object
10946 * @param entry The text to be displayed
10948 * @see elm_entry_text_filter_append()
10950 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10952 * Gets whether the entry is empty.
10954 * Empty means no text at all. If there are any markup tags, like an item
10955 * tag for which no provider finds anything, and no text is displayed, this
10956 * function still returns EINA_FALSE.
10958 * @param obj The entry object
10959 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10961 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10963 * Gets any selected text within the entry.
10965 * If there's any selected text in the entry, this function returns it as
10966 * a string in markup format. NULL is returned if no selection exists or
10967 * if an error occurred.
10969 * The returned value points to an internal string and should not be freed
10970 * or modified in any way. If the @p entry object is deleted or its
10971 * contents are changed, the returned pointer should be considered invalid.
10973 * @param obj The entry object
10974 * @return The selected text within the entry or NULL on failure
10976 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10978 * Inserts the given text into the entry at the current cursor position.
10980 * This inserts text at the cursor position as if it was typed
10981 * by the user (note that this also allows markup which a user
10982 * can't just "type" as it would be converted to escaped text, so this
10983 * call can be used to insert things like emoticon items or bold push/pop
10984 * tags, other font and color change tags etc.)
10986 * If any selection exists, it will be replaced by the inserted text.
10988 * The inserted text is subject to any filters set for the widget.
10990 * @param obj The entry object
10991 * @param entry The text to insert
10993 * @see elm_entry_text_filter_append()
10995 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10997 * Set the line wrap type to use on multi-line entries.
10999 * Sets the wrap type used by the entry to any of the specified in
11000 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11001 * line (without inserting a line break or paragraph separator) when it
11002 * reaches the far edge of the widget.
11004 * Note that this only makes sense for multi-line entries. A widget set
11005 * to be single line will never wrap.
11007 * @param obj The entry object
11008 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11010 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11011 EINA_DEPRECATED EAPI void elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
11013 * Gets the wrap mode the entry was set to use.
11015 * @param obj The entry object
11016 * @return Wrap type
11018 * @see also elm_entry_line_wrap_set()
11020 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11022 * Sets if the entry is to be editable or not.
11024 * By default, entries are editable and when focused, any text input by the
11025 * user will be inserted at the current cursor position. But calling this
11026 * function with @p editable as EINA_FALSE will prevent the user from
11027 * inputting text into the entry.
11029 * The only way to change the text of a non-editable entry is to use
11030 * elm_object_text_set(), elm_entry_entry_insert() and other related
11033 * @param obj The entry object
11034 * @param editable If EINA_TRUE, user input will be inserted in the entry,
11035 * if not, the entry is read-only and no user input is allowed.
11037 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11039 * Gets whether the entry is editable or not.
11041 * @param obj The entry object
11042 * @return If true, the entry is editable by the user.
11043 * If false, it is not editable by the user
11045 * @see elm_entry_editable_set()
11047 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11049 * This drops any existing text selection within the entry.
11051 * @param obj The entry object
11053 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11055 * This selects all text within the entry.
11057 * @param obj The entry object
11059 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11061 * This moves the cursor one place to the right within the entry.
11063 * @param obj The entry object
11064 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11066 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11068 * This moves the cursor one place to the left within the entry.
11070 * @param obj The entry object
11071 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11073 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11075 * This moves the cursor one line up within the entry.
11077 * @param obj The entry object
11078 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11080 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11082 * This moves the cursor one line down within the entry.
11084 * @param obj The entry object
11085 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11087 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11089 * This moves the cursor to the beginning of the entry.
11091 * @param obj The entry object
11093 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11095 * This moves the cursor to the end of the entry.
11097 * @param obj The entry object
11099 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11101 * This moves the cursor to the beginning of the current line.
11103 * @param obj The entry object
11105 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11107 * This moves the cursor to the end of the current line.
11109 * @param obj The entry object
11111 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11113 * This begins a selection within the entry as though
11114 * the user were holding down the mouse button to make a selection.
11116 * @param obj The entry object
11118 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11120 * This ends a selection within the entry as though
11121 * the user had just released the mouse button while making a selection.
11123 * @param obj The entry object
11125 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11127 * Gets whether a format node exists at the current cursor position.
11129 * A format node is anything that defines how the text is rendered. It can
11130 * be a visible format node, such as a line break or a paragraph separator,
11131 * or an invisible one, such as bold begin or end tag.
11132 * This function returns whether any format node exists at the current
11135 * @param obj The entry object
11136 * @return EINA_TRUE if the current cursor position contains a format node,
11137 * EINA_FALSE otherwise.
11139 * @see elm_entry_cursor_is_visible_format_get()
11141 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11143 * Gets if the current cursor position holds a visible format node.
11145 * @param obj The entry object
11146 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11147 * if it's an invisible one or no format exists.
11149 * @see elm_entry_cursor_is_format_get()
11151 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11153 * Gets the character pointed by the cursor at its current position.
11155 * This function returns a string with the utf8 character stored at the
11156 * current cursor position.
11157 * Only the text is returned, any format that may exist will not be part
11158 * of the return value.
11160 * @param obj The entry object
11161 * @return The text pointed by the cursors.
11163 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11165 * This function returns the geometry of the cursor.
11167 * It's useful if you want to draw something on the cursor (or where it is),
11168 * or for example in the case of scrolled entry where you want to show the
11171 * @param obj The entry object
11172 * @param x returned geometry
11173 * @param y returned geometry
11174 * @param w returned geometry
11175 * @param h returned geometry
11176 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11178 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);
11180 * Sets the cursor position in the entry to the given value
11182 * The value in @p pos is the index of the character position within the
11183 * contents of the string as returned by elm_entry_cursor_pos_get().
11185 * @param obj The entry object
11186 * @param pos The position of the cursor
11188 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11190 * Retrieves the current position of the cursor in the entry
11192 * @param obj The entry object
11193 * @return The cursor position
11195 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11197 * This executes a "cut" action on the selected text in the entry.
11199 * @param obj The entry object
11201 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11203 * This executes a "copy" action on the selected text in the entry.
11205 * @param obj The entry object
11207 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11209 * This executes a "paste" action in the entry.
11211 * @param obj The entry object
11213 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11215 * This clears and frees the items in a entry's contextual (longpress)
11218 * @param obj The entry object
11220 * @see elm_entry_context_menu_item_add()
11222 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11224 * This adds an item to the entry's contextual menu.
11226 * A longpress on an entry will make the contextual menu show up, if this
11227 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11228 * By default, this menu provides a few options like enabling selection mode,
11229 * which is useful on embedded devices that need to be explicit about it,
11230 * and when a selection exists it also shows the copy and cut actions.
11232 * With this function, developers can add other options to this menu to
11233 * perform any action they deem necessary.
11235 * @param obj The entry object
11236 * @param label The item's text label
11237 * @param icon_file The item's icon file
11238 * @param icon_type The item's icon type
11239 * @param func The callback to execute when the item is clicked
11240 * @param data The data to associate with the item for related functions
11242 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);
11244 * This disables the entry's contextual (longpress) menu.
11246 * @param obj The entry object
11247 * @param disabled If true, the menu is disabled
11249 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11251 * This returns whether the entry's contextual (longpress) menu is
11254 * @param obj The entry object
11255 * @return If true, the menu is disabled
11257 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11259 * This appends a custom item provider to the list for that entry
11261 * This appends the given callback. The list is walked from beginning to end
11262 * with each function called given the item href string in the text. If the
11263 * function returns an object handle other than NULL (it should create an
11264 * object to do this), then this object is used to replace that item. If
11265 * not the next provider is called until one provides an item object, or the
11266 * default provider in entry does.
11268 * @param obj The entry object
11269 * @param func The function called to provide the item object
11270 * @param data The data passed to @p func
11272 * @see @ref entry-items
11274 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);
11276 * This prepends a custom item provider to the list for that entry
11278 * This prepends the given callback. See elm_entry_item_provider_append() for
11281 * @param obj The entry object
11282 * @param func The function called to provide the item object
11283 * @param data The data passed to @p func
11285 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);
11287 * This removes a custom item provider to the list for that entry
11289 * This removes the given callback. See elm_entry_item_provider_append() for
11292 * @param obj The entry object
11293 * @param func The function called to provide the item object
11294 * @param data The data passed to @p func
11296 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);
11298 * Append a filter function for text inserted in the entry
11300 * Append the given callback to the list. This functions will be called
11301 * whenever any text is inserted into the entry, with the text to be inserted
11302 * as a parameter. The callback function is free to alter the text in any way
11303 * it wants, but it must remember to free the given pointer and update it.
11304 * If the new text is to be discarded, the function can free it and set its
11305 * text parameter to NULL. This will also prevent any following filters from
11308 * @param obj The entry object
11309 * @param func The function to use as text filter
11310 * @param data User data to pass to @p func
11312 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11314 * Prepend a filter function for text insdrted in the entry
11316 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11317 * for more information
11319 * @param obj The entry object
11320 * @param func The function to use as text filter
11321 * @param data User data to pass to @p func
11323 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11325 * Remove a filter from the list
11327 * Removes the given callback from the filter list. See
11328 * elm_entry_text_filter_append() for more information.
11330 * @param obj The entry object
11331 * @param func The filter function to remove
11332 * @param data The user data passed when adding the function
11334 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11336 * This converts a markup (HTML-like) string into UTF-8.
11338 * The returned string is a malloc'ed buffer and it should be freed when
11339 * not needed anymore.
11341 * @param s The string (in markup) to be converted
11342 * @return The converted string (in UTF-8). It should be freed.
11344 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11346 * This converts a UTF-8 string into markup (HTML-like).
11348 * The returned string is a malloc'ed buffer and it should be freed when
11349 * not needed anymore.
11351 * @param s The string (in UTF-8) to be converted
11352 * @return The converted string (in markup). It should be freed.
11354 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11356 * This sets the file (and implicitly loads it) for the text to display and
11357 * then edit. All changes are written back to the file after a short delay if
11358 * the entry object is set to autosave (which is the default).
11360 * If the entry had any other file set previously, any changes made to it
11361 * will be saved if the autosave feature is enabled, otherwise, the file
11362 * will be silently discarded and any non-saved changes will be lost.
11364 * @param obj The entry object
11365 * @param file The path to the file to load and save
11366 * @param format The file format
11368 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11370 * Gets the file being edited by the entry.
11372 * This function can be used to retrieve any file set on the entry for
11373 * edition, along with the format used to load and save it.
11375 * @param obj The entry object
11376 * @param file The path to the file to load and save
11377 * @param format The file format
11379 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11381 * This function writes any changes made to the file set with
11382 * elm_entry_file_set()
11384 * @param obj The entry object
11386 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11388 * This sets the entry object to 'autosave' the loaded text file or not.
11390 * @param obj The entry object
11391 * @param autosave Autosave the loaded file or not
11393 * @see elm_entry_file_set()
11395 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11397 * This gets the entry object's 'autosave' status.
11399 * @param obj The entry object
11400 * @return Autosave the loaded file or not
11402 * @see elm_entry_file_set()
11404 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11406 * Control pasting of text and images for the widget.
11408 * Normally the entry allows both text and images to be pasted. By setting
11409 * textonly to be true, this prevents images from being pasted.
11411 * Note this only changes the behaviour of text.
11413 * @param obj The entry object
11414 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11415 * text+image+other.
11417 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11419 * Getting elm_entry text paste/drop mode.
11421 * In textonly mode, only text may be pasted or dropped into the widget.
11423 * @param obj The entry object
11424 * @return If the widget only accepts text from pastes.
11426 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11428 * Enable or disable scrolling in entry
11430 * Normally the entry is not scrollable unless you enable it with this call.
11432 * @param obj The entry object
11433 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11435 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11437 * Get the scrollable state of the entry
11439 * Normally the entry is not scrollable. This gets the scrollable state
11440 * of the entry. See elm_entry_scrollable_set() for more information.
11442 * @param obj The entry object
11443 * @return The scrollable state
11445 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11447 * This sets a widget to be displayed to the left of a scrolled entry.
11449 * @param obj The scrolled entry object
11450 * @param icon The widget to display on the left side of the scrolled
11453 * @note A previously set widget will be destroyed.
11454 * @note If the object being set does not have minimum size hints set,
11455 * it won't get properly displayed.
11457 * @see elm_entry_end_set()
11459 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11461 * Gets the leftmost widget of the scrolled entry. This object is
11462 * owned by the scrolled entry and should not be modified.
11464 * @param obj The scrolled entry object
11465 * @return the left widget inside the scroller
11467 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11469 * Unset the leftmost widget of the scrolled entry, unparenting and
11472 * @param obj The scrolled entry object
11473 * @return the previously set icon sub-object of this entry, on
11476 * @see elm_entry_icon_set()
11478 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11480 * Sets the visibility of the left-side widget of the scrolled entry,
11481 * set by elm_entry_icon_set().
11483 * @param obj The scrolled entry object
11484 * @param setting EINA_TRUE if the object should be displayed,
11485 * EINA_FALSE if not.
11487 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11489 * This sets a widget to be displayed to the end of a scrolled entry.
11491 * @param obj The scrolled entry object
11492 * @param end The widget to display on the right side of the scrolled
11495 * @note A previously set widget will be destroyed.
11496 * @note If the object being set does not have minimum size hints set,
11497 * it won't get properly displayed.
11499 * @see elm_entry_icon_set
11501 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11503 * Gets the endmost widget of the scrolled entry. This object is owned
11504 * by the scrolled entry and should not be modified.
11506 * @param obj The scrolled entry object
11507 * @return the right widget inside the scroller
11509 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11511 * Unset the endmost widget of the scrolled entry, unparenting and
11514 * @param obj The scrolled entry object
11515 * @return the previously set icon sub-object of this entry, on
11518 * @see elm_entry_icon_set()
11520 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11522 * Sets the visibility of the end widget of the scrolled entry, set by
11523 * elm_entry_end_set().
11525 * @param obj The scrolled entry object
11526 * @param setting EINA_TRUE if the object should be displayed,
11527 * EINA_FALSE if not.
11529 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11531 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11534 * Setting an entry to single-line mode with elm_entry_single_line_set()
11535 * will automatically disable the display of scrollbars when the entry
11536 * moves inside its scroller.
11538 * @param obj The scrolled entry object
11539 * @param h The horizontal scrollbar policy to apply
11540 * @param v The vertical scrollbar policy to apply
11542 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11544 * This enables/disables bouncing within the entry.
11546 * This function sets whether the entry will bounce when scrolling reaches
11547 * the end of the contained entry.
11549 * @param obj The scrolled entry object
11550 * @param h The horizontal bounce state
11551 * @param v The vertical bounce state
11553 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11555 * Get the bounce mode
11557 * @param obj The Entry object
11558 * @param h_bounce Allow bounce horizontally
11559 * @param v_bounce Allow bounce vertically
11561 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11563 /* pre-made filters for entries */
11565 * @typedef Elm_Entry_Filter_Limit_Size
11567 * Data for the elm_entry_filter_limit_size() entry filter.
11569 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11571 * @struct _Elm_Entry_Filter_Limit_Size
11573 * Data for the elm_entry_filter_limit_size() entry filter.
11575 struct _Elm_Entry_Filter_Limit_Size
11577 int max_char_count; /**< The maximum number of characters allowed. */
11578 int max_byte_count; /**< The maximum number of bytes allowed*/
11581 * Filter inserted text based on user defined character and byte limits
11583 * Add this filter to an entry to limit the characters that it will accept
11584 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11585 * The funtion works on the UTF-8 representation of the string, converting
11586 * it from the set markup, thus not accounting for any format in it.
11588 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11589 * it as data when setting the filter. In it, it's possible to set limits
11590 * by character count or bytes (any of them is disabled if 0), and both can
11591 * be set at the same time. In that case, it first checks for characters,
11594 * The function will cut the inserted text in order to allow only the first
11595 * number of characters that are still allowed. The cut is made in
11596 * characters, even when limiting by bytes, in order to always contain
11597 * valid ones and avoid half unicode characters making it in.
11599 * This filter, like any others, does not apply when setting the entry text
11600 * directly with elm_object_text_set() (or the deprecated
11601 * elm_entry_entry_set()).
11603 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11605 * @typedef Elm_Entry_Filter_Accept_Set
11607 * Data for the elm_entry_filter_accept_set() entry filter.
11609 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11611 * @struct _Elm_Entry_Filter_Accept_Set
11613 * Data for the elm_entry_filter_accept_set() entry filter.
11615 struct _Elm_Entry_Filter_Accept_Set
11617 const char *accepted; /**< Set of characters accepted in the entry. */
11618 const char *rejected; /**< Set of characters rejected from the entry. */
11621 * Filter inserted text based on accepted or rejected sets of characters
11623 * Add this filter to an entry to restrict the set of accepted characters
11624 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11625 * This structure contains both accepted and rejected sets, but they are
11626 * mutually exclusive.
11628 * The @c accepted set takes preference, so if it is set, the filter will
11629 * only work based on the accepted characters, ignoring anything in the
11630 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11632 * In both cases, the function filters by matching utf8 characters to the
11633 * raw markup text, so it can be used to remove formatting tags.
11635 * This filter, like any others, does not apply when setting the entry text
11636 * directly with elm_object_text_set() (or the deprecated
11637 * elm_entry_entry_set()).
11639 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11641 * Set the input panel layout of the entry
11643 * @param obj The entry object
11644 * @param layout layout type
11646 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11648 * Get the input panel layout of the entry
11650 * @param obj The entry object
11651 * @return layout type
11653 * @see elm_entry_input_panel_layout_set
11655 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11657 * Set the autocapitalization type on the immodule.
11659 * @param obj The entry object
11660 * @param autocapital_type The type of autocapitalization
11662 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
11664 * Retrieve the autocapitalization type on the immodule.
11666 * @param obj The entry object
11667 * @return autocapitalization type
11669 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11671 * Sets the attribute to show the input panel automatically.
11673 * @param obj The entry object
11674 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
11676 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
11678 * Retrieve the attribute to show the input panel automatically.
11680 * @param obj The entry object
11681 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
11683 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11685 EAPI void elm_entry_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11686 EAPI void elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
11687 EAPI void elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
11688 EAPI void elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
11689 EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
11690 EAPI void elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
11691 EAPI void elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
11693 EINA_DEPRECATED EAPI void elm_entry_wrap_width_set(Evas_Object *obj, Evas_Coord w);
11694 EINA_DEPRECATED EAPI Evas_Coord elm_entry_wrap_width_get(const Evas_Object *obj);
11695 EINA_DEPRECATED EAPI void elm_entry_fontsize_set(Evas_Object *obj, int fontsize);
11696 EINA_DEPRECATED EAPI void elm_entry_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11697 EINA_DEPRECATED EAPI void elm_entry_text_align_set(Evas_Object *obj, const char *alignmode);
11703 /* composite widgets - these basically put together basic widgets above
11704 * in convenient packages that do more than basic stuff */
11708 * @defgroup Anchorview Anchorview
11710 * @image html img/widget/anchorview/preview-00.png
11711 * @image latex img/widget/anchorview/preview-00.eps
11713 * Anchorview is for displaying text that contains markup with anchors
11714 * like <c>\<a href=1234\>something\</\></c> in it.
11716 * Besides being styled differently, the anchorview widget provides the
11717 * necessary functionality so that clicking on these anchors brings up a
11718 * popup with user defined content such as "call", "add to contacts" or
11719 * "open web page". This popup is provided using the @ref Hover widget.
11721 * This widget is very similar to @ref Anchorblock, so refer to that
11722 * widget for an example. The only difference Anchorview has is that the
11723 * widget is already provided with scrolling functionality, so if the
11724 * text set to it is too large to fit in the given space, it will scroll,
11725 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11726 * text can be displayed.
11728 * This widget emits the following signals:
11729 * @li "anchor,clicked": will be called when an anchor is clicked. The
11730 * @p event_info parameter on the callback will be a pointer of type
11731 * ::Elm_Entry_Anchorview_Info.
11733 * See @ref Anchorblock for an example on how to use both of them.
11742 * @typedef Elm_Entry_Anchorview_Info
11744 * The info sent in the callback for "anchor,clicked" signals emitted by
11745 * the Anchorview widget.
11747 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11749 * @struct _Elm_Entry_Anchorview_Info
11751 * The info sent in the callback for "anchor,clicked" signals emitted by
11752 * the Anchorview widget.
11754 struct _Elm_Entry_Anchorview_Info
11756 const char *name; /**< Name of the anchor, as indicated in its href
11758 int button; /**< The mouse button used to click on it */
11759 Evas_Object *hover; /**< The hover object to use for the popup */
11761 Evas_Coord x, y, w, h;
11762 } anchor, /**< Geometry selection of text used as anchor */
11763 hover_parent; /**< Geometry of the object used as parent by the
11765 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11766 for content on the left side of
11767 the hover. Before calling the
11768 callback, the widget will make the
11769 necessary calculations to check
11770 which sides are fit to be set with
11771 content, based on the position the
11772 hover is activated and its distance
11773 to the edges of its parent object
11775 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11776 the right side of the hover.
11777 See @ref hover_left */
11778 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11779 of the hover. See @ref hover_left */
11780 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11781 below the hover. See @ref
11785 * Add a new Anchorview object
11787 * @param parent The parent object
11788 * @return The new object or NULL if it cannot be created
11790 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11792 * Set the text to show in the anchorview
11794 * Sets the text of the anchorview to @p text. This text can include markup
11795 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11796 * text that will be specially styled and react to click events, ended with
11797 * either of \</a\> or \</\>. When clicked, the anchor will emit an
11798 * "anchor,clicked" signal that you can attach a callback to with
11799 * evas_object_smart_callback_add(). The name of the anchor given in the
11800 * event info struct will be the one set in the href attribute, in this
11801 * case, anchorname.
11803 * Other markup can be used to style the text in different ways, but it's
11804 * up to the style defined in the theme which tags do what.
11805 * @deprecated use elm_object_text_set() instead.
11807 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11809 * Get the markup text set for the anchorview
11811 * Retrieves the text set on the anchorview, with markup tags included.
11813 * @param obj The anchorview object
11814 * @return The markup text set or @c NULL if nothing was set or an error
11816 * @deprecated use elm_object_text_set() instead.
11818 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11820 * Set the parent of the hover popup
11822 * Sets the parent object to use by the hover created by the anchorview
11823 * when an anchor is clicked. See @ref Hover for more details on this.
11824 * If no parent is set, the same anchorview object will be used.
11826 * @param obj The anchorview object
11827 * @param parent The object to use as parent for the hover
11829 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11831 * Get the parent of the hover popup
11833 * Get the object used as parent for the hover created by the anchorview
11834 * widget. See @ref Hover for more details on this.
11836 * @param obj The anchorview object
11837 * @return The object used as parent for the hover, NULL if none is set.
11839 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11841 * Set the style that the hover should use
11843 * When creating the popup hover, anchorview will request that it's
11844 * themed according to @p style.
11846 * @param obj The anchorview object
11847 * @param style The style to use for the underlying hover
11849 * @see elm_object_style_set()
11851 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11853 * Get the style that the hover should use
11855 * Get the style the hover created by anchorview will use.
11857 * @param obj The anchorview object
11858 * @return The style to use by the hover. NULL means the default is used.
11860 * @see elm_object_style_set()
11862 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11864 * Ends the hover popup in the anchorview
11866 * When an anchor is clicked, the anchorview widget will create a hover
11867 * object to use as a popup with user provided content. This function
11868 * terminates this popup, returning the anchorview to its normal state.
11870 * @param obj The anchorview object
11872 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11874 * Set bouncing behaviour when the scrolled content reaches an edge
11876 * Tell the internal scroller object whether it should bounce or not
11877 * when it reaches the respective edges for each axis.
11879 * @param obj The anchorview object
11880 * @param h_bounce Whether to bounce or not in the horizontal axis
11881 * @param v_bounce Whether to bounce or not in the vertical axis
11883 * @see elm_scroller_bounce_set()
11885 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11887 * Get the set bouncing behaviour of the internal scroller
11889 * Get whether the internal scroller should bounce when the edge of each
11890 * axis is reached scrolling.
11892 * @param obj The anchorview object
11893 * @param h_bounce Pointer where to store the bounce state of the horizontal
11895 * @param v_bounce Pointer where to store the bounce state of the vertical
11898 * @see elm_scroller_bounce_get()
11900 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11902 * Appends a custom item provider to the given anchorview
11904 * Appends the given function to the list of items providers. This list is
11905 * called, one function at a time, with the given @p data pointer, the
11906 * anchorview object and, in the @p item parameter, the item name as
11907 * referenced in its href string. Following functions in the list will be
11908 * called in order until one of them returns something different to NULL,
11909 * which should be an Evas_Object which will be used in place of the item
11912 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11913 * href=item/name\>\</item\>
11915 * @param obj The anchorview object
11916 * @param func The function to add to the list of providers
11917 * @param data User data that will be passed to the callback function
11919 * @see elm_entry_item_provider_append()
11921 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);
11923 * Prepend a custom item provider to the given anchorview
11925 * Like elm_anchorview_item_provider_append(), but it adds the function
11926 * @p func to the beginning of the list, instead of the end.
11928 * @param obj The anchorview object
11929 * @param func The function to add to the list of providers
11930 * @param data User data that will be passed to the callback function
11932 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);
11934 * Remove a custom item provider from the list of the given anchorview
11936 * Removes the function and data pairing that matches @p func and @p data.
11937 * That is, unless the same function and same user data are given, the
11938 * function will not be removed from the list. This allows us to add the
11939 * same callback several times, with different @p data pointers and be
11940 * able to remove them later without conflicts.
11942 * @param obj The anchorview object
11943 * @param func The function to remove from the list
11944 * @param data The data matching the function to remove from the list
11946 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);
11953 * @defgroup Anchorblock Anchorblock
11955 * @image html img/widget/anchorblock/preview-00.png
11956 * @image latex img/widget/anchorblock/preview-00.eps
11958 * Anchorblock is for displaying text that contains markup with anchors
11959 * like <c>\<a href=1234\>something\</\></c> in it.
11961 * Besides being styled differently, the anchorblock widget provides the
11962 * necessary functionality so that clicking on these anchors brings up a
11963 * popup with user defined content such as "call", "add to contacts" or
11964 * "open web page". This popup is provided using the @ref Hover widget.
11966 * This widget emits the following signals:
11967 * @li "anchor,clicked": will be called when an anchor is clicked. The
11968 * @p event_info parameter on the callback will be a pointer of type
11969 * ::Elm_Entry_Anchorblock_Info.
11975 * Since examples are usually better than plain words, we might as well
11976 * try @ref tutorial_anchorblock_example "one".
11979 * @addtogroup Anchorblock
11983 * @typedef Elm_Entry_Anchorblock_Info
11985 * The info sent in the callback for "anchor,clicked" signals emitted by
11986 * the Anchorblock widget.
11988 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11990 * @struct _Elm_Entry_Anchorblock_Info
11992 * The info sent in the callback for "anchor,clicked" signals emitted by
11993 * the Anchorblock widget.
11995 struct _Elm_Entry_Anchorblock_Info
11997 const char *name; /**< Name of the anchor, as indicated in its href
11999 int button; /**< The mouse button used to click on it */
12000 Evas_Object *hover; /**< The hover object to use for the popup */
12002 Evas_Coord x, y, w, h;
12003 } anchor, /**< Geometry selection of text used as anchor */
12004 hover_parent; /**< Geometry of the object used as parent by the
12006 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12007 for content on the left side of
12008 the hover. Before calling the
12009 callback, the widget will make the
12010 necessary calculations to check
12011 which sides are fit to be set with
12012 content, based on the position the
12013 hover is activated and its distance
12014 to the edges of its parent object
12016 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12017 the right side of the hover.
12018 See @ref hover_left */
12019 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12020 of the hover. See @ref hover_left */
12021 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12022 below the hover. See @ref
12026 * Add a new Anchorblock object
12028 * @param parent The parent object
12029 * @return The new object or NULL if it cannot be created
12031 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12033 * Set the text to show in the anchorblock
12035 * Sets the text of the anchorblock to @p text. This text can include markup
12036 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12037 * of text that will be specially styled and react to click events, ended
12038 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12039 * "anchor,clicked" signal that you can attach a callback to with
12040 * evas_object_smart_callback_add(). The name of the anchor given in the
12041 * event info struct will be the one set in the href attribute, in this
12042 * case, anchorname.
12044 * Other markup can be used to style the text in different ways, but it's
12045 * up to the style defined in the theme which tags do what.
12046 * @deprecated use elm_object_text_set() instead.
12048 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12050 * Get the markup text set for the anchorblock
12052 * Retrieves the text set on the anchorblock, with markup tags included.
12054 * @param obj The anchorblock object
12055 * @return The markup text set or @c NULL if nothing was set or an error
12057 * @deprecated use elm_object_text_set() instead.
12059 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12061 * Set the parent of the hover popup
12063 * Sets the parent object to use by the hover created by the anchorblock
12064 * when an anchor is clicked. See @ref Hover for more details on this.
12066 * @param obj The anchorblock object
12067 * @param parent The object to use as parent for the hover
12069 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12071 * Get the parent of the hover popup
12073 * Get the object used as parent for the hover created by the anchorblock
12074 * widget. See @ref Hover for more details on this.
12075 * If no parent is set, the same anchorblock object will be used.
12077 * @param obj The anchorblock object
12078 * @return The object used as parent for the hover, NULL if none is set.
12080 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12082 * Set the style that the hover should use
12084 * When creating the popup hover, anchorblock will request that it's
12085 * themed according to @p style.
12087 * @param obj The anchorblock object
12088 * @param style The style to use for the underlying hover
12090 * @see elm_object_style_set()
12092 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12094 * Get the style that the hover should use
12096 * Get the style, the hover created by anchorblock will use.
12098 * @param obj The anchorblock object
12099 * @return The style to use by the hover. NULL means the default is used.
12101 * @see elm_object_style_set()
12103 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12105 * Ends the hover popup in the anchorblock
12107 * When an anchor is clicked, the anchorblock widget will create a hover
12108 * object to use as a popup with user provided content. This function
12109 * terminates this popup, returning the anchorblock to its normal state.
12111 * @param obj The anchorblock object
12113 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12115 * Appends a custom item provider to the given anchorblock
12117 * Appends the given function to the list of items providers. This list is
12118 * called, one function at a time, with the given @p data pointer, the
12119 * anchorblock object and, in the @p item parameter, the item name as
12120 * referenced in its href string. Following functions in the list will be
12121 * called in order until one of them returns something different to NULL,
12122 * which should be an Evas_Object which will be used in place of the item
12125 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12126 * href=item/name\>\</item\>
12128 * @param obj The anchorblock object
12129 * @param func The function to add to the list of providers
12130 * @param data User data that will be passed to the callback function
12132 * @see elm_entry_item_provider_append()
12134 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);
12136 * Prepend a custom item provider to the given anchorblock
12138 * Like elm_anchorblock_item_provider_append(), but it adds the function
12139 * @p func to the beginning of the list, instead of the end.
12141 * @param obj The anchorblock object
12142 * @param func The function to add to the list of providers
12143 * @param data User data that will be passed to the callback function
12145 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);
12147 * Remove a custom item provider from the list of the given anchorblock
12149 * Removes the function and data pairing that matches @p func and @p data.
12150 * That is, unless the same function and same user data are given, the
12151 * function will not be removed from the list. This allows us to add the
12152 * same callback several times, with different @p data pointers and be
12153 * able to remove them later without conflicts.
12155 * @param obj The anchorblock object
12156 * @param func The function to remove from the list
12157 * @param data The data matching the function to remove from the list
12159 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);
12165 * @defgroup Bubble Bubble
12167 * @image html img/widget/bubble/preview-00.png
12168 * @image latex img/widget/bubble/preview-00.eps
12169 * @image html img/widget/bubble/preview-01.png
12170 * @image latex img/widget/bubble/preview-01.eps
12171 * @image html img/widget/bubble/preview-02.png
12172 * @image latex img/widget/bubble/preview-02.eps
12174 * @brief The Bubble is a widget to show text similar to how speech is
12175 * represented in comics.
12177 * The bubble widget contains 5 important visual elements:
12178 * @li The frame is a rectangle with rounded edjes and an "arrow".
12179 * @li The @p icon is an image to which the frame's arrow points to.
12180 * @li The @p label is a text which appears to the right of the icon if the
12181 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12183 * @li The @p info is a text which appears to the right of the label. Info's
12184 * font is of a ligther color than label.
12185 * @li The @p content is an evas object that is shown inside the frame.
12187 * The position of the arrow, icon, label and info depends on which corner is
12188 * selected. The four available corners are:
12189 * @li "top_left" - Default
12191 * @li "bottom_left"
12192 * @li "bottom_right"
12194 * Signals that you can add callbacks for are:
12195 * @li "clicked" - This is called when a user has clicked the bubble.
12197 * For an example of using a buble see @ref bubble_01_example_page "this".
12202 #define ELM_BUBBLE_CONTENT_ICON "elm.swallow.icon"
12205 * Add a new bubble to the parent
12207 * @param parent The parent object
12208 * @return The new object or NULL if it cannot be created
12210 * This function adds a text bubble to the given parent evas object.
12212 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12214 * Set the label of the bubble
12216 * @param obj The bubble object
12217 * @param label The string to set in the label
12219 * This function sets the title of the bubble. Where this appears depends on
12220 * the selected corner.
12221 * @deprecated use elm_object_text_set() instead.
12223 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12225 * Get the label of the bubble
12227 * @param obj The bubble object
12228 * @return The string of set in the label
12230 * This function gets the title of the bubble.
12231 * @deprecated use elm_object_text_get() instead.
12233 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12235 * Set the info of the bubble
12237 * @param obj The bubble object
12238 * @param info The given info about the bubble
12240 * This function sets the info of the bubble. Where this appears depends on
12241 * the selected corner.
12242 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12244 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12246 * Get the info of the bubble
12248 * @param obj The bubble object
12250 * @return The "info" string of the bubble
12252 * This function gets the info text.
12253 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12255 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12257 * Set the content to be shown in the bubble
12259 * Once the content object is set, a previously set one will be deleted.
12260 * If you want to keep the old content object, use the
12261 * elm_bubble_content_unset() function.
12263 * @param obj The bubble object
12264 * @param content The given content of the bubble
12266 * This function sets the content shown on the middle of the bubble.
12268 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12270 * Get the content shown in the bubble
12272 * Return the content object which is set for this widget.
12274 * @param obj The bubble object
12275 * @return The content that is being used
12277 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12279 * Unset the content shown in the bubble
12281 * Unparent and return the content object which was set for this widget.
12283 * @param obj The bubble object
12284 * @return The content that was being used
12286 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12288 * Set the icon of the bubble
12290 * Once the icon object is set, a previously set one will be deleted.
12291 * If you want to keep the old content object, use the
12292 * elm_icon_content_unset() function.
12294 * @param obj The bubble object
12295 * @param icon The given icon for the bubble
12297 * @deprecated use elm_object_content_part_set() instead
12300 EINA_DEPRECATED EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12302 * Get the icon of the bubble
12304 * @param obj The bubble object
12305 * @return The icon for the bubble
12307 * This function gets the icon shown on the top left of bubble.
12309 * @deprecated use elm_object_content_part_get() instead
12312 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12314 * Unset the icon of the bubble
12316 * Unparent and return the icon object which was set for this widget.
12318 * @param obj The bubble object
12319 * @return The icon that was being used
12321 * @deprecated use elm_object_content_part_unset() instead
12324 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12326 * Set the corner of the bubble
12328 * @param obj The bubble object.
12329 * @param corner The given corner for the bubble.
12331 * This function sets the corner of the bubble. The corner will be used to
12332 * determine where the arrow in the frame points to and where label, icon and
12335 * Possible values for corner are:
12336 * @li "top_left" - Default
12338 * @li "bottom_left"
12339 * @li "bottom_right"
12341 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12343 * Get the corner of the bubble
12345 * @param obj The bubble object.
12346 * @return The given corner for the bubble.
12348 * This function gets the selected corner of the bubble.
12350 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12352 EINA_DEPRECATED EAPI void elm_bubble_sweep_layout_set(Evas_Object *obj, Evas_Object *sweep) EINA_ARG_NONNULL(1);
12353 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_sweep_layout_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12360 * @defgroup Photo Photo
12362 * For displaying the photo of a person (contact). Simple, yet
12363 * with a very specific purpose.
12365 * Signals that you can add callbacks for are:
12367 * "clicked" - This is called when a user has clicked the photo
12368 * "drag,start" - Someone started dragging the image out of the object
12369 * "drag,end" - Dragged item was dropped (somewhere)
12375 * Add a new photo to the parent
12377 * @param parent The parent object
12378 * @return The new object or NULL if it cannot be created
12382 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12385 * Set the file that will be used as photo
12387 * @param obj The photo object
12388 * @param file The path to file that will be used as photo
12390 * @return (1 = success, 0 = error)
12394 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12397 * Set the size that will be used on the photo
12399 * @param obj The photo object
12400 * @param size The size that the photo will be
12404 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12407 * Set if the photo should be completely visible or not.
12409 * @param obj The photo object
12410 * @param fill if true the photo will be completely visible
12414 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12417 * Set editability of the photo.
12419 * An editable photo can be dragged to or from, and can be cut or
12420 * pasted too. Note that pasting an image or dropping an item on
12421 * the image will delete the existing content.
12423 * @param obj The photo object.
12424 * @param set To set of clear editablity.
12426 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12432 /* gesture layer */
12434 * @defgroup Elm_Gesture_Layer Gesture Layer
12435 * Gesture Layer Usage:
12437 * Use Gesture Layer to detect gestures.
12438 * The advantage is that you don't have to implement
12439 * gesture detection, just set callbacks of gesture state.
12440 * By using gesture layer we make standard interface.
12442 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12443 * with a parent object parameter.
12444 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12445 * call. Usually with same object as target (2nd parameter).
12447 * Now you need to tell gesture layer what gestures you follow.
12448 * This is done with @ref elm_gesture_layer_cb_set call.
12449 * By setting the callback you actually saying to gesture layer:
12450 * I would like to know when the gesture @ref Elm_Gesture_Types
12451 * switches to state @ref Elm_Gesture_State.
12453 * Next, you need to implement the actual action that follows the input
12454 * in your callback.
12456 * Note that if you like to stop being reported about a gesture, just set
12457 * all callbacks referring this gesture to NULL.
12458 * (again with @ref elm_gesture_layer_cb_set)
12460 * The information reported by gesture layer to your callback is depending
12461 * on @ref Elm_Gesture_Types:
12462 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12463 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12464 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12466 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12467 * @ref ELM_GESTURE_MOMENTUM.
12469 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12470 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12471 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12472 * Note that we consider a flick as a line-gesture that should be completed
12473 * in flick-time-limit as defined in @ref Config.
12475 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12477 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12480 * Gesture Layer Tweaks:
12482 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12483 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12485 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12486 * so gesture starts when user touches (a *DOWN event) touch-surface
12487 * and ends when no fingers touches surface (a *UP event).
12491 * @enum _Elm_Gesture_Types
12492 * Enum of supported gesture types.
12493 * @ingroup Elm_Gesture_Layer
12495 enum _Elm_Gesture_Types
12497 ELM_GESTURE_FIRST = 0,
12499 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12500 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12501 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12502 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12504 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12506 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12507 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12509 ELM_GESTURE_ZOOM, /**< Zoom */
12510 ELM_GESTURE_ROTATE, /**< Rotate */
12516 * @typedef Elm_Gesture_Types
12517 * gesture types enum
12518 * @ingroup Elm_Gesture_Layer
12520 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12523 * @enum _Elm_Gesture_State
12524 * Enum of gesture states.
12525 * @ingroup Elm_Gesture_Layer
12527 enum _Elm_Gesture_State
12529 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12530 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12531 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12532 ELM_GESTURE_STATE_END, /**< Gesture completed */
12533 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12537 * @typedef Elm_Gesture_State
12538 * gesture states enum
12539 * @ingroup Elm_Gesture_Layer
12541 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12544 * @struct _Elm_Gesture_Taps_Info
12545 * Struct holds taps info for user
12546 * @ingroup Elm_Gesture_Layer
12548 struct _Elm_Gesture_Taps_Info
12550 Evas_Coord x, y; /**< Holds center point between fingers */
12551 unsigned int n; /**< Number of fingers tapped */
12552 unsigned int timestamp; /**< event timestamp */
12556 * @typedef Elm_Gesture_Taps_Info
12557 * holds taps info for user
12558 * @ingroup Elm_Gesture_Layer
12560 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12563 * @struct _Elm_Gesture_Momentum_Info
12564 * Struct holds momentum info for user
12565 * x1 and y1 are not necessarily in sync
12566 * x1 holds x value of x direction starting point
12567 * and same holds for y1.
12568 * This is noticeable when doing V-shape movement
12569 * @ingroup Elm_Gesture_Layer
12571 struct _Elm_Gesture_Momentum_Info
12572 { /* Report line ends, timestamps, and momentum computed */
12573 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12574 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12575 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12576 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12578 unsigned int tx; /**< Timestamp of start of final x-swipe */
12579 unsigned int ty; /**< Timestamp of start of final y-swipe */
12581 Evas_Coord mx; /**< Momentum on X */
12582 Evas_Coord my; /**< Momentum on Y */
12584 unsigned int n; /**< Number of fingers */
12588 * @typedef Elm_Gesture_Momentum_Info
12589 * holds momentum info for user
12590 * @ingroup Elm_Gesture_Layer
12592 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12595 * @struct _Elm_Gesture_Line_Info
12596 * Struct holds line info for user
12597 * @ingroup Elm_Gesture_Layer
12599 struct _Elm_Gesture_Line_Info
12600 { /* Report line ends, timestamps, and momentum computed */
12601 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12602 /* FIXME should be radians, bot degrees */
12603 double angle; /**< Angle (direction) of lines */
12607 * @typedef Elm_Gesture_Line_Info
12608 * Holds line info for user
12609 * @ingroup Elm_Gesture_Layer
12611 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12614 * @struct _Elm_Gesture_Zoom_Info
12615 * Struct holds zoom info for user
12616 * @ingroup Elm_Gesture_Layer
12618 struct _Elm_Gesture_Zoom_Info
12620 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12621 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12622 double zoom; /**< Zoom value: 1.0 means no zoom */
12623 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12627 * @typedef Elm_Gesture_Zoom_Info
12628 * Holds zoom info for user
12629 * @ingroup Elm_Gesture_Layer
12631 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12634 * @struct _Elm_Gesture_Rotate_Info
12635 * Struct holds rotation info for user
12636 * @ingroup Elm_Gesture_Layer
12638 struct _Elm_Gesture_Rotate_Info
12640 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12641 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12642 double base_angle; /**< Holds start-angle */
12643 double angle; /**< Rotation value: 0.0 means no rotation */
12644 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12648 * @typedef Elm_Gesture_Rotate_Info
12649 * Holds rotation info for user
12650 * @ingroup Elm_Gesture_Layer
12652 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12655 * @typedef Elm_Gesture_Event_Cb
12656 * User callback used to stream gesture info from gesture layer
12657 * @param data user data
12658 * @param event_info gesture report info
12659 * Returns a flag field to be applied on the causing event.
12660 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12661 * upon the event, in an irreversible way.
12663 * @ingroup Elm_Gesture_Layer
12665 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12668 * Use function to set callbacks to be notified about
12669 * change of state of gesture.
12670 * When a user registers a callback with this function
12671 * this means this gesture has to be tested.
12673 * When ALL callbacks for a gesture are set to NULL
12674 * it means user isn't interested in gesture-state
12675 * and it will not be tested.
12677 * @param obj Pointer to gesture-layer.
12678 * @param idx The gesture you would like to track its state.
12679 * @param cb callback function pointer.
12680 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12681 * @param data user info to be sent to callback (usually, Smart Data)
12683 * @ingroup Elm_Gesture_Layer
12685 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);
12688 * Call this function to get repeat-events settings.
12690 * @param obj Pointer to gesture-layer.
12692 * @return repeat events settings.
12693 * @see elm_gesture_layer_hold_events_set()
12694 * @ingroup Elm_Gesture_Layer
12696 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12699 * This function called in order to make gesture-layer repeat events.
12700 * Set this of you like to get the raw events only if gestures were not detected.
12701 * Clear this if you like gesture layer to fwd events as testing gestures.
12703 * @param obj Pointer to gesture-layer.
12704 * @param r Repeat: TRUE/FALSE
12706 * @ingroup Elm_Gesture_Layer
12708 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12711 * This function sets step-value for zoom action.
12712 * Set step to any positive value.
12713 * Cancel step setting by setting to 0.0
12715 * @param obj Pointer to gesture-layer.
12716 * @param s new zoom step value.
12718 * @ingroup Elm_Gesture_Layer
12720 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12723 * This function sets step-value for rotate action.
12724 * Set step to any positive value.
12725 * Cancel step setting by setting to 0.0
12727 * @param obj Pointer to gesture-layer.
12728 * @param s new roatate step value.
12730 * @ingroup Elm_Gesture_Layer
12732 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12735 * This function called to attach gesture-layer to an Evas_Object.
12736 * @param obj Pointer to gesture-layer.
12737 * @param t Pointer to underlying object (AKA Target)
12739 * @return TRUE, FALSE on success, failure.
12741 * @ingroup Elm_Gesture_Layer
12743 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12746 * Call this function to construct a new gesture-layer object.
12747 * This does not activate the gesture layer. You have to
12748 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12750 * @param parent the parent object.
12752 * @return Pointer to new gesture-layer object.
12754 * @ingroup Elm_Gesture_Layer
12756 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12759 * @defgroup Thumb Thumb
12761 * @image html img/widget/thumb/preview-00.png
12762 * @image latex img/widget/thumb/preview-00.eps
12764 * A thumb object is used for displaying the thumbnail of an image or video.
12765 * You must have compiled Elementary with Ethumb_Client support and the DBus
12766 * service must be present and auto-activated in order to have thumbnails to
12769 * Once the thumbnail object becomes visible, it will check if there is a
12770 * previously generated thumbnail image for the file set on it. If not, it
12771 * will start generating this thumbnail.
12773 * Different config settings will cause different thumbnails to be generated
12774 * even on the same file.
12776 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12777 * Ethumb documentation to change this path, and to see other configuration
12780 * Signals that you can add callbacks for are:
12782 * - "clicked" - This is called when a user has clicked the thumb without dragging
12784 * - "clicked,double" - This is called when a user has double-clicked the thumb.
12785 * - "press" - This is called when a user has pressed down the thumb.
12786 * - "generate,start" - The thumbnail generation started.
12787 * - "generate,stop" - The generation process stopped.
12788 * - "generate,error" - The generation failed.
12789 * - "load,error" - The thumbnail image loading failed.
12791 * available styles:
12795 * An example of use of thumbnail:
12797 * - @ref thumb_example_01
12801 * @addtogroup Thumb
12806 * @enum _Elm_Thumb_Animation_Setting
12807 * @typedef Elm_Thumb_Animation_Setting
12809 * Used to set if a video thumbnail is animating or not.
12813 typedef enum _Elm_Thumb_Animation_Setting
12815 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12816 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
12817 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
12818 ELM_THUMB_ANIMATION_LAST
12819 } Elm_Thumb_Animation_Setting;
12822 * Add a new thumb object to the parent.
12824 * @param parent The parent object.
12825 * @return The new object or NULL if it cannot be created.
12827 * @see elm_thumb_file_set()
12828 * @see elm_thumb_ethumb_client_get()
12832 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12834 * Reload thumbnail if it was generated before.
12836 * @param obj The thumb object to reload
12838 * This is useful if the ethumb client configuration changed, like its
12839 * size, aspect or any other property one set in the handle returned
12840 * by elm_thumb_ethumb_client_get().
12842 * If the options didn't change, the thumbnail won't be generated again, but
12843 * the old one will still be used.
12845 * @see elm_thumb_file_set()
12849 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12851 * Set the file that will be used as thumbnail.
12853 * @param obj The thumb object.
12854 * @param file The path to file that will be used as thumb.
12855 * @param key The key used in case of an EET file.
12857 * The file can be an image or a video (in that case, acceptable extensions are:
12858 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12859 * function elm_thumb_animate().
12861 * @see elm_thumb_file_get()
12862 * @see elm_thumb_reload()
12863 * @see elm_thumb_animate()
12867 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12869 * Get the image or video path and key used to generate the thumbnail.
12871 * @param obj The thumb object.
12872 * @param file Pointer to filename.
12873 * @param key Pointer to key.
12875 * @see elm_thumb_file_set()
12876 * @see elm_thumb_path_get()
12880 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12882 * Get the path and key to the image or video generated by ethumb.
12884 * One just need to make sure that the thumbnail was generated before getting
12885 * its path; otherwise, the path will be NULL. One way to do that is by asking
12886 * for the path when/after the "generate,stop" smart callback is called.
12888 * @param obj The thumb object.
12889 * @param file Pointer to thumb path.
12890 * @param key Pointer to thumb key.
12892 * @see elm_thumb_file_get()
12896 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12898 * Set the animation state for the thumb object. If its content is an animated
12899 * video, you may start/stop the animation or tell it to play continuously and
12902 * @param obj The thumb object.
12903 * @param setting The animation setting.
12905 * @see elm_thumb_file_set()
12909 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12911 * Get the animation state for the thumb object.
12913 * @param obj The thumb object.
12914 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12917 * @see elm_thumb_animate_set()
12921 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12923 * Get the ethumb_client handle so custom configuration can be made.
12925 * @return Ethumb_Client instance or NULL.
12927 * This must be called before the objects are created to be sure no object is
12928 * visible and no generation started.
12930 * Example of usage:
12933 * #include <Elementary.h>
12934 * #ifndef ELM_LIB_QUICKLAUNCH
12936 * elm_main(int argc, char **argv)
12938 * Ethumb_Client *client;
12940 * elm_need_ethumb();
12944 * client = elm_thumb_ethumb_client_get();
12947 * ERR("could not get ethumb_client");
12950 * ethumb_client_size_set(client, 100, 100);
12951 * ethumb_client_crop_align_set(client, 0.5, 0.5);
12954 * // Create elm_thumb objects here
12964 * @note There's only one client handle for Ethumb, so once a configuration
12965 * change is done to it, any other request for thumbnails (for any thumbnail
12966 * object) will use that configuration. Thus, this configuration is global.
12970 EAPI void *elm_thumb_ethumb_client_get(void);
12972 * Get the ethumb_client connection state.
12974 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12977 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
12979 * Make the thumbnail 'editable'.
12981 * @param obj Thumb object.
12982 * @param set Turn on or off editability. Default is @c EINA_FALSE.
12984 * This means the thumbnail is a valid drag target for drag and drop, and can be
12985 * cut or pasted too.
12987 * @see elm_thumb_editable_get()
12991 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12992 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12994 * Make the thumbnail 'editable'.
12996 * @param obj Thumb object.
12997 * @return Editability.
12999 * This means the thumbnail is a valid drag target for drag and drop, and can be
13000 * cut or pasted too.
13002 * @see elm_thumb_editable_set()
13006 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13014 * @defgroup Web Web
13016 * @image html img/widget/web/preview-00.png
13017 * @image latex img/widget/web/preview-00.eps
13019 * A web object is used for displaying web pages (HTML/CSS/JS)
13020 * using WebKit-EFL. You must have compiled Elementary with
13023 * Signals that you can add callbacks for are:
13024 * @li "download,request": A file download has been requested. Event info is
13025 * a pointer to a Elm_Web_Download
13026 * @li "editorclient,contents,changed": Editor client's contents changed
13027 * @li "editorclient,selection,changed": Editor client's selection changed
13028 * @li "frame,created": A new frame was created. Event info is an
13029 * Evas_Object which can be handled with WebKit's ewk_frame API
13030 * @li "icon,received": An icon was received by the main frame
13031 * @li "inputmethod,changed": Input method changed. Event info is an
13032 * Eina_Bool indicating whether it's enabled or not
13033 * @li "js,windowobject,clear": JS window object has been cleared
13034 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13035 * is a char *link[2], where the first string contains the URL the link
13036 * points to, and the second one the title of the link
13037 * @li "link,hover,out": Mouse cursor left the link
13038 * @li "load,document,finished": Loading of a document finished. Event info
13039 * is the frame that finished loading
13040 * @li "load,error": Load failed. Event info is a pointer to
13041 * Elm_Web_Frame_Load_Error
13042 * @li "load,finished": Load finished. Event info is NULL on success, on
13043 * error it's a pointer to Elm_Web_Frame_Load_Error
13044 * @li "load,newwindow,show": A new window was created and is ready to be
13046 * @li "load,progress": Overall load progress. Event info is a pointer to
13047 * a double containing a value between 0.0 and 1.0
13048 * @li "load,provisional": Started provisional load
13049 * @li "load,started": Loading of a document started
13050 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13051 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13052 * the menubar is visible, or EINA_FALSE in case it's not
13053 * @li "menubar,visible,set": Informs menubar visibility. Event info is
13054 * an Eina_Bool indicating the visibility
13055 * @li "popup,created": A dropdown widget was activated, requesting its
13056 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13057 * @li "popup,willdelete": The web object is ready to destroy the popup
13058 * object created. Event info is a pointer to Elm_Web_Menu
13059 * @li "ready": Page is fully loaded
13060 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13061 * info is a pointer to Eina_Bool where the visibility state should be set
13062 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13063 * is an Eina_Bool with the visibility state set
13064 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13065 * a string with the new text
13066 * @li "statusbar,visible,get": Queries visibility of the status bar.
13067 * Event info is a pointer to Eina_Bool where the visibility state should be
13069 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13070 * an Eina_Bool with the visibility value
13071 * @li "title,changed": Title of the main frame changed. Event info is a
13072 * string with the new title
13073 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13074 * is a pointer to Eina_Bool where the visibility state should be set
13075 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13076 * info is an Eina_Bool with the visibility state
13077 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13078 * a string with the text to show
13079 * @li "uri,changed": URI of the main frame changed. Event info is a string
13081 * @li "view,resized": The web object internal's view changed sized
13082 * @li "windows,close,request": A JavaScript request to close the current
13083 * window was requested
13084 * @li "zoom,animated,end": Animated zoom finished
13086 * available styles:
13089 * An example of use of web:
13091 * - @ref web_example_01 TBD
13100 * Structure used to report load errors.
13102 * Load errors are reported as signal by elm_web. All the strings are
13103 * temporary references and should @b not be used after the signal
13104 * callback returns. If it's required, make copies with strdup() or
13105 * eina_stringshare_add() (they are not even guaranteed to be
13106 * stringshared, so must use eina_stringshare_add() and not
13107 * eina_stringshare_ref()).
13109 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13111 * Structure used to report load errors.
13113 * Load errors are reported as signal by elm_web. All the strings are
13114 * temporary references and should @b not be used after the signal
13115 * callback returns. If it's required, make copies with strdup() or
13116 * eina_stringshare_add() (they are not even guaranteed to be
13117 * stringshared, so must use eina_stringshare_add() and not
13118 * eina_stringshare_ref()).
13120 struct _Elm_Web_Frame_Load_Error
13122 int code; /**< Numeric error code */
13123 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13124 const char *domain; /**< Error domain name */
13125 const char *description; /**< Error description (already localized) */
13126 const char *failing_url; /**< The URL that failed to load */
13127 Evas_Object *frame; /**< Frame object that produced the error */
13131 * The possibles types that the items in a menu can be
13133 typedef enum _Elm_Web_Menu_Item_Type
13135 ELM_WEB_MENU_SEPARATOR,
13136 ELM_WEB_MENU_GROUP,
13137 ELM_WEB_MENU_OPTION
13138 } Elm_Web_Menu_Item_Type;
13141 * Structure describing the items in a menu
13143 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13145 * Structure describing the items in a menu
13147 struct _Elm_Web_Menu_Item
13149 const char *text; /**< The text for the item */
13150 Elm_Web_Menu_Item_Type type; /**< The type of the item */
13154 * Structure describing the menu of a popup
13156 * This structure will be passed as the @c event_info for the "popup,create"
13157 * signal, which is emitted when a dropdown menu is opened. Users wanting
13158 * to handle these popups by themselves should listen to this signal and
13159 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13160 * property as @c EINA_FALSE means that the user will not handle the popup
13161 * and the default implementation will be used.
13163 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13164 * will be emitted to notify the user that it can destroy any objects and
13165 * free all data related to it.
13167 * @see elm_web_popup_selected_set()
13168 * @see elm_web_popup_destroy()
13170 typedef struct _Elm_Web_Menu Elm_Web_Menu;
13172 * Structure describing the menu of a popup
13174 * This structure will be passed as the @c event_info for the "popup,create"
13175 * signal, which is emitted when a dropdown menu is opened. Users wanting
13176 * to handle these popups by themselves should listen to this signal and
13177 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13178 * property as @c EINA_FALSE means that the user will not handle the popup
13179 * and the default implementation will be used.
13181 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13182 * will be emitted to notify the user that it can destroy any objects and
13183 * free all data related to it.
13185 * @see elm_web_popup_selected_set()
13186 * @see elm_web_popup_destroy()
13188 struct _Elm_Web_Menu
13190 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13191 int x; /**< The X position of the popup, relative to the elm_web object */
13192 int y; /**< The Y position of the popup, relative to the elm_web object */
13193 int width; /**< Width of the popup menu */
13194 int height; /**< Height of the popup menu */
13196 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. */
13199 typedef struct _Elm_Web_Download Elm_Web_Download;
13200 struct _Elm_Web_Download
13206 * Types of zoom available.
13208 typedef enum _Elm_Web_Zoom_Mode
13210 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13211 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13212 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13213 ELM_WEB_ZOOM_MODE_LAST
13214 } Elm_Web_Zoom_Mode;
13216 * Opaque handler containing the features (such as statusbar, menubar, etc)
13217 * that are to be set on a newly requested window.
13219 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13221 * Callback type for the create_window hook.
13223 * The function parameters are:
13224 * @li @p data User data pointer set when setting the hook function
13225 * @li @p obj The elm_web object requesting the new window
13226 * @li @p js Set to @c EINA_TRUE if the request was originated from
13227 * JavaScript. @c EINA_FALSE otherwise.
13228 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13229 * the features requested for the new window.
13231 * The returned value of the function should be the @c elm_web widget where
13232 * the request will be loaded. That is, if a new window or tab is created,
13233 * the elm_web widget in it should be returned, and @b NOT the window
13235 * Returning @c NULL should cancel the request.
13237 * @see elm_web_window_create_hook_set()
13239 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13241 * Callback type for the JS alert hook.
13243 * The function parameters are:
13244 * @li @p data User data pointer set when setting the hook function
13245 * @li @p obj The elm_web object requesting the new window
13246 * @li @p message The message to show in the alert dialog
13248 * The function should return the object representing the alert dialog.
13249 * Elm_Web will run a second main loop to handle the dialog and normal
13250 * flow of the application will be restored when the object is deleted, so
13251 * the user should handle the popup properly in order to delete the object
13252 * when the action is finished.
13253 * If the function returns @c NULL the popup will be ignored.
13255 * @see elm_web_dialog_alert_hook_set()
13257 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13259 * Callback type for the JS confirm hook.
13261 * The function parameters are:
13262 * @li @p data User data pointer set when setting the hook function
13263 * @li @p obj The elm_web object requesting the new window
13264 * @li @p message The message to show in the confirm dialog
13265 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13266 * the user selected @c Ok, @c EINA_FALSE otherwise.
13268 * The function should return the object representing the confirm dialog.
13269 * Elm_Web will run a second main loop to handle the dialog and normal
13270 * flow of the application will be restored when the object is deleted, so
13271 * the user should handle the popup properly in order to delete the object
13272 * when the action is finished.
13273 * If the function returns @c NULL the popup will be ignored.
13275 * @see elm_web_dialog_confirm_hook_set()
13277 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13279 * Callback type for the JS prompt hook.
13281 * The function parameters are:
13282 * @li @p data User data pointer set when setting the hook function
13283 * @li @p obj The elm_web object requesting the new window
13284 * @li @p message The message to show in the prompt dialog
13285 * @li @p def_value The default value to present the user in the entry
13286 * @li @p value Pointer where to store the value given by the user. Must
13287 * be a malloc'ed string or @c NULL if the user cancelled the popup.
13288 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13289 * the user selected @c Ok, @c EINA_FALSE otherwise.
13291 * The function should return the object representing the prompt dialog.
13292 * Elm_Web will run a second main loop to handle the dialog and normal
13293 * flow of the application will be restored when the object is deleted, so
13294 * the user should handle the popup properly in order to delete the object
13295 * when the action is finished.
13296 * If the function returns @c NULL the popup will be ignored.
13298 * @see elm_web_dialog_prompt_hook_set()
13300 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13302 * Callback type for the JS file selector hook.
13304 * The function parameters are:
13305 * @li @p data User data pointer set when setting the hook function
13306 * @li @p obj The elm_web object requesting the new window
13307 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13308 * @li @p accept_types Mime types accepted
13309 * @li @p selected Pointer where to store the list of malloc'ed strings
13310 * containing the path to each file selected. Must be @c NULL if the file
13311 * dialog is cancelled
13312 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13313 * the user selected @c Ok, @c EINA_FALSE otherwise.
13315 * The function should return the object representing the file selector
13317 * Elm_Web will run a second main loop to handle the dialog and normal
13318 * flow of the application will be restored when the object is deleted, so
13319 * the user should handle the popup properly in order to delete the object
13320 * when the action is finished.
13321 * If the function returns @c NULL the popup will be ignored.
13323 * @see elm_web_dialog_file selector_hook_set()
13325 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);
13327 * Callback type for the JS console message hook.
13329 * When a console message is added from JavaScript, any set function to the
13330 * console message hook will be called for the user to handle. There is no
13331 * default implementation of this hook.
13333 * The function parameters are:
13334 * @li @p data User data pointer set when setting the hook function
13335 * @li @p obj The elm_web object that originated the message
13336 * @li @p message The message sent
13337 * @li @p line_number The line number
13338 * @li @p source_id Source id
13340 * @see elm_web_console_message_hook_set()
13342 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13344 * Add a new web object to the parent.
13346 * @param parent The parent object.
13347 * @return The new object or NULL if it cannot be created.
13349 * @see elm_web_uri_set()
13350 * @see elm_web_webkit_view_get()
13352 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13355 * Get internal ewk_view object from web object.
13357 * Elementary may not provide some low level features of EWebKit,
13358 * instead of cluttering the API with proxy methods we opted to
13359 * return the internal reference. Be careful using it as it may
13360 * interfere with elm_web behavior.
13362 * @param obj The web object.
13363 * @return The internal ewk_view object or NULL if it does not
13364 * exist. (Failure to create or Elementary compiled without
13367 * @see elm_web_add()
13369 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13372 * Sets the function to call when a new window is requested
13374 * This hook will be called when a request to create a new window is
13375 * issued from the web page loaded.
13376 * There is no default implementation for this feature, so leaving this
13377 * unset or passing @c NULL in @p func will prevent new windows from
13380 * @param obj The web object where to set the hook function
13381 * @param func The hook function to be called when a window is requested
13382 * @param data User data
13384 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13386 * Sets the function to call when an alert dialog
13388 * This hook will be called when a JavaScript alert dialog is requested.
13389 * If no function is set or @c NULL is passed in @p func, the default
13390 * implementation will take place.
13392 * @param obj The web object where to set the hook function
13393 * @param func The callback function to be used
13394 * @param data User data
13396 * @see elm_web_inwin_mode_set()
13398 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13400 * Sets the function to call when an confirm dialog
13402 * This hook will be called when a JavaScript confirm dialog is requested.
13403 * If no function is set or @c NULL is passed in @p func, the default
13404 * implementation will take place.
13406 * @param obj The web object where to set the hook function
13407 * @param func The callback function to be used
13408 * @param data User data
13410 * @see elm_web_inwin_mode_set()
13412 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13414 * Sets the function to call when an prompt dialog
13416 * This hook will be called when a JavaScript prompt dialog is requested.
13417 * If no function is set or @c NULL is passed in @p func, the default
13418 * implementation will take place.
13420 * @param obj The web object where to set the hook function
13421 * @param func The callback function to be used
13422 * @param data User data
13424 * @see elm_web_inwin_mode_set()
13426 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13428 * Sets the function to call when an file selector dialog
13430 * This hook will be called when a JavaScript file selector dialog is
13432 * If no function is set or @c NULL is passed in @p func, the default
13433 * implementation will take place.
13435 * @param obj The web object where to set the hook function
13436 * @param func The callback function to be used
13437 * @param data User data
13439 * @see elm_web_inwin_mode_set()
13441 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13443 * Sets the function to call when a console message is emitted from JS
13445 * This hook will be called when a console message is emitted from
13446 * JavaScript. There is no default implementation for this feature.
13448 * @param obj The web object where to set the hook function
13449 * @param func The callback function to be used
13450 * @param data User data
13452 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13454 * Gets the status of the tab propagation
13456 * @param obj The web object to query
13457 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13459 * @see elm_web_tab_propagate_set()
13461 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
13463 * Sets whether to use tab propagation
13465 * If tab propagation is enabled, whenever the user presses the Tab key,
13466 * Elementary will handle it and switch focus to the next widget.
13467 * The default value is disabled, where WebKit will handle the Tab key to
13468 * cycle focus though its internal objects, jumping to the next widget
13469 * only when that cycle ends.
13471 * @param obj The web object
13472 * @param propagate Whether to propagate Tab keys to Elementary or not
13474 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13476 * Sets the URI for the web object
13478 * It must be a full URI, with resource included, in the form
13479 * http://www.enlightenment.org or file:///tmp/something.html
13481 * @param obj The web object
13482 * @param uri The URI to set
13483 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13485 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
13487 * Gets the current URI for the object
13489 * The returned string must not be freed and is guaranteed to be
13492 * @param obj The web object
13493 * @return A stringshared internal string with the current URI, or NULL on
13496 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
13498 * Gets the current title
13500 * The returned string must not be freed and is guaranteed to be
13503 * @param obj The web object
13504 * @return A stringshared internal string with the current title, or NULL on
13507 EAPI const char *elm_web_title_get(const Evas_Object *obj);
13509 * Sets the background color to be used by the web object
13511 * This is the color that will be used by default when the loaded page
13512 * does not set it's own. Color values are pre-multiplied.
13514 * @param obj The web object
13515 * @param r Red component
13516 * @param g Green component
13517 * @param b Blue component
13518 * @param a Alpha component
13520 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13522 * Gets the background color to be used by the web object
13524 * This is the color that will be used by default when the loaded page
13525 * does not set it's own. Color values are pre-multiplied.
13527 * @param obj The web object
13528 * @param r Red component
13529 * @param g Green component
13530 * @param b Blue component
13531 * @param a Alpha component
13533 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13535 * Gets a copy of the currently selected text
13537 * The string returned must be freed by the user when it's done with it.
13539 * @param obj The web object
13540 * @return A newly allocated string, or NULL if nothing is selected or an
13543 EAPI char *elm_view_selection_get(const Evas_Object *obj);
13545 * Tells the web object which index in the currently open popup was selected
13547 * When the user handles the popup creation from the "popup,created" signal,
13548 * it needs to tell the web object which item was selected by calling this
13549 * function with the index corresponding to the item.
13551 * @param obj The web object
13552 * @param index The index selected
13554 * @see elm_web_popup_destroy()
13556 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
13558 * Dismisses an open dropdown popup
13560 * When the popup from a dropdown widget is to be dismissed, either after
13561 * selecting an option or to cancel it, this function must be called, which
13562 * will later emit an "popup,willdelete" signal to notify the user that
13563 * any memory and objects related to this popup can be freed.
13565 * @param obj The web object
13566 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13567 * if there was no menu to destroy
13569 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
13571 * Searches the given string in a document.
13573 * @param obj The web object where to search the text
13574 * @param string String to search
13575 * @param case_sensitive If search should be case sensitive or not
13576 * @param forward If search is from cursor and on or backwards
13577 * @param wrap If search should wrap at the end
13579 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13582 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13584 * Marks matches of the given string in a document.
13586 * @param obj The web object where to search text
13587 * @param string String to match
13588 * @param case_sensitive If match should be case sensitive or not
13589 * @param highlight If matches should be highlighted
13590 * @param limit Maximum amount of matches, or zero to unlimited
13592 * @return number of matched @a string
13594 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13596 * Clears all marked matches in the document
13598 * @param obj The web object
13600 * @return EINA_TRUE on success, EINA_FALSE otherwise
13602 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
13604 * Sets whether to highlight the matched marks
13606 * If enabled, marks set with elm_web_text_matches_mark() will be
13609 * @param obj The web object
13610 * @param highlight Whether to highlight the marks or not
13612 * @return EINA_TRUE on success, EINA_FALSE otherwise
13614 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13616 * Gets whether highlighting marks is enabled
13618 * @param The web object
13620 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13623 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
13625 * Gets the overall loading progress of the page
13627 * Returns the estimated loading progress of the page, with a value between
13628 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13629 * included in the page.
13631 * @param The web object
13633 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13636 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
13638 * Stops loading the current page
13640 * Cancels the loading of the current page in the web object. This will
13641 * cause a "load,error" signal to be emitted, with the is_cancellation
13642 * flag set to EINA_TRUE.
13644 * @param obj The web object
13646 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13648 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
13650 * Requests a reload of the current document in the object
13652 * @param obj The web object
13654 * @return EINA_TRUE on success, EINA_FALSE otherwise
13656 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
13658 * Requests a reload of the current document, avoiding any existing caches
13660 * @param obj The web object
13662 * @return EINA_TRUE on success, EINA_FALSE otherwise
13664 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
13666 * Goes back one step in the browsing history
13668 * This is equivalent to calling elm_web_object_navigate(obj, -1);
13670 * @param obj The web object
13672 * @return EINA_TRUE on success, EINA_FALSE otherwise
13674 * @see elm_web_history_enable_set()
13675 * @see elm_web_back_possible()
13676 * @see elm_web_forward()
13677 * @see elm_web_navigate()
13679 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
13681 * Goes forward one step in the browsing history
13683 * This is equivalent to calling elm_web_object_navigate(obj, 1);
13685 * @param obj The web object
13687 * @return EINA_TRUE on success, EINA_FALSE otherwise
13689 * @see elm_web_history_enable_set()
13690 * @see elm_web_forward_possible()
13691 * @see elm_web_back()
13692 * @see elm_web_navigate()
13694 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
13696 * Jumps the given number of steps in the browsing history
13698 * The @p steps value can be a negative integer to back in history, or a
13699 * positive to move forward.
13701 * @param obj The web object
13702 * @param steps The number of steps to jump
13704 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13705 * history exists to jump the given number of steps
13707 * @see elm_web_history_enable_set()
13708 * @see elm_web_navigate_possible()
13709 * @see elm_web_back()
13710 * @see elm_web_forward()
13712 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
13714 * Queries whether it's possible to go back in history
13716 * @param obj The web object
13718 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13721 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
13723 * Queries whether it's possible to go forward in history
13725 * @param obj The web object
13727 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13730 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
13732 * Queries whether it's possible to jump the given number of steps
13734 * The @p steps value can be a negative integer to back in history, or a
13735 * positive to move forward.
13737 * @param obj The web object
13738 * @param steps The number of steps to check for
13740 * @return EINA_TRUE if enough history exists to perform the given jump,
13741 * EINA_FALSE otherwise
13743 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
13745 * Gets whether browsing history is enabled for the given object
13747 * @param obj The web object
13749 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
13751 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
13753 * Enables or disables the browsing history
13755 * @param obj The web object
13756 * @param enable Whether to enable or disable the browsing history
13758 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
13760 * Sets the zoom level of the web object
13762 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
13763 * values meaning zoom in and lower meaning zoom out. This function will
13764 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
13765 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
13767 * @param obj The web object
13768 * @param zoom The zoom level to set
13770 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
13772 * Gets the current zoom level set on the web object
13774 * Note that this is the zoom level set on the web object and not that
13775 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
13776 * the two zoom levels should match, but for the other two modes the
13777 * Webkit zoom is calculated internally to match the chosen mode without
13778 * changing the zoom level set for the web object.
13780 * @param obj The web object
13782 * @return The zoom level set on the object
13784 EAPI double elm_web_zoom_get(const Evas_Object *obj);
13786 * Sets the zoom mode to use
13788 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
13789 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
13791 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
13792 * with the elm_web_zoom_set() function.
13793 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
13794 * make sure the entirety of the web object's contents are shown.
13795 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
13796 * fit the contents in the web object's size, without leaving any space
13799 * @param obj The web object
13800 * @param mode The mode to set
13802 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
13804 * Gets the currently set zoom mode
13806 * @param obj The web object
13808 * @return The current zoom mode set for the object, or
13809 * ::ELM_WEB_ZOOM_MODE_LAST on error
13811 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
13813 * Shows the given region in the web object
13815 * @param obj The web object
13816 * @param x The x coordinate of the region to show
13817 * @param y The y coordinate of the region to show
13818 * @param w The width of the region to show
13819 * @param h The height of the region to show
13821 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
13823 * Brings in the region to the visible area
13825 * Like elm_web_region_show(), but it animates the scrolling of the object
13828 * @param obj The web object
13829 * @param x The x coordinate of the region to show
13830 * @param y The y coordinate of the region to show
13831 * @param w The width of the region to show
13832 * @param h The height of the region to show
13834 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
13836 * Sets the default dialogs to use an Inwin instead of a normal window
13838 * If set, then the default implementation for the JavaScript dialogs and
13839 * file selector will be opened in an Inwin. Otherwise they will use a
13840 * normal separated window.
13842 * @param obj The web object
13843 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
13845 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
13847 * Gets whether Inwin mode is set for the current object
13849 * @param obj The web object
13851 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
13853 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
13855 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
13856 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
13857 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);
13858 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
13866 * @defgroup Hoversel Hoversel
13868 * @image html img/widget/hoversel/preview-00.png
13869 * @image latex img/widget/hoversel/preview-00.eps
13871 * A hoversel is a button that pops up a list of items (automatically
13872 * choosing the direction to display) that have a label and, optionally, an
13873 * icon to select from. It is a convenience widget to avoid the need to do
13874 * all the piecing together yourself. It is intended for a small number of
13875 * items in the hoversel menu (no more than 8), though is capable of many
13878 * Signals that you can add callbacks for are:
13879 * "clicked" - the user clicked the hoversel button and popped up the sel
13880 * "selected" - an item in the hoversel list is selected. event_info is the item
13881 * "dismissed" - the hover is dismissed
13883 * See @ref tutorial_hoversel for an example.
13886 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
13888 * @brief Add a new Hoversel object
13890 * @param parent The parent object
13891 * @return The new object or NULL if it cannot be created
13893 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13895 * @brief This sets the hoversel to expand horizontally.
13897 * @param obj The hoversel object
13898 * @param horizontal If true, the hover will expand horizontally to the
13901 * @note The initial button will display horizontally regardless of this
13904 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
13906 * @brief This returns whether the hoversel is set to expand horizontally.
13908 * @param obj The hoversel object
13909 * @return If true, the hover will expand horizontally to the right.
13911 * @see elm_hoversel_horizontal_set()
13913 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13915 * @brief Set the Hover parent
13917 * @param obj The hoversel object
13918 * @param parent The parent to use
13920 * Sets the hover parent object, the area that will be darkened when the
13921 * hoversel is clicked. Should probably be the window that the hoversel is
13922 * in. See @ref Hover objects for more information.
13924 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13926 * @brief Get the Hover parent
13928 * @param obj The hoversel object
13929 * @return The used parent
13931 * Gets the hover parent object.
13933 * @see elm_hoversel_hover_parent_set()
13935 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13937 * @brief Set the hoversel button label
13939 * @param obj The hoversel object
13940 * @param label The label text.
13942 * This sets the label of the button that is always visible (before it is
13943 * clicked and expanded).
13945 * @deprecated elm_object_text_set()
13947 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13949 * @brief Get the hoversel button label
13951 * @param obj The hoversel object
13952 * @return The label text.
13954 * @deprecated elm_object_text_get()
13956 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13958 * @brief Set the icon of the hoversel button
13960 * @param obj The hoversel object
13961 * @param icon The icon object
13963 * Sets the icon of the button that is always visible (before it is clicked
13964 * and expanded). Once the icon object is set, a previously set one will be
13965 * deleted, if you want to keep that old content object, use the
13966 * elm_hoversel_icon_unset() function.
13968 * @see elm_object_content_set() for the button widget
13970 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13972 * @brief Get the icon of the hoversel button
13974 * @param obj The hoversel object
13975 * @return The icon object
13977 * Get the icon of the button that is always visible (before it is clicked
13978 * and expanded). Also see elm_object_content_get() for the button widget.
13980 * @see elm_hoversel_icon_set()
13982 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13984 * @brief Get and unparent the icon of the hoversel button
13986 * @param obj The hoversel object
13987 * @return The icon object that was being used
13989 * Unparent and return the icon of the button that is always visible
13990 * (before it is clicked and expanded).
13992 * @see elm_hoversel_icon_set()
13993 * @see elm_object_content_unset() for the button widget
13995 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13997 * @brief This triggers the hoversel popup from code, the same as if the user
13998 * had clicked the button.
14000 * @param obj The hoversel object
14002 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14004 * @brief This dismisses the hoversel popup as if the user had clicked
14005 * outside the hover.
14007 * @param obj The hoversel object
14009 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14011 * @brief Returns whether the hoversel is expanded.
14013 * @param obj The hoversel object
14014 * @return This will return EINA_TRUE if the hoversel is expanded or
14015 * EINA_FALSE if it is not expanded.
14017 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14019 * @brief This will remove all the children items from the hoversel.
14021 * @param obj The hoversel object
14023 * @warning Should @b not be called while the hoversel is active; use
14024 * elm_hoversel_expanded_get() to check first.
14026 * @see elm_hoversel_item_del_cb_set()
14027 * @see elm_hoversel_item_del()
14029 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14031 * @brief Get the list of items within the given hoversel.
14033 * @param obj The hoversel object
14034 * @return Returns a list of Elm_Hoversel_Item*
14036 * @see elm_hoversel_item_add()
14038 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14040 * @brief Add an item to the hoversel button
14042 * @param obj The hoversel object
14043 * @param label The text label to use for the item (NULL if not desired)
14044 * @param icon_file An image file path on disk to use for the icon or standard
14045 * icon name (NULL if not desired)
14046 * @param icon_type The icon type if relevant
14047 * @param func Convenience function to call when this item is selected
14048 * @param data Data to pass to item-related functions
14049 * @return A handle to the item added.
14051 * This adds an item to the hoversel to show when it is clicked. Note: if you
14052 * need to use an icon from an edje file then use
14053 * elm_hoversel_item_icon_set() right after the this function, and set
14054 * icon_file to NULL here.
14056 * For more information on what @p icon_file and @p icon_type are see the
14057 * @ref Icon "icon documentation".
14059 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);
14061 * @brief Delete an item from the hoversel
14063 * @param item The item to delete
14065 * This deletes the item from the hoversel (should not be called while the
14066 * hoversel is active; use elm_hoversel_expanded_get() to check first).
14068 * @see elm_hoversel_item_add()
14069 * @see elm_hoversel_item_del_cb_set()
14071 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14073 * @brief Set the function to be called when an item from the hoversel is
14076 * @param item The item to set the callback on
14077 * @param func The function called
14079 * That function will receive these parameters:
14080 * @li void *item_data
14081 * @li Evas_Object *the_item_object
14082 * @li Elm_Hoversel_Item *the_object_struct
14084 * @see elm_hoversel_item_add()
14086 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14088 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14089 * that will be passed to associated function callbacks.
14091 * @param item The item to get the data from
14092 * @return The data pointer set with elm_hoversel_item_add()
14094 * @see elm_hoversel_item_add()
14096 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14098 * @brief This returns the label text of the given hoversel item.
14100 * @param item The item to get the label
14101 * @return The label text of the hoversel item
14103 * @see elm_hoversel_item_add()
14105 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14107 * @brief This sets the icon for the given hoversel item.
14109 * @param item The item to set the icon
14110 * @param icon_file An image file path on disk to use for the icon or standard
14112 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14113 * to NULL if the icon is not an edje file
14114 * @param icon_type The icon type
14116 * The icon can be loaded from the standard set, from an image file, or from
14119 * @see elm_hoversel_item_add()
14121 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);
14123 * @brief Get the icon object of the hoversel item
14125 * @param item The item to get the icon from
14126 * @param icon_file The image file path on disk used for the icon or standard
14128 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14129 * if the icon is not an edje file
14130 * @param icon_type The icon type
14132 * @see elm_hoversel_item_icon_set()
14133 * @see elm_hoversel_item_add()
14135 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);
14141 * @defgroup Toolbar Toolbar
14142 * @ingroup Elementary
14144 * @image html img/widget/toolbar/preview-00.png
14145 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14147 * @image html img/toolbar.png
14148 * @image latex img/toolbar.eps width=\textwidth
14150 * A toolbar is a widget that displays a list of items inside
14151 * a box. It can be scrollable, show a menu with items that don't fit
14152 * to toolbar size or even crop them.
14154 * Only one item can be selected at a time.
14156 * Items can have multiple states, or show menus when selected by the user.
14158 * Smart callbacks one can listen to:
14159 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14160 * - "language,changed" - when the program language changes
14162 * Available styles for it:
14164 * - @c "transparent" - no background or shadow, just show the content
14166 * List of examples:
14167 * @li @ref toolbar_example_01
14168 * @li @ref toolbar_example_02
14169 * @li @ref toolbar_example_03
14173 * @addtogroup Toolbar
14178 * @enum _Elm_Toolbar_Shrink_Mode
14179 * @typedef Elm_Toolbar_Shrink_Mode
14181 * Set toolbar's items display behavior, it can be scrollabel,
14182 * show a menu with exceeding items, or simply hide them.
14184 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14187 * Values <b> don't </b> work as bitmask, only one can be choosen.
14189 * @see elm_toolbar_mode_shrink_set()
14190 * @see elm_toolbar_mode_shrink_get()
14194 typedef enum _Elm_Toolbar_Shrink_Mode
14196 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
14197 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
14198 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14199 ELM_TOOLBAR_SHRINK_MENU, /**< Inserts a button to pop up a menu with exceeding items. */
14200 } Elm_Toolbar_Shrink_Mode;
14202 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(). */
14204 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(). */
14207 * Add a new toolbar widget to the given parent Elementary
14208 * (container) object.
14210 * @param parent The parent object.
14211 * @return a new toolbar widget handle or @c NULL, on errors.
14213 * This function inserts a new toolbar widget on the canvas.
14217 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14220 * Set the icon size, in pixels, to be used by toolbar items.
14222 * @param obj The toolbar object
14223 * @param icon_size The icon size in pixels
14225 * @note Default value is @c 32. It reads value from elm config.
14227 * @see elm_toolbar_icon_size_get()
14231 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14234 * Get the icon size, in pixels, to be used by toolbar items.
14236 * @param obj The toolbar object.
14237 * @return The icon size in pixels.
14239 * @see elm_toolbar_icon_size_set() for details.
14243 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14246 * Sets icon lookup order, for toolbar items' icons.
14248 * @param obj The toolbar object.
14249 * @param order The icon lookup order.
14251 * Icons added before calling this function will not be affected.
14252 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14254 * @see elm_toolbar_icon_order_lookup_get()
14258 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14261 * Gets the icon lookup order.
14263 * @param obj The toolbar object.
14264 * @return The icon lookup order.
14266 * @see elm_toolbar_icon_order_lookup_set() for details.
14270 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14273 * Set whether the toolbar items' should be selected by the user or not.
14275 * @param obj The toolbar object.
14276 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14279 * This will turn off the ability to select items entirely and they will
14280 * neither appear selected nor emit selected signals. The clicked
14281 * callback function will still be called.
14283 * Selection is enabled by default.
14285 * @see elm_toolbar_no_select_mode_get().
14289 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14292 * Set whether the toolbar items' should be selected by the user or not.
14294 * @param obj The toolbar object.
14295 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14296 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14298 * @see elm_toolbar_no_select_mode_set() for details.
14302 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14305 * Append item to the toolbar.
14307 * @param obj The toolbar object.
14308 * @param icon A string with icon name or the absolute path of an image file.
14309 * @param label The label of the item.
14310 * @param func The function to call when the item is clicked.
14311 * @param data The data to associate with the item for related callbacks.
14312 * @return The created item or @c NULL upon failure.
14314 * A new item will be created and appended to the toolbar, i.e., will
14315 * be set as @b last item.
14317 * Items created with this method can be deleted with
14318 * elm_toolbar_item_del().
14320 * Associated @p data can be properly freed when item is deleted if a
14321 * callback function is set with elm_toolbar_item_del_cb_set().
14323 * If a function is passed as argument, it will be called everytime this item
14324 * is selected, i.e., the user clicks over an unselected item.
14325 * If such function isn't needed, just passing
14326 * @c NULL as @p func is enough. The same should be done for @p data.
14328 * Toolbar will load icon image from fdo or current theme.
14329 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14330 * If an absolute path is provided it will load it direct from a file.
14332 * @see elm_toolbar_item_icon_set()
14333 * @see elm_toolbar_item_del()
14334 * @see elm_toolbar_item_del_cb_set()
14338 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);
14341 * Prepend item to the toolbar.
14343 * @param obj The toolbar object.
14344 * @param icon A string with icon name or the absolute path of an image file.
14345 * @param label The label of the item.
14346 * @param func The function to call when the item is clicked.
14347 * @param data The data to associate with the item for related callbacks.
14348 * @return The created item or @c NULL upon failure.
14350 * A new item will be created and prepended to the toolbar, i.e., will
14351 * be set as @b first item.
14353 * Items created with this method can be deleted with
14354 * elm_toolbar_item_del().
14356 * Associated @p data can be properly freed when item is deleted if a
14357 * callback function is set with elm_toolbar_item_del_cb_set().
14359 * If a function is passed as argument, it will be called everytime this item
14360 * is selected, i.e., the user clicks over an unselected item.
14361 * If such function isn't needed, just passing
14362 * @c NULL as @p func is enough. The same should be done for @p data.
14364 * Toolbar will load icon image from fdo or current theme.
14365 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14366 * If an absolute path is provided it will load it direct from a file.
14368 * @see elm_toolbar_item_icon_set()
14369 * @see elm_toolbar_item_del()
14370 * @see elm_toolbar_item_del_cb_set()
14374 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);
14377 * Insert a new item into the toolbar object before item @p before.
14379 * @param obj The toolbar object.
14380 * @param before The toolbar item to insert before.
14381 * @param icon A string with icon name or the absolute path of an image file.
14382 * @param label The label of the item.
14383 * @param func The function to call when the item is clicked.
14384 * @param data The data to associate with the item for related callbacks.
14385 * @return The created item or @c NULL upon failure.
14387 * A new item will be created and added to the toolbar. Its position in
14388 * this toolbar will be just before item @p before.
14390 * Items created with this method can be deleted with
14391 * elm_toolbar_item_del().
14393 * Associated @p data can be properly freed when item is deleted if a
14394 * callback function is set with elm_toolbar_item_del_cb_set().
14396 * If a function is passed as argument, it will be called everytime this item
14397 * is selected, i.e., the user clicks over an unselected item.
14398 * If such function isn't needed, just passing
14399 * @c NULL as @p func is enough. The same should be done for @p data.
14401 * Toolbar will load icon image from fdo or current theme.
14402 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14403 * If an absolute path is provided it will load it direct from a file.
14405 * @see elm_toolbar_item_icon_set()
14406 * @see elm_toolbar_item_del()
14407 * @see elm_toolbar_item_del_cb_set()
14411 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);
14414 * Insert a new item into the toolbar object after item @p after.
14416 * @param obj The toolbar object.
14417 * @param after The toolbar item to insert after.
14418 * @param icon A string with icon name or the absolute path of an image file.
14419 * @param label The label of the item.
14420 * @param func The function to call when the item is clicked.
14421 * @param data The data to associate with the item for related callbacks.
14422 * @return The created item or @c NULL upon failure.
14424 * A new item will be created and added to the toolbar. Its position in
14425 * this toolbar will be just after item @p after.
14427 * Items created with this method can be deleted with
14428 * elm_toolbar_item_del().
14430 * Associated @p data can be properly freed when item is deleted if a
14431 * callback function is set with elm_toolbar_item_del_cb_set().
14433 * If a function is passed as argument, it will be called everytime this item
14434 * is selected, i.e., the user clicks over an unselected item.
14435 * If such function isn't needed, just passing
14436 * @c NULL as @p func is enough. The same should be done for @p data.
14438 * Toolbar will load icon image from fdo or current theme.
14439 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14440 * If an absolute path is provided it will load it direct from a file.
14442 * @see elm_toolbar_item_icon_set()
14443 * @see elm_toolbar_item_del()
14444 * @see elm_toolbar_item_del_cb_set()
14448 EAPI Elm_Toolbar_Item *elm_toolbar_item_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);
14451 * Get the first item in the given toolbar widget's list of
14454 * @param obj The toolbar object
14455 * @return The first item or @c NULL, if it has no items (and on
14458 * @see elm_toolbar_item_append()
14459 * @see elm_toolbar_last_item_get()
14463 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14466 * Get the last item in the given toolbar widget's list of
14469 * @param obj The toolbar object
14470 * @return The last item or @c NULL, if it has no items (and on
14473 * @see elm_toolbar_item_prepend()
14474 * @see elm_toolbar_first_item_get()
14478 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14481 * Get the item after @p item in toolbar.
14483 * @param item The toolbar item.
14484 * @return The item after @p item, or @c NULL if none or on failure.
14486 * @note If it is the last item, @c NULL will be returned.
14488 * @see elm_toolbar_item_append()
14492 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14495 * Get the item before @p item in toolbar.
14497 * @param item The toolbar item.
14498 * @return The item before @p item, or @c NULL if none or on failure.
14500 * @note If it is the first item, @c NULL will be returned.
14502 * @see elm_toolbar_item_prepend()
14506 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14509 * Get the toolbar object from an item.
14511 * @param item The item.
14512 * @return The toolbar object.
14514 * This returns the toolbar object itself that an item belongs to.
14518 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14521 * Set the priority of a toolbar item.
14523 * @param item The toolbar item.
14524 * @param priority The item priority. The default is zero.
14526 * This is used only when the toolbar shrink mode is set to
14527 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14528 * When space is less than required, items with low priority
14529 * will be removed from the toolbar and added to a dynamically-created menu,
14530 * while items with higher priority will remain on the toolbar,
14531 * with the same order they were added.
14533 * @see elm_toolbar_item_priority_get()
14537 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14540 * Get the priority of a toolbar item.
14542 * @param item The toolbar item.
14543 * @return The @p item priority, or @c 0 on failure.
14545 * @see elm_toolbar_item_priority_set() for details.
14549 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14552 * Get the label of item.
14554 * @param item The item of toolbar.
14555 * @return The label of item.
14557 * The return value is a pointer to the label associated to @p item when
14558 * it was created, with function elm_toolbar_item_append() or similar,
14560 * with function elm_toolbar_item_label_set. If no label
14561 * was passed as argument, it will return @c NULL.
14563 * @see elm_toolbar_item_label_set() for more details.
14564 * @see elm_toolbar_item_append()
14568 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14571 * Set the label of item.
14573 * @param item The item of toolbar.
14574 * @param text The label of item.
14576 * The label to be displayed by the item.
14577 * Label will be placed at icons bottom (if set).
14579 * If a label was passed as argument on item creation, with function
14580 * elm_toolbar_item_append() or similar, it will be already
14581 * displayed by the item.
14583 * @see elm_toolbar_item_label_get()
14584 * @see elm_toolbar_item_append()
14588 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14591 * Return the data associated with a given toolbar widget item.
14593 * @param item The toolbar widget item handle.
14594 * @return The data associated with @p item.
14596 * @see elm_toolbar_item_data_set()
14600 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14603 * Set the data associated with a given toolbar widget item.
14605 * @param item The toolbar widget item handle.
14606 * @param data The new data pointer to set to @p item.
14608 * This sets new item data on @p item.
14610 * @warning The old data pointer won't be touched by this function, so
14611 * the user had better to free that old data himself/herself.
14615 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14618 * Returns a pointer to a toolbar item by its label.
14620 * @param obj The toolbar object.
14621 * @param label The label of the item to find.
14623 * @return The pointer to the toolbar item matching @p label or @c NULL
14628 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14631 * Get whether the @p item is selected or not.
14633 * @param item The toolbar item.
14634 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14635 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14637 * @see elm_toolbar_selected_item_set() for details.
14638 * @see elm_toolbar_item_selected_get()
14642 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14645 * Set the selected state of an item.
14647 * @param item The toolbar item
14648 * @param selected The selected state
14650 * This sets the selected state of the given item @p it.
14651 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14653 * If a new item is selected the previosly selected will be unselected.
14654 * Previoulsy selected item can be get with function
14655 * elm_toolbar_selected_item_get().
14657 * Selected items will be highlighted.
14659 * @see elm_toolbar_item_selected_get()
14660 * @see elm_toolbar_selected_item_get()
14664 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14667 * Get the selected item.
14669 * @param obj The toolbar object.
14670 * @return The selected toolbar item.
14672 * The selected item can be unselected with function
14673 * elm_toolbar_item_selected_set().
14675 * The selected item always will be highlighted on toolbar.
14677 * @see elm_toolbar_selected_items_get()
14681 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14684 * Set the icon associated with @p item.
14686 * @param obj The parent of this item.
14687 * @param item The toolbar item.
14688 * @param icon A string with icon name or the absolute path of an image file.
14690 * Toolbar will load icon image from fdo or current theme.
14691 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14692 * If an absolute path is provided it will load it direct from a file.
14694 * @see elm_toolbar_icon_order_lookup_set()
14695 * @see elm_toolbar_icon_order_lookup_get()
14699 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
14702 * Get the string used to set the icon of @p item.
14704 * @param item The toolbar item.
14705 * @return The string associated with the icon object.
14707 * @see elm_toolbar_item_icon_set() for details.
14711 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14714 * Get the object of @p item.
14716 * @param item The toolbar item.
14717 * @return The object
14721 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14724 * Get the icon object of @p item.
14726 * @param item The toolbar item.
14727 * @return The icon object
14729 * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
14733 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14736 * Set the icon associated with @p item to an image in a binary buffer.
14738 * @param item The toolbar item.
14739 * @param img The binary data that will be used as an image
14740 * @param size The size of binary data @p img
14741 * @param format Optional format of @p img to pass to the image loader
14742 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
14744 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
14746 * @note The icon image set by this function can be changed by
14747 * elm_toolbar_item_icon_set().
14751 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);
14754 * Delete them item from the toolbar.
14756 * @param item The item of toolbar to be deleted.
14758 * @see elm_toolbar_item_append()
14759 * @see elm_toolbar_item_del_cb_set()
14763 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14766 * Set the function called when a toolbar item is freed.
14768 * @param item The item to set the callback on.
14769 * @param func The function called.
14771 * If there is a @p func, then it will be called prior item's memory release.
14772 * That will be called with the following arguments:
14774 * @li item's Evas object;
14777 * This way, a data associated to a toolbar item could be properly freed.
14781 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14784 * Get a value whether toolbar item is disabled or not.
14786 * @param item The item.
14787 * @return The disabled state.
14789 * @see elm_toolbar_item_disabled_set() for more details.
14793 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14796 * Sets the disabled/enabled state of a toolbar item.
14798 * @param item The item.
14799 * @param disabled The disabled state.
14801 * A disabled item cannot be selected or unselected. It will also
14802 * change its appearance (generally greyed out). This sets the
14803 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
14808 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14811 * Set or unset item as a separator.
14813 * @param item The toolbar item.
14814 * @param setting @c EINA_TRUE to set item @p item as separator or
14815 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
14817 * Items aren't set as separator by default.
14819 * If set as separator it will display separator theme, so won't display
14822 * @see elm_toolbar_item_separator_get()
14826 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
14829 * Get a value whether item is a separator or not.
14831 * @param item The toolbar item.
14832 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
14833 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
14835 * @see elm_toolbar_item_separator_set() for details.
14839 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14842 * Set the shrink state of toolbar @p obj.
14844 * @param obj The toolbar object.
14845 * @param shrink_mode Toolbar's items display behavior.
14847 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
14848 * but will enforce a minimun size so all the items will fit, won't scroll
14849 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
14850 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
14851 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
14855 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
14858 * Get the shrink mode of toolbar @p obj.
14860 * @param obj The toolbar object.
14861 * @return Toolbar's items display behavior.
14863 * @see elm_toolbar_mode_shrink_set() for details.
14867 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14870 * Enable/disable homogenous mode.
14872 * @param obj The toolbar object
14873 * @param homogeneous Assume the items within the toolbar are of the
14874 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
14876 * This will enable the homogeneous mode where items are of the same size.
14877 * @see elm_toolbar_homogeneous_get()
14881 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
14884 * Get whether the homogenous mode is enabled.
14886 * @param obj The toolbar object.
14887 * @return Assume the items within the toolbar are of the same height
14888 * and width (EINA_TRUE = on, EINA_FALSE = off).
14890 * @see elm_toolbar_homogeneous_set()
14894 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14897 * Enable/disable homogenous mode.
14899 * @param obj The toolbar object
14900 * @param homogeneous Assume the items within the toolbar are of the
14901 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
14903 * This will enable the homogeneous mode where items are of the same size.
14904 * @see elm_toolbar_homogeneous_get()
14906 * @deprecated use elm_toolbar_homogeneous_set() instead.
14910 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
14913 * Get whether the homogenous mode is enabled.
14915 * @param obj The toolbar object.
14916 * @return Assume the items within the toolbar are of the same height
14917 * and width (EINA_TRUE = on, EINA_FALSE = off).
14919 * @see elm_toolbar_homogeneous_set()
14920 * @deprecated use elm_toolbar_homogeneous_get() instead.
14924 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14927 * Set the parent object of the toolbar items' menus.
14929 * @param obj The toolbar object.
14930 * @param parent The parent of the menu objects.
14932 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
14934 * For more details about setting the parent for toolbar menus, see
14935 * elm_menu_parent_set().
14937 * @see elm_menu_parent_set() for details.
14938 * @see elm_toolbar_item_menu_set() for details.
14942 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14945 * Get the parent object of the toolbar items' menus.
14947 * @param obj The toolbar object.
14948 * @return The parent of the menu objects.
14950 * @see elm_toolbar_menu_parent_set() for details.
14954 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14957 * Set the alignment of the items.
14959 * @param obj The toolbar object.
14960 * @param align The new alignment, a float between <tt> 0.0 </tt>
14961 * and <tt> 1.0 </tt>.
14963 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
14964 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
14967 * Centered items by default.
14969 * @see elm_toolbar_align_get()
14973 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
14976 * Get the alignment of the items.
14978 * @param obj The toolbar object.
14979 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
14982 * @see elm_toolbar_align_set() for details.
14986 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14989 * Set whether the toolbar item opens a menu.
14991 * @param item The toolbar item.
14992 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
14994 * A toolbar item can be set to be a menu, using this function.
14996 * Once it is set to be a menu, it can be manipulated through the
14997 * menu-like function elm_toolbar_menu_parent_set() and the other
14998 * elm_menu functions, using the Evas_Object @c menu returned by
14999 * elm_toolbar_item_menu_get().
15001 * So, items to be displayed in this item's menu should be added with
15002 * elm_menu_item_add().
15004 * The following code exemplifies the most basic usage:
15006 * tb = elm_toolbar_add(win)
15007 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15008 * elm_toolbar_item_menu_set(item, EINA_TRUE);
15009 * elm_toolbar_menu_parent_set(tb, win);
15010 * menu = elm_toolbar_item_menu_get(item);
15011 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15012 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15016 * @see elm_toolbar_item_menu_get()
15020 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15023 * Get toolbar item's menu.
15025 * @param item The toolbar item.
15026 * @return Item's menu object or @c NULL on failure.
15028 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15029 * this function will set it.
15031 * @see elm_toolbar_item_menu_set() for details.
15035 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15038 * Add a new state to @p item.
15040 * @param item The item.
15041 * @param icon A string with icon name or the absolute path of an image file.
15042 * @param label The label of the new state.
15043 * @param func The function to call when the item is clicked when this
15044 * state is selected.
15045 * @param data The data to associate with the state.
15046 * @return The toolbar item state, or @c NULL upon failure.
15048 * Toolbar will load icon image from fdo or current theme.
15049 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15050 * If an absolute path is provided it will load it direct from a file.
15052 * States created with this function can be removed with
15053 * elm_toolbar_item_state_del().
15055 * @see elm_toolbar_item_state_del()
15056 * @see elm_toolbar_item_state_sel()
15057 * @see elm_toolbar_item_state_get()
15061 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);
15064 * Delete a previoulsy added state to @p item.
15066 * @param item The toolbar item.
15067 * @param state The state to be deleted.
15068 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15070 * @see elm_toolbar_item_state_add()
15072 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15075 * Set @p state as the current state of @p it.
15077 * @param it The item.
15078 * @param state The state to use.
15079 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15081 * If @p state is @c NULL, it won't select any state and the default item's
15082 * icon and label will be used. It's the same behaviour than
15083 * elm_toolbar_item_state_unser().
15085 * @see elm_toolbar_item_state_unset()
15089 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15092 * Unset the state of @p it.
15094 * @param it The item.
15096 * The default icon and label from this item will be displayed.
15098 * @see elm_toolbar_item_state_set() for more details.
15102 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15105 * Get the current state of @p it.
15107 * @param item The item.
15108 * @return The selected state or @c NULL if none is selected or on failure.
15110 * @see elm_toolbar_item_state_set() for details.
15111 * @see elm_toolbar_item_state_unset()
15112 * @see elm_toolbar_item_state_add()
15116 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15119 * Get the state after selected state in toolbar's @p item.
15121 * @param it The toolbar item to change state.
15122 * @return The state after current state, or @c NULL on failure.
15124 * If last state is selected, this function will return first state.
15126 * @see elm_toolbar_item_state_set()
15127 * @see elm_toolbar_item_state_add()
15131 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15134 * Get the state before selected state in toolbar's @p item.
15136 * @param it The toolbar item to change state.
15137 * @return The state before current state, or @c NULL on failure.
15139 * If first state is selected, this function will return last state.
15141 * @see elm_toolbar_item_state_set()
15142 * @see elm_toolbar_item_state_add()
15146 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15149 * Set the text to be shown in a given toolbar item's tooltips.
15151 * @param item Target item.
15152 * @param text The text to set in the content.
15154 * Setup the text as tooltip to object. The item can have only one tooltip,
15155 * so any previous tooltip data - set with this function or
15156 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15158 * @see elm_object_tooltip_text_set() for more details.
15162 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15165 * Set the content to be shown in the tooltip item.
15167 * Setup the tooltip to item. The item can have only one tooltip,
15168 * so any previous tooltip data is removed. @p func(with @p data) will
15169 * be called every time that need show the tooltip and it should
15170 * return a valid Evas_Object. This object is then managed fully by
15171 * tooltip system and is deleted when the tooltip is gone.
15173 * @param item the toolbar item being attached a tooltip.
15174 * @param func the function used to create the tooltip contents.
15175 * @param data what to provide to @a func as callback data/context.
15176 * @param del_cb called when data is not needed anymore, either when
15177 * another callback replaces @a func, the tooltip is unset with
15178 * elm_toolbar_item_tooltip_unset() or the owner @a item
15179 * dies. This callback receives as the first parameter the
15180 * given @a data, and @c event_info is the item.
15182 * @see elm_object_tooltip_content_cb_set() for more details.
15186 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);
15189 * Unset tooltip from item.
15191 * @param item toolbar item to remove previously set tooltip.
15193 * Remove tooltip from item. The callback provided as del_cb to
15194 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15195 * it is not used anymore.
15197 * @see elm_object_tooltip_unset() for more details.
15198 * @see elm_toolbar_item_tooltip_content_cb_set()
15202 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15205 * Sets a different style for this item tooltip.
15207 * @note before you set a style you should define a tooltip with
15208 * elm_toolbar_item_tooltip_content_cb_set() or
15209 * elm_toolbar_item_tooltip_text_set()
15211 * @param item toolbar item with tooltip already set.
15212 * @param style the theme style to use (default, transparent, ...)
15214 * @see elm_object_tooltip_style_set() for more details.
15218 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15221 * Get the style for this item tooltip.
15223 * @param item toolbar item with tooltip already set.
15224 * @return style the theme style in use, defaults to "default". If the
15225 * object does not have a tooltip set, then NULL is returned.
15227 * @see elm_object_tooltip_style_get() for more details.
15228 * @see elm_toolbar_item_tooltip_style_set()
15232 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15235 * Set the type of mouse pointer/cursor decoration to be shown,
15236 * when the mouse pointer is over the given toolbar widget item
15238 * @param item toolbar item to customize cursor on
15239 * @param cursor the cursor type's name
15241 * This function works analogously as elm_object_cursor_set(), but
15242 * here the cursor's changing area is restricted to the item's
15243 * area, and not the whole widget's. Note that that item cursors
15244 * have precedence over widget cursors, so that a mouse over an
15245 * item with custom cursor set will always show @b that cursor.
15247 * If this function is called twice for an object, a previously set
15248 * cursor will be unset on the second call.
15250 * @see elm_object_cursor_set()
15251 * @see elm_toolbar_item_cursor_get()
15252 * @see elm_toolbar_item_cursor_unset()
15256 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15259 * Get the type of mouse pointer/cursor decoration set to be shown,
15260 * when the mouse pointer is over the given toolbar widget item
15262 * @param item toolbar item with custom cursor set
15263 * @return the cursor type's name or @c NULL, if no custom cursors
15264 * were set to @p item (and on errors)
15266 * @see elm_object_cursor_get()
15267 * @see elm_toolbar_item_cursor_set()
15268 * @see elm_toolbar_item_cursor_unset()
15272 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15275 * Unset any custom mouse pointer/cursor decoration set to be
15276 * shown, when the mouse pointer is over the given toolbar widget
15277 * item, thus making it show the @b default cursor again.
15279 * @param item a toolbar item
15281 * Use this call to undo any custom settings on this item's cursor
15282 * decoration, bringing it back to defaults (no custom style set).
15284 * @see elm_object_cursor_unset()
15285 * @see elm_toolbar_item_cursor_set()
15289 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15292 * Set a different @b style for a given custom cursor set for a
15295 * @param item toolbar item with custom cursor set
15296 * @param style the <b>theme style</b> to use (e.g. @c "default",
15297 * @c "transparent", etc)
15299 * This function only makes sense when one is using custom mouse
15300 * cursor decorations <b>defined in a theme file</b>, which can have,
15301 * given a cursor name/type, <b>alternate styles</b> on it. It
15302 * works analogously as elm_object_cursor_style_set(), but here
15303 * applyed only to toolbar item objects.
15305 * @warning Before you set a cursor style you should have definen a
15306 * custom cursor previously on the item, with
15307 * elm_toolbar_item_cursor_set()
15309 * @see elm_toolbar_item_cursor_engine_only_set()
15310 * @see elm_toolbar_item_cursor_style_get()
15314 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15317 * Get the current @b style set for a given toolbar item's custom
15320 * @param item toolbar item with custom cursor set.
15321 * @return style the cursor style in use. If the object does not
15322 * have a cursor set, then @c NULL is returned.
15324 * @see elm_toolbar_item_cursor_style_set() for more details
15328 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15331 * Set if the (custom)cursor for a given toolbar item should be
15332 * searched in its theme, also, or should only rely on the
15333 * rendering engine.
15335 * @param item item with custom (custom) cursor already set on
15336 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15337 * only on those provided by the rendering engine, @c EINA_FALSE to
15338 * have them searched on the widget's theme, as well.
15340 * @note This call is of use only if you've set a custom cursor
15341 * for toolbar items, with elm_toolbar_item_cursor_set().
15343 * @note By default, cursors will only be looked for between those
15344 * provided by the rendering engine.
15348 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15351 * Get if the (custom) cursor for a given toolbar item is being
15352 * searched in its theme, also, or is only relying on the rendering
15355 * @param item a toolbar item
15356 * @return @c EINA_TRUE, if cursors are being looked for only on
15357 * those provided by the rendering engine, @c EINA_FALSE if they
15358 * are being searched on the widget's theme, as well.
15360 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15364 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15367 * Change a toolbar's orientation
15368 * @param obj The toolbar object
15369 * @param vertical If @c EINA_TRUE, the toolbar is vertical
15370 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15372 * @deprecated use elm_toolbar_horizontal_set() instead.
15374 EINA_DEPRECATED EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15377 * Change a toolbar's orientation
15378 * @param obj The toolbar object
15379 * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15380 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15383 EAPI void elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15386 * Get a toolbar's orientation
15387 * @param obj The toolbar object
15388 * @return If @c EINA_TRUE, the toolbar is vertical
15389 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15391 * @deprecated use elm_toolbar_horizontal_get() instead.
15393 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15396 * Get a toolbar's orientation
15397 * @param obj The toolbar object
15398 * @return If @c EINA_TRUE, the toolbar is horizontal
15399 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15402 EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15408 * @defgroup Tooltips Tooltips
15410 * The Tooltip is an (internal, for now) smart object used to show a
15411 * content in a frame on mouse hover of objects(or widgets), with
15412 * tips/information about them.
15417 EAPI double elm_tooltip_delay_get(void);
15418 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
15419 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15420 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15421 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15422 EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15423 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15424 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);
15425 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15426 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15427 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15430 * @defgroup Cursors Cursors
15432 * The Elementary cursor is an internal smart object used to
15433 * customize the mouse cursor displayed over objects (or
15434 * widgets). In the most common scenario, the cursor decoration
15435 * comes from the graphical @b engine Elementary is running
15436 * on. Those engines may provide different decorations for cursors,
15437 * and Elementary provides functions to choose them (think of X11
15438 * cursors, as an example).
15440 * There's also the possibility of, besides using engine provided
15441 * cursors, also use ones coming from Edje theming files. Both
15442 * globally and per widget, Elementary makes it possible for one to
15443 * make the cursors lookup to be held on engines only or on
15444 * Elementary's theme file, too. To set cursor's hot spot,
15445 * two data items should be added to cursor's theme: "hot_x" and
15446 * "hot_y", that are the offset from upper-left corner of the cursor
15447 * (coordinates 0,0).
15453 * Set the cursor to be shown when mouse is over the object
15455 * Set the cursor that will be displayed when mouse is over the
15456 * object. The object can have only one cursor set to it, so if
15457 * this function is called twice for an object, the previous set
15459 * If using X cursors, a definition of all the valid cursor names
15460 * is listed on Elementary_Cursors.h. If an invalid name is set
15461 * the default cursor will be used.
15463 * @param obj the object being set a cursor.
15464 * @param cursor the cursor name to be used.
15468 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15471 * Get the cursor to be shown when mouse is over the object
15473 * @param obj an object with cursor already set.
15474 * @return the cursor name.
15478 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15481 * Unset cursor for object
15483 * Unset cursor for object, and set the cursor to default if the mouse
15484 * was over this object.
15486 * @param obj Target object
15487 * @see elm_object_cursor_set()
15491 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15494 * Sets a different style for this object cursor.
15496 * @note before you set a style you should define a cursor with
15497 * elm_object_cursor_set()
15499 * @param obj an object with cursor already set.
15500 * @param style the theme style to use (default, transparent, ...)
15504 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15507 * Get the style for this object cursor.
15509 * @param obj an object with cursor already set.
15510 * @return style the theme style in use, defaults to "default". If the
15511 * object does not have a cursor set, then NULL is returned.
15515 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15518 * Set if the cursor set should be searched on the theme or should use
15519 * the provided by the engine, only.
15521 * @note before you set if should look on theme you should define a cursor
15522 * with elm_object_cursor_set(). By default it will only look for cursors
15523 * provided by the engine.
15525 * @param obj an object with cursor already set.
15526 * @param engine_only boolean to define it cursors should be looked only
15527 * between the provided by the engine or searched on widget's theme as well.
15531 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15534 * Get the cursor engine only usage for this object cursor.
15536 * @param obj an object with cursor already set.
15537 * @return engine_only boolean to define it cursors should be
15538 * looked only between the provided by the engine or searched on
15539 * widget's theme as well. If the object does not have a cursor
15540 * set, then EINA_FALSE is returned.
15544 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15547 * Get the configured cursor engine only usage
15549 * This gets the globally configured exclusive usage of engine cursors.
15551 * @return 1 if only engine cursors should be used
15554 EAPI int elm_cursor_engine_only_get(void);
15557 * Set the configured cursor engine only usage
15559 * This sets the globally configured exclusive usage of engine cursors.
15560 * It won't affect cursors set before changing this value.
15562 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15563 * look for them on theme before.
15564 * @return EINA_TRUE if value is valid and setted (0 or 1)
15567 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
15574 * @defgroup Menu Menu
15576 * @image html img/widget/menu/preview-00.png
15577 * @image latex img/widget/menu/preview-00.eps
15579 * A menu is a list of items displayed above its parent. When the menu is
15580 * showing its parent is darkened. Each item can have a sub-menu. The menu
15581 * object can be used to display a menu on a right click event, in a toolbar,
15584 * Signals that you can add callbacks for are:
15585 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15586 * event_info is NULL.
15588 * @see @ref tutorial_menu
15591 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15593 * @brief Add a new menu to the parent
15595 * @param parent The parent object.
15596 * @return The new object or NULL if it cannot be created.
15598 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15600 * @brief Set the parent for the given menu widget
15602 * @param obj The menu object.
15603 * @param parent The new parent.
15605 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15607 * @brief Get the parent for the given menu widget
15609 * @param obj The menu object.
15610 * @return The parent.
15612 * @see elm_menu_parent_set()
15614 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15616 * @brief Move the menu to a new position
15618 * @param obj The menu object.
15619 * @param x The new position.
15620 * @param y The new position.
15622 * Sets the top-left position of the menu to (@p x,@p y).
15624 * @note @p x and @p y coordinates are relative to parent.
15626 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15628 * @brief Close a opened menu
15630 * @param obj the menu object
15633 * Hides the menu and all it's sub-menus.
15635 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15637 * @brief Returns a list of @p item's items.
15639 * @param obj The menu object
15640 * @return An Eina_List* of @p item's items
15642 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15644 * @brief Get the Evas_Object of an Elm_Menu_Item
15646 * @param item The menu item object.
15647 * @return The edje object containing the swallowed content
15649 * @warning Don't manipulate this object!
15651 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15653 * @brief Add an item at the end of the given menu widget
15655 * @param obj The menu object.
15656 * @param parent The parent menu item (optional)
15657 * @param icon A icon display on the item. The icon will be destryed by the menu.
15658 * @param label The label of the item.
15659 * @param func Function called when the user select the item.
15660 * @param data Data sent by the callback.
15661 * @return Returns the new item.
15663 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);
15665 * @brief Set the label of a menu item
15667 * @param item The menu item object.
15668 * @param label The label to set for @p item
15670 * @warning Don't use this funcion on items created with
15671 * elm_menu_item_add_object() or elm_menu_item_separator_add().
15673 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15675 * @brief Get the label of a menu item
15677 * @param item The menu item object.
15678 * @return The label of @p item
15680 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15681 EAPI void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
15682 EAPI const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15683 EAPI const Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15686 * @brief Set the selected state of @p item.
15688 * @param item The menu item object.
15689 * @param selected The selected/unselected state of the item
15691 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15693 * @brief Get the selected state of @p item.
15695 * @param item The menu item object.
15696 * @return The selected/unselected state of the item
15698 * @see elm_menu_item_selected_set()
15700 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15702 * @brief Set the disabled state of @p item.
15704 * @param item The menu item object.
15705 * @param disabled The enabled/disabled state of the item
15707 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15709 * @brief Get the disabled state of @p item.
15711 * @param item The menu item object.
15712 * @return The enabled/disabled state of the item
15714 * @see elm_menu_item_disabled_set()
15716 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15718 * @brief Add a separator item to menu @p obj under @p parent.
15720 * @param obj The menu object
15721 * @param parent The item to add the separator under
15722 * @return The created item or NULL on failure
15724 * This is item is a @ref Separator.
15726 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
15728 * @brief Returns whether @p item is a separator.
15730 * @param item The item to check
15731 * @return If true, @p item is a separator
15733 * @see elm_menu_item_separator_add()
15735 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15737 * @brief Deletes an item from the menu.
15739 * @param item The item to delete.
15741 * @see elm_menu_item_add()
15743 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15745 * @brief Set the function called when a menu item is deleted.
15747 * @param item The item to set the callback on
15748 * @param func The function called
15750 * @see elm_menu_item_add()
15751 * @see elm_menu_item_del()
15753 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15755 * @brief Returns the data associated with menu item @p item.
15757 * @param item The item
15758 * @return The data associated with @p item or NULL if none was set.
15760 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
15762 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15764 * @brief Sets the data to be associated with menu item @p item.
15766 * @param item The item
15767 * @param data The data to be associated with @p item
15769 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
15771 * @brief Returns a list of @p item's subitems.
15773 * @param item The item
15774 * @return An Eina_List* of @p item's subitems
15776 * @see elm_menu_add()
15778 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15779 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15780 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15781 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15782 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15783 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15790 * @defgroup List List
15791 * @ingroup Elementary
15793 * @image html img/widget/list/preview-00.png
15794 * @image latex img/widget/list/preview-00.eps width=\textwidth
15796 * @image html img/list.png
15797 * @image latex img/list.eps width=\textwidth
15799 * A list widget is a container whose children are displayed vertically or
15800 * horizontally, in order, and can be selected.
15801 * The list can accept only one or multiple items selection. Also has many
15802 * modes of items displaying.
15804 * A list is a very simple type of list widget. For more robust
15805 * lists, @ref Genlist should probably be used.
15807 * Smart callbacks one can listen to:
15808 * - @c "activated" - The user has double-clicked or pressed
15809 * (enter|return|spacebar) on an item. The @c event_info parameter
15810 * is the item that was activated.
15811 * - @c "clicked,double" - The user has double-clicked an item.
15812 * The @c event_info parameter is the item that was double-clicked.
15813 * - "selected" - when the user selected an item
15814 * - "unselected" - when the user unselected an item
15815 * - "longpressed" - an item in the list is long-pressed
15816 * - "edge,top" - the list is scrolled until the top edge
15817 * - "edge,bottom" - the list is scrolled until the bottom edge
15818 * - "edge,left" - the list is scrolled until the left edge
15819 * - "edge,right" - the list is scrolled until the right edge
15820 * - "language,changed" - the program's language changed
15822 * Available styles for it:
15825 * List of examples:
15826 * @li @ref list_example_01
15827 * @li @ref list_example_02
15828 * @li @ref list_example_03
15837 * @enum _Elm_List_Mode
15838 * @typedef Elm_List_Mode
15840 * Set list's resize behavior, transverse axis scroll and
15841 * items cropping. See each mode's description for more details.
15843 * @note Default value is #ELM_LIST_SCROLL.
15845 * Values <b> don't </b> work as bitmask, only one can be choosen.
15847 * @see elm_list_mode_set()
15848 * @see elm_list_mode_get()
15852 typedef enum _Elm_List_Mode
15854 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. */
15855 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). */
15856 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. */
15857 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. */
15858 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
15861 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(). */
15864 * Add a new list widget to the given parent Elementary
15865 * (container) object.
15867 * @param parent The parent object.
15868 * @return a new list widget handle or @c NULL, on errors.
15870 * This function inserts a new list widget on the canvas.
15874 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15879 * @param obj The list object
15881 * @note Call before running show() on the list object.
15882 * @warning If not called, it won't display the list properly.
15885 * li = elm_list_add(win);
15886 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
15887 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
15889 * evas_object_show(li);
15894 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
15897 * Enable or disable multiple items selection on the list object.
15899 * @param obj The list object
15900 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
15903 * Disabled by default. If disabled, the user can select a single item of
15904 * the list each time. Selected items are highlighted on list.
15905 * If enabled, many items can be selected.
15907 * If a selected item is selected again, it will be unselected.
15909 * @see elm_list_multi_select_get()
15913 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
15916 * Get a value whether multiple items selection is enabled or not.
15918 * @see elm_list_multi_select_set() for details.
15920 * @param obj The list object.
15921 * @return @c EINA_TRUE means multiple items selection is enabled.
15922 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15923 * @c EINA_FALSE is returned.
15927 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15930 * Set which mode to use for the list object.
15932 * @param obj The list object
15933 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
15934 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
15936 * Set list's resize behavior, transverse axis scroll and
15937 * items cropping. See each mode's description for more details.
15939 * @note Default value is #ELM_LIST_SCROLL.
15941 * Only one can be set, if a previous one was set, it will be changed
15942 * by the new mode set. Bitmask won't work as well.
15944 * @see elm_list_mode_get()
15948 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
15951 * Get the mode the list is at.
15953 * @param obj The list object
15954 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
15955 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
15957 * @note see elm_list_mode_set() for more information.
15961 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15964 * Enable or disable horizontal mode on the list object.
15966 * @param obj The list object.
15967 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
15968 * disable it, i.e., to enable vertical mode.
15970 * @note Vertical mode is set by default.
15972 * On horizontal mode items are displayed on list from left to right,
15973 * instead of from top to bottom. Also, the list will scroll horizontally.
15974 * Each item will presents left icon on top and right icon, or end, at
15977 * @see elm_list_horizontal_get()
15981 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15984 * Get a value whether horizontal mode is enabled or not.
15986 * @param obj The list object.
15987 * @return @c EINA_TRUE means horizontal mode selection is enabled.
15988 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15989 * @c EINA_FALSE is returned.
15991 * @see elm_list_horizontal_set() for details.
15995 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15998 * Enable or disable always select mode on the list object.
16000 * @param obj The list object
16001 * @param always_select @c EINA_TRUE to enable always select mode or
16002 * @c EINA_FALSE to disable it.
16004 * @note Always select mode is disabled by default.
16006 * Default behavior of list items is to only call its callback function
16007 * the first time it's pressed, i.e., when it is selected. If a selected
16008 * item is pressed again, and multi-select is disabled, it won't call
16009 * this function (if multi-select is enabled it will unselect the item).
16011 * If always select is enabled, it will call the callback function
16012 * everytime a item is pressed, so it will call when the item is selected,
16013 * and again when a selected item is pressed.
16015 * @see elm_list_always_select_mode_get()
16016 * @see elm_list_multi_select_set()
16020 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16023 * Get a value whether always select mode is enabled or not, meaning that
16024 * an item will always call its callback function, even if already selected.
16026 * @param obj The list object
16027 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16028 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16029 * @c EINA_FALSE is returned.
16031 * @see elm_list_always_select_mode_set() for details.
16035 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16038 * Set bouncing behaviour when the scrolled content reaches an edge.
16040 * Tell the internal scroller object whether it should bounce or not
16041 * when it reaches the respective edges for each axis.
16043 * @param obj The list object
16044 * @param h_bounce Whether to bounce or not in the horizontal axis.
16045 * @param v_bounce Whether to bounce or not in the vertical axis.
16047 * @see elm_scroller_bounce_set()
16051 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16054 * Get the bouncing behaviour of the internal scroller.
16056 * Get whether the internal scroller should bounce when the edge of each
16057 * axis is reached scrolling.
16059 * @param obj The list object.
16060 * @param h_bounce Pointer where to store the bounce state of the horizontal
16062 * @param v_bounce Pointer where to store the bounce state of the vertical
16065 * @see elm_scroller_bounce_get()
16066 * @see elm_list_bounce_set()
16070 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16073 * Set the scrollbar policy.
16075 * @param obj The list object
16076 * @param policy_h Horizontal scrollbar policy.
16077 * @param policy_v Vertical scrollbar policy.
16079 * This sets the scrollbar visibility policy for the given scroller.
16080 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16081 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16082 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16083 * This applies respectively for the horizontal and vertical scrollbars.
16085 * The both are disabled by default, i.e., are set to
16086 * #ELM_SCROLLER_POLICY_OFF.
16090 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16093 * Get the scrollbar policy.
16095 * @see elm_list_scroller_policy_get() for details.
16097 * @param obj The list object.
16098 * @param policy_h Pointer where to store horizontal scrollbar policy.
16099 * @param policy_v Pointer where to store vertical scrollbar policy.
16103 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);
16106 * Append a new item to the list object.
16108 * @param obj The list object.
16109 * @param label The label of the list item.
16110 * @param icon The icon object to use for the left side of the item. An
16111 * icon can be any Evas object, but usually it is an icon created
16112 * with elm_icon_add().
16113 * @param end The icon object to use for the right side of the item. An
16114 * icon can be any Evas object.
16115 * @param func The function to call when the item is clicked.
16116 * @param data The data to associate with the item for related callbacks.
16118 * @return The created item or @c NULL upon failure.
16120 * A new item will be created and appended to the list, i.e., will
16121 * be set as @b last item.
16123 * Items created with this method can be deleted with
16124 * elm_list_item_del().
16126 * Associated @p data can be properly freed when item is deleted if a
16127 * callback function is set with elm_list_item_del_cb_set().
16129 * If a function is passed as argument, it will be called everytime this item
16130 * is selected, i.e., the user clicks over an unselected item.
16131 * If always select is enabled it will call this function every time
16132 * user clicks over an item (already selected or not).
16133 * If such function isn't needed, just passing
16134 * @c NULL as @p func is enough. The same should be done for @p data.
16136 * Simple example (with no function callback or data associated):
16138 * li = elm_list_add(win);
16139 * ic = elm_icon_add(win);
16140 * elm_icon_file_set(ic, "path/to/image", NULL);
16141 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16142 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16144 * evas_object_show(li);
16147 * @see elm_list_always_select_mode_set()
16148 * @see elm_list_item_del()
16149 * @see elm_list_item_del_cb_set()
16150 * @see elm_list_clear()
16151 * @see elm_icon_add()
16155 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);
16158 * Prepend a new item to the list object.
16160 * @param obj The list object.
16161 * @param label The label of the list item.
16162 * @param icon The icon object to use for the left side of the item. An
16163 * icon can be any Evas object, but usually it is an icon created
16164 * with elm_icon_add().
16165 * @param end The icon object to use for the right side of the item. An
16166 * icon can be any Evas object.
16167 * @param func The function to call when the item is clicked.
16168 * @param data The data to associate with the item for related callbacks.
16170 * @return The created item or @c NULL upon failure.
16172 * A new item will be created and prepended to the list, i.e., will
16173 * be set as @b first item.
16175 * Items created with this method can be deleted with
16176 * elm_list_item_del().
16178 * Associated @p data can be properly freed when item is deleted if a
16179 * callback function is set with elm_list_item_del_cb_set().
16181 * If a function is passed as argument, it will be called everytime this item
16182 * is selected, i.e., the user clicks over an unselected item.
16183 * If always select is enabled it will call this function every time
16184 * user clicks over an item (already selected or not).
16185 * If such function isn't needed, just passing
16186 * @c NULL as @p func is enough. The same should be done for @p data.
16188 * @see elm_list_item_append() for a simple code example.
16189 * @see elm_list_always_select_mode_set()
16190 * @see elm_list_item_del()
16191 * @see elm_list_item_del_cb_set()
16192 * @see elm_list_clear()
16193 * @see elm_icon_add()
16197 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);
16200 * Insert a new item into the list object before item @p before.
16202 * @param obj The list object.
16203 * @param before The list item to insert before.
16204 * @param label The label of the list item.
16205 * @param icon The icon object to use for the left side of the item. An
16206 * icon can be any Evas object, but usually it is an icon created
16207 * with elm_icon_add().
16208 * @param end The icon object to use for the right side of the item. An
16209 * icon can be any Evas object.
16210 * @param func The function to call when the item is clicked.
16211 * @param data The data to associate with the item for related callbacks.
16213 * @return The created item or @c NULL upon failure.
16215 * A new item will be created and added to the list. Its position in
16216 * this list will be just before item @p before.
16218 * Items created with this method can be deleted with
16219 * elm_list_item_del().
16221 * Associated @p data can be properly freed when item is deleted if a
16222 * callback function is set with elm_list_item_del_cb_set().
16224 * If a function is passed as argument, it will be called everytime this item
16225 * is selected, i.e., the user clicks over an unselected item.
16226 * If always select is enabled it will call this function every time
16227 * user clicks over an item (already selected or not).
16228 * If such function isn't needed, just passing
16229 * @c NULL as @p func is enough. The same should be done for @p data.
16231 * @see elm_list_item_append() for a simple code example.
16232 * @see elm_list_always_select_mode_set()
16233 * @see elm_list_item_del()
16234 * @see elm_list_item_del_cb_set()
16235 * @see elm_list_clear()
16236 * @see elm_icon_add()
16240 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);
16243 * Insert a new item into the list object after item @p after.
16245 * @param obj The list object.
16246 * @param after The list item to insert after.
16247 * @param label The label of the list item.
16248 * @param icon The icon object to use for the left side of the item. An
16249 * icon can be any Evas object, but usually it is an icon created
16250 * with elm_icon_add().
16251 * @param end The icon object to use for the right side of the item. An
16252 * icon can be any Evas object.
16253 * @param func The function to call when the item is clicked.
16254 * @param data The data to associate with the item for related callbacks.
16256 * @return The created item or @c NULL upon failure.
16258 * A new item will be created and added to the list. Its position in
16259 * this list will be just after item @p after.
16261 * Items created with this method can be deleted with
16262 * elm_list_item_del().
16264 * Associated @p data can be properly freed when item is deleted if a
16265 * callback function is set with elm_list_item_del_cb_set().
16267 * If a function is passed as argument, it will be called everytime this item
16268 * is selected, i.e., the user clicks over an unselected item.
16269 * If always select is enabled it will call this function every time
16270 * user clicks over an item (already selected or not).
16271 * If such function isn't needed, just passing
16272 * @c NULL as @p func is enough. The same should be done for @p data.
16274 * @see elm_list_item_append() for a simple code example.
16275 * @see elm_list_always_select_mode_set()
16276 * @see elm_list_item_del()
16277 * @see elm_list_item_del_cb_set()
16278 * @see elm_list_clear()
16279 * @see elm_icon_add()
16283 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);
16286 * Insert a new item into the sorted list object.
16288 * @param obj The list object.
16289 * @param label The label of the list item.
16290 * @param icon The icon object to use for the left side of the item. An
16291 * icon can be any Evas object, but usually it is an icon created
16292 * with elm_icon_add().
16293 * @param end The icon object to use for the right side of the item. An
16294 * icon can be any Evas object.
16295 * @param func The function to call when the item is clicked.
16296 * @param data The data to associate with the item for related callbacks.
16297 * @param cmp_func The comparing function to be used to sort list
16298 * items <b>by #Elm_List_Item item handles</b>. This function will
16299 * receive two items and compare them, returning a non-negative integer
16300 * if the second item should be place after the first, or negative value
16301 * if should be placed before.
16303 * @return The created item or @c NULL upon failure.
16305 * @note This function inserts values into a list object assuming it was
16306 * sorted and the result will be sorted.
16308 * A new item will be created and added to the list. Its position in
16309 * this list will be found comparing the new item with previously inserted
16310 * items using function @p cmp_func.
16312 * Items created with this method can be deleted with
16313 * elm_list_item_del().
16315 * Associated @p data can be properly freed when item is deleted if a
16316 * callback function is set with elm_list_item_del_cb_set().
16318 * If a function is passed as argument, it will be called everytime this item
16319 * is selected, i.e., the user clicks over an unselected item.
16320 * If always select is enabled it will call this function every time
16321 * user clicks over an item (already selected or not).
16322 * If such function isn't needed, just passing
16323 * @c NULL as @p func is enough. The same should be done for @p data.
16325 * @see elm_list_item_append() for a simple code example.
16326 * @see elm_list_always_select_mode_set()
16327 * @see elm_list_item_del()
16328 * @see elm_list_item_del_cb_set()
16329 * @see elm_list_clear()
16330 * @see elm_icon_add()
16334 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);
16337 * Remove all list's items.
16339 * @param obj The list object
16341 * @see elm_list_item_del()
16342 * @see elm_list_item_append()
16346 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16349 * Get a list of all the list items.
16351 * @param obj The list object
16352 * @return An @c Eina_List of list items, #Elm_List_Item,
16353 * or @c NULL on failure.
16355 * @see elm_list_item_append()
16356 * @see elm_list_item_del()
16357 * @see elm_list_clear()
16361 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16364 * Get the selected item.
16366 * @param obj The list object.
16367 * @return The selected list item.
16369 * The selected item can be unselected with function
16370 * elm_list_item_selected_set().
16372 * The selected item always will be highlighted on list.
16374 * @see elm_list_selected_items_get()
16378 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16381 * Return a list of the currently selected list items.
16383 * @param obj The list object.
16384 * @return An @c Eina_List of list items, #Elm_List_Item,
16385 * or @c NULL on failure.
16387 * Multiple items can be selected if multi select is enabled. It can be
16388 * done with elm_list_multi_select_set().
16390 * @see elm_list_selected_item_get()
16391 * @see elm_list_multi_select_set()
16395 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16398 * Set the selected state of an item.
16400 * @param item The list item
16401 * @param selected The selected state
16403 * This sets the selected state of the given item @p it.
16404 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16406 * If a new item is selected the previosly selected will be unselected,
16407 * unless multiple selection is enabled with elm_list_multi_select_set().
16408 * Previoulsy selected item can be get with function
16409 * elm_list_selected_item_get().
16411 * Selected items will be highlighted.
16413 * @see elm_list_item_selected_get()
16414 * @see elm_list_selected_item_get()
16415 * @see elm_list_multi_select_set()
16419 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16422 * Get whether the @p item is selected or not.
16424 * @param item The list item.
16425 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16426 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16428 * @see elm_list_selected_item_set() for details.
16429 * @see elm_list_item_selected_get()
16433 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16436 * Set or unset item as a separator.
16438 * @param it The list item.
16439 * @param setting @c EINA_TRUE to set item @p it as separator or
16440 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16442 * Items aren't set as separator by default.
16444 * If set as separator it will display separator theme, so won't display
16447 * @see elm_list_item_separator_get()
16451 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16454 * Get a value whether item is a separator or not.
16456 * @see elm_list_item_separator_set() for details.
16458 * @param it The list item.
16459 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16460 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16464 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16467 * Show @p item in the list view.
16469 * @param item The list item to be shown.
16471 * It won't animate list until item is visible. If such behavior is wanted,
16472 * use elm_list_bring_in() intead.
16476 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16479 * Bring in the given item to list view.
16481 * @param item The item.
16483 * This causes list to jump to the given item @p item and show it
16484 * (by scrolling), if it is not fully visible.
16486 * This may use animation to do so and take a period of time.
16488 * If animation isn't wanted, elm_list_item_show() can be used.
16492 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16495 * Delete them item from the list.
16497 * @param item The item of list to be deleted.
16499 * If deleting all list items is required, elm_list_clear()
16500 * should be used instead of getting items list and deleting each one.
16502 * @see elm_list_clear()
16503 * @see elm_list_item_append()
16504 * @see elm_list_item_del_cb_set()
16508 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16511 * Set the function called when a list item is freed.
16513 * @param item The item to set the callback on
16514 * @param func The function called
16516 * If there is a @p func, then it will be called prior item's memory release.
16517 * That will be called with the following arguments:
16519 * @li item's Evas object;
16522 * This way, a data associated to a list item could be properly freed.
16526 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16529 * Get the data associated to the item.
16531 * @param item The list item
16532 * @return The data associated to @p item
16534 * The return value is a pointer to data associated to @p item when it was
16535 * created, with function elm_list_item_append() or similar. If no data
16536 * was passed as argument, it will return @c NULL.
16538 * @see elm_list_item_append()
16542 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16545 * Get the left side icon associated to the item.
16547 * @param item The list item
16548 * @return The left side icon associated to @p item
16550 * The return value is a pointer to the icon associated to @p item when
16552 * created, with function elm_list_item_append() or similar, or later
16553 * with function elm_list_item_icon_set(). If no icon
16554 * was passed as argument, it will return @c NULL.
16556 * @see elm_list_item_append()
16557 * @see elm_list_item_icon_set()
16561 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16564 * Set the left side icon associated to the item.
16566 * @param item The list item
16567 * @param icon The left side icon object to associate with @p item
16569 * The icon object to use at left side of the item. An
16570 * icon can be any Evas object, but usually it is an icon created
16571 * with elm_icon_add().
16573 * Once the icon object is set, a previously set one will be deleted.
16574 * @warning Setting the same icon for two items will cause the icon to
16575 * dissapear from the first item.
16577 * If an icon was passed as argument on item creation, with function
16578 * elm_list_item_append() or similar, it will be already
16579 * associated to the item.
16581 * @see elm_list_item_append()
16582 * @see elm_list_item_icon_get()
16586 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16589 * Get the right side icon associated to the item.
16591 * @param item The list item
16592 * @return The right side icon associated to @p item
16594 * The return value is a pointer to the icon associated to @p item when
16596 * created, with function elm_list_item_append() or similar, or later
16597 * with function elm_list_item_icon_set(). If no icon
16598 * was passed as argument, it will return @c NULL.
16600 * @see elm_list_item_append()
16601 * @see elm_list_item_icon_set()
16605 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16608 * Set the right side icon associated to the item.
16610 * @param item The list item
16611 * @param end The right side icon object to associate with @p item
16613 * The icon object to use at right side of the item. An
16614 * icon can be any Evas object, but usually it is an icon created
16615 * with elm_icon_add().
16617 * Once the icon object is set, a previously set one will be deleted.
16618 * @warning Setting the same icon for two items will cause the icon to
16619 * dissapear from the first item.
16621 * If an icon was passed as argument on item creation, with function
16622 * elm_list_item_append() or similar, it will be already
16623 * associated to the item.
16625 * @see elm_list_item_append()
16626 * @see elm_list_item_end_get()
16630 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
16631 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16634 * Gets the base object of the item.
16636 * @param item The list item
16637 * @return The base object associated with @p item
16639 * Base object is the @c Evas_Object that represents that item.
16643 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16646 * Get the label of item.
16648 * @param item The item of list.
16649 * @return The label of item.
16651 * The return value is a pointer to the label associated to @p item when
16652 * it was created, with function elm_list_item_append(), or later
16653 * with function elm_list_item_label_set. If no label
16654 * was passed as argument, it will return @c NULL.
16656 * @see elm_list_item_label_set() for more details.
16657 * @see elm_list_item_append()
16661 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16664 * Set the label of item.
16666 * @param item The item of list.
16667 * @param text The label of item.
16669 * The label to be displayed by the item.
16670 * Label will be placed between left and right side icons (if set).
16672 * If a label was passed as argument on item creation, with function
16673 * elm_list_item_append() or similar, it will be already
16674 * displayed by the item.
16676 * @see elm_list_item_label_get()
16677 * @see elm_list_item_append()
16681 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16685 * Get the item before @p it in list.
16687 * @param it The list item.
16688 * @return The item before @p it, or @c NULL if none or on failure.
16690 * @note If it is the first item, @c NULL will be returned.
16692 * @see elm_list_item_append()
16693 * @see elm_list_items_get()
16697 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16700 * Get the item after @p it in list.
16702 * @param it The list item.
16703 * @return The item after @p it, or @c NULL if none or on failure.
16705 * @note If it is the last item, @c NULL will be returned.
16707 * @see elm_list_item_append()
16708 * @see elm_list_items_get()
16712 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16715 * Sets the disabled/enabled state of a list item.
16717 * @param it The item.
16718 * @param disabled The disabled state.
16720 * A disabled item cannot be selected or unselected. It will also
16721 * change its appearance (generally greyed out). This sets the
16722 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
16727 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16730 * Get a value whether list item is disabled or not.
16732 * @param it The item.
16733 * @return The disabled state.
16735 * @see elm_list_item_disabled_set() for more details.
16739 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16742 * Set the text to be shown in a given list item's tooltips.
16744 * @param item Target item.
16745 * @param text The text to set in the content.
16747 * Setup the text as tooltip to object. The item can have only one tooltip,
16748 * so any previous tooltip data - set with this function or
16749 * elm_list_item_tooltip_content_cb_set() - is removed.
16751 * @see elm_object_tooltip_text_set() for more details.
16755 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16759 * @brief Disable size restrictions on an object's tooltip
16760 * @param item The tooltip's anchor object
16761 * @param disable If EINA_TRUE, size restrictions are disabled
16762 * @return EINA_FALSE on failure, EINA_TRUE on success
16764 * This function allows a tooltip to expand beyond its parant window's canvas.
16765 * It will instead be limited only by the size of the display.
16767 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
16769 * @brief Retrieve size restriction state of an object's tooltip
16770 * @param obj The tooltip's anchor object
16771 * @return If EINA_TRUE, size restrictions are disabled
16773 * This function returns whether a tooltip is allowed to expand beyond
16774 * its parant window's canvas.
16775 * It will instead be limited only by the size of the display.
16777 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16780 * Set the content to be shown in the tooltip item.
16782 * Setup the tooltip to item. The item can have only one tooltip,
16783 * so any previous tooltip data is removed. @p func(with @p data) will
16784 * be called every time that need show the tooltip and it should
16785 * return a valid Evas_Object. This object is then managed fully by
16786 * tooltip system and is deleted when the tooltip is gone.
16788 * @param item the list item being attached a tooltip.
16789 * @param func the function used to create the tooltip contents.
16790 * @param data what to provide to @a func as callback data/context.
16791 * @param del_cb called when data is not needed anymore, either when
16792 * another callback replaces @a func, the tooltip is unset with
16793 * elm_list_item_tooltip_unset() or the owner @a item
16794 * dies. This callback receives as the first parameter the
16795 * given @a data, and @c event_info is the item.
16797 * @see elm_object_tooltip_content_cb_set() for more details.
16801 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);
16804 * Unset tooltip from item.
16806 * @param item list item to remove previously set tooltip.
16808 * Remove tooltip from item. The callback provided as del_cb to
16809 * elm_list_item_tooltip_content_cb_set() will be called to notify
16810 * it is not used anymore.
16812 * @see elm_object_tooltip_unset() for more details.
16813 * @see elm_list_item_tooltip_content_cb_set()
16817 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16820 * Sets a different style for this item tooltip.
16822 * @note before you set a style you should define a tooltip with
16823 * elm_list_item_tooltip_content_cb_set() or
16824 * elm_list_item_tooltip_text_set()
16826 * @param item list item with tooltip already set.
16827 * @param style the theme style to use (default, transparent, ...)
16829 * @see elm_object_tooltip_style_set() for more details.
16833 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
16836 * Get the style for this item tooltip.
16838 * @param item list item with tooltip already set.
16839 * @return style the theme style in use, defaults to "default". If the
16840 * object does not have a tooltip set, then NULL is returned.
16842 * @see elm_object_tooltip_style_get() for more details.
16843 * @see elm_list_item_tooltip_style_set()
16847 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16850 * Set the type of mouse pointer/cursor decoration to be shown,
16851 * when the mouse pointer is over the given list widget item
16853 * @param item list item to customize cursor on
16854 * @param cursor the cursor type's name
16856 * This function works analogously as elm_object_cursor_set(), but
16857 * here the cursor's changing area is restricted to the item's
16858 * area, and not the whole widget's. Note that that item cursors
16859 * have precedence over widget cursors, so that a mouse over an
16860 * item with custom cursor set will always show @b that cursor.
16862 * If this function is called twice for an object, a previously set
16863 * cursor will be unset on the second call.
16865 * @see elm_object_cursor_set()
16866 * @see elm_list_item_cursor_get()
16867 * @see elm_list_item_cursor_unset()
16871 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
16874 * Get the type of mouse pointer/cursor decoration set to be shown,
16875 * when the mouse pointer is over the given list widget item
16877 * @param item list item with custom cursor set
16878 * @return the cursor type's name or @c NULL, if no custom cursors
16879 * were set to @p item (and on errors)
16881 * @see elm_object_cursor_get()
16882 * @see elm_list_item_cursor_set()
16883 * @see elm_list_item_cursor_unset()
16887 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16890 * Unset any custom mouse pointer/cursor decoration set to be
16891 * shown, when the mouse pointer is over the given list widget
16892 * item, thus making it show the @b default cursor again.
16894 * @param item a list item
16896 * Use this call to undo any custom settings on this item's cursor
16897 * decoration, bringing it back to defaults (no custom style set).
16899 * @see elm_object_cursor_unset()
16900 * @see elm_list_item_cursor_set()
16904 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16907 * Set a different @b style for a given custom cursor set for a
16910 * @param item list item with custom cursor set
16911 * @param style the <b>theme style</b> to use (e.g. @c "default",
16912 * @c "transparent", etc)
16914 * This function only makes sense when one is using custom mouse
16915 * cursor decorations <b>defined in a theme file</b>, which can have,
16916 * given a cursor name/type, <b>alternate styles</b> on it. It
16917 * works analogously as elm_object_cursor_style_set(), but here
16918 * applyed only to list item objects.
16920 * @warning Before you set a cursor style you should have definen a
16921 * custom cursor previously on the item, with
16922 * elm_list_item_cursor_set()
16924 * @see elm_list_item_cursor_engine_only_set()
16925 * @see elm_list_item_cursor_style_get()
16929 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
16932 * Get the current @b style set for a given list item's custom
16935 * @param item list item with custom cursor set.
16936 * @return style the cursor style in use. If the object does not
16937 * have a cursor set, then @c NULL is returned.
16939 * @see elm_list_item_cursor_style_set() for more details
16943 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16946 * Set if the (custom)cursor for a given list item should be
16947 * searched in its theme, also, or should only rely on the
16948 * rendering engine.
16950 * @param item item with custom (custom) cursor already set on
16951 * @param engine_only Use @c EINA_TRUE to have cursors looked for
16952 * only on those provided by the rendering engine, @c EINA_FALSE to
16953 * have them searched on the widget's theme, as well.
16955 * @note This call is of use only if you've set a custom cursor
16956 * for list items, with elm_list_item_cursor_set().
16958 * @note By default, cursors will only be looked for between those
16959 * provided by the rendering engine.
16963 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
16966 * Get if the (custom) cursor for a given list item is being
16967 * searched in its theme, also, or is only relying on the rendering
16970 * @param item a list item
16971 * @return @c EINA_TRUE, if cursors are being looked for only on
16972 * those provided by the rendering engine, @c EINA_FALSE if they
16973 * are being searched on the widget's theme, as well.
16975 * @see elm_list_item_cursor_engine_only_set(), for more details
16979 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16986 * @defgroup Slider Slider
16987 * @ingroup Elementary
16989 * @image html img/widget/slider/preview-00.png
16990 * @image latex img/widget/slider/preview-00.eps width=\textwidth
16992 * The slider adds a dragable “slider” widget for selecting the value of
16993 * something within a range.
16995 * A slider can be horizontal or vertical. It can contain an Icon and has a
16996 * primary label as well as a units label (that is formatted with floating
16997 * point values and thus accepts a printf-style format string, like
16998 * “%1.2f units”. There is also an indicator string that may be somewhere
16999 * else (like on the slider itself) that also accepts a format string like
17000 * units. Label, Icon Unit and Indicator strings/objects are optional.
17002 * A slider may be inverted which means values invert, with high vales being
17003 * on the left or top and low values on the right or bottom (as opposed to
17004 * normally being low on the left or top and high on the bottom and right).
17006 * The slider should have its minimum and maximum values set by the
17007 * application with elm_slider_min_max_set() and value should also be set by
17008 * the application before use with elm_slider_value_set(). The span of the
17009 * slider is its length (horizontally or vertically). This will be scaled by
17010 * the object or applications scaling factor. At any point code can query the
17011 * slider for its value with elm_slider_value_get().
17013 * Smart callbacks one can listen to:
17014 * - "changed" - Whenever the slider value is changed by the user.
17015 * - "slider,drag,start" - dragging the slider indicator around has started.
17016 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17017 * - "delay,changed" - A short time after the value is changed by the user.
17018 * This will be called only when the user stops dragging for
17019 * a very short period or when they release their
17020 * finger/mouse, so it avoids possibly expensive reactions to
17021 * the value change.
17023 * Available styles for it:
17026 * Default contents parts of the slider widget that you can use for are:
17027 * @li "elm.swallow.icon" - A icon of the slider
17028 * @li "elm.swallow.end" - A end part content of the slider
17030 * Here is an example on its usage:
17031 * @li @ref slider_example
17034 #define ELM_SLIDER_CONTENT_ICON "elm.swallow.icon"
17035 #define ELM_SLIDER_CONTENT_END "elm.swallow.end"
17038 * @addtogroup Slider
17043 * Add a new slider widget to the given parent Elementary
17044 * (container) object.
17046 * @param parent The parent object.
17047 * @return a new slider widget handle or @c NULL, on errors.
17049 * This function inserts a new slider widget on the canvas.
17053 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17056 * Set the label of a given slider widget
17058 * @param obj The progress bar object
17059 * @param label The text label string, in UTF-8
17062 * @deprecated use elm_object_text_set() instead.
17064 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17067 * Get the label of a given slider widget
17069 * @param obj The progressbar object
17070 * @return The text label string, in UTF-8
17073 * @deprecated use elm_object_text_get() instead.
17075 EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17078 * Set the icon object of the slider object.
17080 * @param obj The slider object.
17081 * @param icon The icon object.
17083 * On horizontal mode, icon is placed at left, and on vertical mode,
17086 * @note Once the icon object is set, a previously set one will be deleted.
17087 * If you want to keep that old content object, use the
17088 * elm_slider_icon_unset() function.
17090 * @warning If the object being set does not have minimum size hints set,
17091 * it won't get properly displayed.
17094 * @deprecated use elm_object_content_set() instead.
17096 EINA_DEPRECATED EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17099 * Unset an icon set on a given slider widget.
17101 * @param obj The slider object.
17102 * @return The icon object that was being used, if any was set, or
17103 * @c NULL, otherwise (and on errors).
17105 * On horizontal mode, icon is placed at left, and on vertical mode,
17108 * This call will unparent and return the icon object which was set
17109 * for this widget, previously, on success.
17111 * @see elm_slider_icon_set() for more details
17112 * @see elm_slider_icon_get()
17113 * @deprecated use elm_object_content_unset() instead.
17117 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17120 * Retrieve the icon object set for a given slider widget.
17122 * @param obj The slider object.
17123 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17124 * otherwise (and on errors).
17126 * On horizontal mode, icon is placed at left, and on vertical mode,
17129 * @see elm_slider_icon_set() for more details
17130 * @see elm_slider_icon_unset()
17134 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17137 * Set the end object of the slider object.
17139 * @param obj The slider object.
17140 * @param end The end object.
17142 * On horizontal mode, end is placed at left, and on vertical mode,
17143 * placed at bottom.
17145 * @note Once the icon object is set, a previously set one will be deleted.
17146 * If you want to keep that old content object, use the
17147 * elm_slider_end_unset() function.
17149 * @warning If the object being set does not have minimum size hints set,
17150 * it won't get properly displayed.
17154 EINA_DEPRECATED EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17157 * Unset an end object set on a given slider widget.
17159 * @param obj The slider object.
17160 * @return The end object that was being used, if any was set, or
17161 * @c NULL, otherwise (and on errors).
17163 * On horizontal mode, end is placed at left, and on vertical mode,
17164 * placed at bottom.
17166 * This call will unparent and return the icon object which was set
17167 * for this widget, previously, on success.
17169 * @see elm_slider_end_set() for more details.
17170 * @see elm_slider_end_get()
17174 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17177 * Retrieve the end object set for a given slider widget.
17179 * @param obj The slider object.
17180 * @return The end object's handle, if @p obj had one set, or @c NULL,
17181 * otherwise (and on errors).
17183 * On horizontal mode, icon is placed at right, and on vertical mode,
17184 * placed at bottom.
17186 * @see elm_slider_end_set() for more details.
17187 * @see elm_slider_end_unset()
17191 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17194 * Set the (exact) length of the bar region of a given slider widget.
17196 * @param obj The slider object.
17197 * @param size The length of the slider's bar region.
17199 * This sets the minimum width (when in horizontal mode) or height
17200 * (when in vertical mode) of the actual bar area of the slider
17201 * @p obj. This in turn affects the object's minimum size. Use
17202 * this when you're not setting other size hints expanding on the
17203 * given direction (like weight and alignment hints) and you would
17204 * like it to have a specific size.
17206 * @note Icon, end, label, indicator and unit text around @p obj
17207 * will require their
17208 * own space, which will make @p obj to require more the @p size,
17211 * @see elm_slider_span_size_get()
17215 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17218 * Get the length set for the bar region of a given slider widget
17220 * @param obj The slider object.
17221 * @return The length of the slider's bar region.
17223 * If that size was not set previously, with
17224 * elm_slider_span_size_set(), this call will return @c 0.
17228 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17231 * Set the format string for the unit label.
17233 * @param obj The slider object.
17234 * @param format The format string for the unit display.
17236 * Unit label is displayed all the time, if set, after slider's bar.
17237 * In horizontal mode, at right and in vertical mode, at bottom.
17239 * If @c NULL, unit label won't be visible. If not it sets the format
17240 * string for the label text. To the label text is provided a floating point
17241 * value, so the label text can display up to 1 floating point value.
17242 * Note that this is optional.
17244 * Use a format string such as "%1.2f meters" for example, and it will
17245 * display values like: "3.14 meters" for a value equal to 3.14159.
17247 * Default is unit label disabled.
17249 * @see elm_slider_indicator_format_get()
17253 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17256 * Get the unit label format of the slider.
17258 * @param obj The slider object.
17259 * @return The unit label format string in UTF-8.
17261 * Unit label is displayed all the time, if set, after slider's bar.
17262 * In horizontal mode, at right and in vertical mode, at bottom.
17264 * @see elm_slider_unit_format_set() for more
17265 * information on how this works.
17269 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17272 * Set the format string for the indicator label.
17274 * @param obj The slider object.
17275 * @param indicator The format string for the indicator display.
17277 * The slider may display its value somewhere else then unit label,
17278 * for example, above the slider knob that is dragged around. This function
17279 * sets the format string used for this.
17281 * If @c NULL, indicator label won't be visible. If not it sets the format
17282 * string for the label text. To the label text is provided a floating point
17283 * value, so the label text can display up to 1 floating point value.
17284 * Note that this is optional.
17286 * Use a format string such as "%1.2f meters" for example, and it will
17287 * display values like: "3.14 meters" for a value equal to 3.14159.
17289 * Default is indicator label disabled.
17291 * @see elm_slider_indicator_format_get()
17295 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17298 * Get the indicator label format of the slider.
17300 * @param obj The slider object.
17301 * @return The indicator label format string in UTF-8.
17303 * The slider may display its value somewhere else then unit label,
17304 * for example, above the slider knob that is dragged around. This function
17305 * gets the format string used for this.
17307 * @see elm_slider_indicator_format_set() for more
17308 * information on how this works.
17312 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17315 * Set the format function pointer for the indicator label
17317 * @param obj The slider object.
17318 * @param func The indicator format function.
17319 * @param free_func The freeing function for the format string.
17321 * Set the callback function to format the indicator string.
17323 * @see elm_slider_indicator_format_set() for more info on how this works.
17327 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);
17330 * Set the format function pointer for the units label
17332 * @param obj The slider object.
17333 * @param func The units format function.
17334 * @param free_func The freeing function for the format string.
17336 * Set the callback function to format the indicator string.
17338 * @see elm_slider_units_format_set() for more info on how this works.
17342 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);
17345 * Set the orientation of a given slider widget.
17347 * @param obj The slider object.
17348 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17349 * @b horizontal, @c EINA_FALSE to make it @b vertical.
17351 * Use this function to change how your slider is to be
17352 * disposed: vertically or horizontally.
17354 * By default it's displayed horizontally.
17356 * @see elm_slider_horizontal_get()
17360 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17363 * Retrieve the orientation of a given slider widget
17365 * @param obj The slider object.
17366 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17367 * @c EINA_FALSE if it's @b vertical (and on errors).
17369 * @see elm_slider_horizontal_set() for more details.
17373 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17376 * Set the minimum and maximum values for the slider.
17378 * @param obj The slider object.
17379 * @param min The minimum value.
17380 * @param max The maximum value.
17382 * Define the allowed range of values to be selected by the user.
17384 * If actual value is less than @p min, it will be updated to @p min. If it
17385 * is bigger then @p max, will be updated to @p max. Actual value can be
17386 * get with elm_slider_value_get().
17388 * By default, min is equal to 0.0, and max is equal to 1.0.
17390 * @warning Maximum must be greater than minimum, otherwise behavior
17393 * @see elm_slider_min_max_get()
17397 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17400 * Get the minimum and maximum values of the slider.
17402 * @param obj The slider object.
17403 * @param min Pointer where to store the minimum value.
17404 * @param max Pointer where to store the maximum value.
17406 * @note If only one value is needed, the other pointer can be passed
17409 * @see elm_slider_min_max_set() for details.
17413 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17416 * Set the value the slider displays.
17418 * @param obj The slider object.
17419 * @param val The value to be displayed.
17421 * Value will be presented on the unit label following format specified with
17422 * elm_slider_unit_format_set() and on indicator with
17423 * elm_slider_indicator_format_set().
17425 * @warning The value must to be between min and max values. This values
17426 * are set by elm_slider_min_max_set().
17428 * @see elm_slider_value_get()
17429 * @see elm_slider_unit_format_set()
17430 * @see elm_slider_indicator_format_set()
17431 * @see elm_slider_min_max_set()
17435 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17438 * Get the value displayed by the spinner.
17440 * @param obj The spinner object.
17441 * @return The value displayed.
17443 * @see elm_spinner_value_set() for details.
17447 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17450 * Invert a given slider widget's displaying values order
17452 * @param obj The slider object.
17453 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17454 * @c EINA_FALSE to bring it back to default, non-inverted values.
17456 * A slider may be @b inverted, in which state it gets its
17457 * values inverted, with high vales being on the left or top and
17458 * low values on the right or bottom, as opposed to normally have
17459 * the low values on the former and high values on the latter,
17460 * respectively, for horizontal and vertical modes.
17462 * @see elm_slider_inverted_get()
17466 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17469 * Get whether a given slider widget's displaying values are
17472 * @param obj The slider object.
17473 * @return @c EINA_TRUE, if @p obj has inverted values,
17474 * @c EINA_FALSE otherwise (and on errors).
17476 * @see elm_slider_inverted_set() for more details.
17480 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17483 * Set whether to enlarge slider indicator (augmented knob) or not.
17485 * @param obj The slider object.
17486 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17487 * let the knob always at default size.
17489 * By default, indicator will be bigger while dragged by the user.
17491 * @warning It won't display values set with
17492 * elm_slider_indicator_format_set() if you disable indicator.
17496 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17499 * Get whether a given slider widget's enlarging indicator or not.
17501 * @param obj The slider object.
17502 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17503 * @c EINA_FALSE otherwise (and on errors).
17505 * @see elm_slider_indicator_show_set() for details.
17509 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17516 * @addtogroup Actionslider Actionslider
17518 * @image html img/widget/actionslider/preview-00.png
17519 * @image latex img/widget/actionslider/preview-00.eps
17521 * An actionslider is a switcher for 2 or 3 labels with customizable magnet
17522 * properties. The user drags and releases the indicator, to choose a label.
17524 * Labels occupy the following positions.
17529 * Positions can be enabled or disabled.
17531 * Magnets can be set on the above positions.
17533 * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
17535 * @note By default all positions are set as enabled.
17537 * Signals that you can add callbacks for are:
17539 * "selected" - when user selects an enabled position (the label is passed
17542 * "pos_changed" - when the indicator reaches any of the positions("left",
17543 * "right" or "center").
17545 * See an example of actionslider usage @ref actionslider_example_page "here"
17549 typedef enum _Elm_Actionslider_Indicator_Pos
17551 ELM_ACTIONSLIDER_INDICATOR_NONE,
17552 ELM_ACTIONSLIDER_INDICATOR_LEFT,
17553 ELM_ACTIONSLIDER_INDICATOR_RIGHT,
17554 ELM_ACTIONSLIDER_INDICATOR_CENTER
17555 } Elm_Actionslider_Indicator_Pos;
17557 typedef enum _Elm_Actionslider_Magnet_Pos
17559 ELM_ACTIONSLIDER_MAGNET_NONE = 0,
17560 ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
17561 ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
17562 ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
17563 ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
17564 ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
17565 } Elm_Actionslider_Magnet_Pos;
17567 typedef enum _Elm_Actionslider_Label_Pos
17569 ELM_ACTIONSLIDER_LABEL_LEFT,
17570 ELM_ACTIONSLIDER_LABEL_RIGHT,
17571 ELM_ACTIONSLIDER_LABEL_CENTER,
17572 ELM_ACTIONSLIDER_LABEL_BUTTON
17573 } Elm_Actionslider_Label_Pos;
17575 /* smart callbacks called:
17576 * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
17580 * Add a new actionslider to the parent.
17582 * @param parent The parent object
17583 * @return The new actionslider object or NULL if it cannot be created
17585 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17588 * Set actionslider label.
17590 * @param[in] obj The actionslider object
17591 * @param[in] pos The position of the label.
17592 * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
17593 * @param label The label which is going to be set.
17595 EAPI void elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
17597 * Get actionslider labels.
17599 * @param obj The actionslider object
17600 * @param left_label A char** to place the left_label of @p obj into.
17601 * @param center_label A char** to place the center_label of @p obj into.
17602 * @param right_label A char** to place the right_label of @p obj into.
17604 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);
17606 * Get actionslider selected label.
17608 * @param obj The actionslider object
17609 * @return The selected label
17611 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17613 * Set actionslider indicator position.
17615 * @param obj The actionslider object.
17616 * @param pos The position of the indicator.
17618 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
17620 * Get actionslider indicator position.
17622 * @param obj The actionslider object.
17623 * @return The position of the indicator.
17625 EAPI Elm_Actionslider_Indicator_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17627 * Set actionslider magnet position. To make multiple positions magnets @c or
17628 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
17630 * @param obj The actionslider object.
17631 * @param pos Bit mask indicating the magnet positions.
17633 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
17635 * Get actionslider magnet position.
17637 * @param obj The actionslider object.
17638 * @return The positions with magnet property.
17640 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17642 * Set actionslider enabled position. To set multiple positions as enabled @c or
17643 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
17645 * @note All the positions are enabled by default.
17647 * @param obj The actionslider object.
17648 * @param pos Bit mask indicating the enabled positions.
17650 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
17652 * Get actionslider enabled position.
17654 * @param obj The actionslider object.
17655 * @return The enabled positions.
17657 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17659 * Set the label used on the indicator.
17661 * @param obj The actionslider object
17662 * @param label The label to be set on the indicator.
17663 * @deprecated use elm_object_text_set() instead.
17665 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17667 * Get the label used on the indicator object.
17669 * @param obj The actionslider object
17670 * @return The indicator label
17671 * @deprecated use elm_object_text_get() instead.
17673 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
17676 * Hold actionslider object movement.
17678 * @param[in] obj The actionslider object
17679 * @param[in] flag Actionslider hold/release
17680 * (EINA_TURE = hold/EIN_FALSE = release)
17682 * @ingroup Actionslider
17684 EAPI void elm_actionslider_hold(Evas_Object *obj, Eina_Bool flag) EINA_ARG_NONNULL(1);
17692 * @defgroup Genlist Genlist
17694 * @image html img/widget/genlist/preview-00.png
17695 * @image latex img/widget/genlist/preview-00.eps
17696 * @image html img/genlist.png
17697 * @image latex img/genlist.eps
17699 * This widget aims to have more expansive list than the simple list in
17700 * Elementary that could have more flexible items and allow many more entries
17701 * while still being fast and low on memory usage. At the same time it was
17702 * also made to be able to do tree structures. But the price to pay is more
17703 * complexity when it comes to usage. If all you want is a simple list with
17704 * icons and a single label, use the normal @ref List object.
17706 * Genlist has a fairly large API, mostly because it's relatively complex,
17707 * trying to be both expansive, powerful and efficient. First we will begin
17708 * an overview on the theory behind genlist.
17710 * @section Genlist_Item_Class Genlist item classes - creating items
17712 * In order to have the ability to add and delete items on the fly, genlist
17713 * implements a class (callback) system where the application provides a
17714 * structure with information about that type of item (genlist may contain
17715 * multiple different items with different classes, states and styles).
17716 * Genlist will call the functions in this struct (methods) when an item is
17717 * "realized" (i.e., created dynamically, while the user is scrolling the
17718 * grid). All objects will simply be deleted when no longer needed with
17719 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
17720 * following members:
17721 * - @c item_style - This is a constant string and simply defines the name
17722 * of the item style. It @b must be specified and the default should be @c
17725 * - @c func - A struct with pointers to functions that will be called when
17726 * an item is going to be actually created. All of them receive a @c data
17727 * parameter that will point to the same data passed to
17728 * elm_genlist_item_append() and related item creation functions, and a @c
17729 * obj parameter that points to the genlist object itself.
17731 * The function pointers inside @c func are @c label_get, @c icon_get, @c
17732 * state_get and @c del. The 3 first functions also receive a @c part
17733 * parameter described below. A brief description of these functions follows:
17735 * - @c label_get - The @c part parameter is the name string of one of the
17736 * existing text parts in the Edje group implementing the item's theme.
17737 * This function @b must return a strdup'()ed string, as the caller will
17738 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
17739 * - @c content_get - The @c part parameter is the name string of one of the
17740 * existing (content) swallow parts in the Edje group implementing the item's
17741 * theme. It must return @c NULL, when no content is desired, or a valid
17742 * object handle, otherwise. The object will be deleted by the genlist on
17743 * its deletion or when the item is "unrealized". See
17744 * #Elm_Genlist_Item_Icon_Get_Cb.
17745 * - @c func.state_get - The @c part parameter is the name string of one of
17746 * the state parts in the Edje group implementing the item's theme. Return
17747 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
17748 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
17749 * and @c "elm" as "emission" and "source" arguments, respectively, when
17750 * the state is true (the default is false), where @c XXX is the name of
17751 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
17752 * - @c func.del - This is intended for use when genlist items are deleted,
17753 * so any data attached to the item (e.g. its data parameter on creation)
17754 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
17756 * available item styles:
17758 * - default_style - The text part is a textblock
17760 * @image html img/widget/genlist/preview-04.png
17761 * @image latex img/widget/genlist/preview-04.eps
17765 * @image html img/widget/genlist/preview-01.png
17766 * @image latex img/widget/genlist/preview-01.eps
17768 * - icon_top_text_bottom
17770 * @image html img/widget/genlist/preview-02.png
17771 * @image latex img/widget/genlist/preview-02.eps
17775 * @image html img/widget/genlist/preview-03.png
17776 * @image latex img/widget/genlist/preview-03.eps
17778 * @section Genlist_Items Structure of items
17780 * An item in a genlist can have 0 or more text labels (they can be regular
17781 * text or textblock Evas objects - that's up to the style to determine), 0
17782 * or more contents (which are simply objects swallowed into the genlist item's
17783 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
17784 * behavior left to the user to define. The Edje part names for each of
17785 * these properties will be looked up, in the theme file for the genlist,
17786 * under the Edje (string) data items named @c "labels", @c "contents" and @c
17787 * "states", respectively. For each of those properties, if more than one
17788 * part is provided, they must have names listed separated by spaces in the
17789 * data fields. For the default genlist item theme, we have @b one label
17790 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
17791 * "elm.swallow.end") and @b no state parts.
17793 * A genlist item may be at one of several styles. Elementary provides one
17794 * by default - "default", but this can be extended by system or application
17795 * custom themes/overlays/extensions (see @ref Theme "themes" for more
17798 * @section Genlist_Manipulation Editing and Navigating
17800 * Items can be added by several calls. All of them return a @ref
17801 * Elm_Genlist_Item handle that is an internal member inside the genlist.
17802 * They all take a data parameter that is meant to be used for a handle to
17803 * the applications internal data (eg the struct with the original item
17804 * data). The parent parameter is the parent genlist item this belongs to if
17805 * it is a tree or an indexed group, and NULL if there is no parent. The
17806 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
17807 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
17808 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
17809 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
17810 * is set then this item is group index item that is displayed at the top
17811 * until the next group comes. The func parameter is a convenience callback
17812 * that is called when the item is selected and the data parameter will be
17813 * the func_data parameter, obj be the genlist object and event_info will be
17814 * the genlist item.
17816 * elm_genlist_item_append() adds an item to the end of the list, or if
17817 * there is a parent, to the end of all the child items of the parent.
17818 * elm_genlist_item_prepend() is the same but adds to the beginning of
17819 * the list or children list. elm_genlist_item_insert_before() inserts at
17820 * item before another item and elm_genlist_item_insert_after() inserts after
17821 * the indicated item.
17823 * The application can clear the list with elm_genlist_clear() which deletes
17824 * all the items in the list and elm_genlist_item_del() will delete a specific
17825 * item. elm_genlist_item_subitems_clear() will clear all items that are
17826 * children of the indicated parent item.
17828 * To help inspect list items you can jump to the item at the top of the list
17829 * with elm_genlist_first_item_get() which will return the item pointer, and
17830 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
17831 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
17832 * and previous items respectively relative to the indicated item. Using
17833 * these calls you can walk the entire item list/tree. Note that as a tree
17834 * the items are flattened in the list, so elm_genlist_item_parent_get() will
17835 * let you know which item is the parent (and thus know how to skip them if
17838 * @section Genlist_Muti_Selection Multi-selection
17840 * If the application wants multiple items to be able to be selected,
17841 * elm_genlist_multi_select_set() can enable this. If the list is
17842 * single-selection only (the default), then elm_genlist_selected_item_get()
17843 * will return the selected item, if any, or NULL I none is selected. If the
17844 * list is multi-select then elm_genlist_selected_items_get() will return a
17845 * list (that is only valid as long as no items are modified (added, deleted,
17846 * selected or unselected)).
17848 * @section Genlist_Usage_Hints Usage hints
17850 * There are also convenience functions. elm_genlist_item_genlist_get() will
17851 * return the genlist object the item belongs to. elm_genlist_item_show()
17852 * will make the scroller scroll to show that specific item so its visible.
17853 * elm_genlist_item_data_get() returns the data pointer set by the item
17854 * creation functions.
17856 * If an item changes (state of boolean changes, label or contents change),
17857 * then use elm_genlist_item_update() to have genlist update the item with
17858 * the new state. Genlist will re-realize the item thus call the functions
17859 * in the _Elm_Genlist_Item_Class for that item.
17861 * To programmatically (un)select an item use elm_genlist_item_selected_set().
17862 * To get its selected state use elm_genlist_item_selected_get(). Similarly
17863 * to expand/contract an item and get its expanded state, use
17864 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
17865 * again to make an item disabled (unable to be selected and appear
17866 * differently) use elm_genlist_item_disabled_set() to set this and
17867 * elm_genlist_item_disabled_get() to get the disabled state.
17869 * In general to indicate how the genlist should expand items horizontally to
17870 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
17871 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
17872 * mode means that if items are too wide to fit, the scroller will scroll
17873 * horizontally. Otherwise items are expanded to fill the width of the
17874 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
17875 * to the viewport width and limited to that size. This can be combined with
17876 * a different style that uses edjes' ellipsis feature (cutting text off like
17879 * Items will only call their selection func and callback when first becoming
17880 * selected. Any further clicks will do nothing, unless you enable always
17881 * select with elm_genlist_always_select_mode_set(). This means even if
17882 * selected, every click will make the selected callbacks be called.
17883 * elm_genlist_no_select_mode_set() will turn off the ability to select
17884 * items entirely and they will neither appear selected nor call selected
17885 * callback functions.
17887 * Remember that you can create new styles and add your own theme augmentation
17888 * per application with elm_theme_extension_add(). If you absolutely must
17889 * have a specific style that overrides any theme the user or system sets up
17890 * you can use elm_theme_overlay_add() to add such a file.
17892 * @section Genlist_Implementation Implementation
17894 * Evas tracks every object you create. Every time it processes an event
17895 * (mouse move, down, up etc.) it needs to walk through objects and find out
17896 * what event that affects. Even worse every time it renders display updates,
17897 * in order to just calculate what to re-draw, it needs to walk through many
17898 * many many objects. Thus, the more objects you keep active, the more
17899 * overhead Evas has in just doing its work. It is advisable to keep your
17900 * active objects to the minimum working set you need. Also remember that
17901 * object creation and deletion carries an overhead, so there is a
17902 * middle-ground, which is not easily determined. But don't keep massive lists
17903 * of objects you can't see or use. Genlist does this with list objects. It
17904 * creates and destroys them dynamically as you scroll around. It groups them
17905 * into blocks so it can determine the visibility etc. of a whole block at
17906 * once as opposed to having to walk the whole list. This 2-level list allows
17907 * for very large numbers of items to be in the list (tests have used up to
17908 * 2,000,000 items). Also genlist employs a queue for adding items. As items
17909 * may be different sizes, every item added needs to be calculated as to its
17910 * size and thus this presents a lot of overhead on populating the list, this
17911 * genlist employs a queue. Any item added is queued and spooled off over
17912 * time, actually appearing some time later, so if your list has many members
17913 * you may find it takes a while for them to all appear, with your process
17914 * consuming a lot of CPU while it is busy spooling.
17916 * Genlist also implements a tree structure, but it does so with callbacks to
17917 * the application, with the application filling in tree structures when
17918 * requested (allowing for efficient building of a very deep tree that could
17919 * even be used for file-management). See the above smart signal callbacks for
17922 * @section Genlist_Smart_Events Genlist smart events
17924 * Signals that you can add callbacks for are:
17925 * - @c "activated" - The user has double-clicked or pressed
17926 * (enter|return|spacebar) on an item. The @c event_info parameter is the
17927 * item that was activated.
17928 * - @c "clicked,double" - The user has double-clicked an item. The @c
17929 * event_info parameter is the item that was double-clicked.
17930 * - @c "selected" - This is called when a user has made an item selected.
17931 * The event_info parameter is the genlist item that was selected.
17932 * - @c "unselected" - This is called when a user has made an item
17933 * unselected. The event_info parameter is the genlist item that was
17935 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
17936 * called and the item is now meant to be expanded. The event_info
17937 * parameter is the genlist item that was indicated to expand. It is the
17938 * job of this callback to then fill in the child items.
17939 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
17940 * called and the item is now meant to be contracted. The event_info
17941 * parameter is the genlist item that was indicated to contract. It is the
17942 * job of this callback to then delete the child items.
17943 * - @c "expand,request" - This is called when a user has indicated they want
17944 * to expand a tree branch item. The callback should decide if the item can
17945 * expand (has any children) and then call elm_genlist_item_expanded_set()
17946 * appropriately to set the state. The event_info parameter is the genlist
17947 * item that was indicated to expand.
17948 * - @c "contract,request" - This is called when a user has indicated they
17949 * want to contract a tree branch item. The callback should decide if the
17950 * item can contract (has any children) and then call
17951 * elm_genlist_item_expanded_set() appropriately to set the state. The
17952 * event_info parameter is the genlist item that was indicated to contract.
17953 * - @c "realized" - This is called when the item in the list is created as a
17954 * real evas object. event_info parameter is the genlist item that was
17955 * created. The object may be deleted at any time, so it is up to the
17956 * caller to not use the object pointer from elm_genlist_item_object_get()
17957 * in a way where it may point to freed objects.
17958 * - @c "unrealized" - This is called just before an item is unrealized.
17959 * After this call content objects provided will be deleted and the item
17960 * object itself delete or be put into a floating cache.
17961 * - @c "drag,start,up" - This is called when the item in the list has been
17962 * dragged (not scrolled) up.
17963 * - @c "drag,start,down" - This is called when the item in the list has been
17964 * dragged (not scrolled) down.
17965 * - @c "drag,start,left" - This is called when the item in the list has been
17966 * dragged (not scrolled) left.
17967 * - @c "drag,start,right" - This is called when the item in the list has
17968 * been dragged (not scrolled) right.
17969 * - @c "drag,stop" - This is called when the item in the list has stopped
17971 * - @c "drag" - This is called when the item in the list is being dragged.
17972 * - @c "longpressed" - This is called when the item is pressed for a certain
17973 * amount of time. By default it's 1 second.
17974 * - @c "scroll,anim,start" - This is called when scrolling animation has
17976 * - @c "scroll,anim,stop" - This is called when scrolling animation has
17978 * - @c "scroll,drag,start" - This is called when dragging the content has
17980 * - @c "scroll,drag,stop" - This is called when dragging the content has
17982 * - @c "edge,top" - This is called when the genlist is scrolled until
17984 * - @c "edge,bottom" - This is called when the genlist is scrolled
17985 * until the bottom edge.
17986 * - @c "edge,left" - This is called when the genlist is scrolled
17987 * until the left edge.
17988 * - @c "edge,right" - This is called when the genlist is scrolled
17989 * until the right edge.
17990 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
17992 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
17994 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
17996 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
17998 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
17999 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
18000 * multi-touch pinched in.
18001 * - @c "swipe" - This is called when the genlist is swiped.
18002 * - @c "moved" - This is called when a genlist item is moved.
18003 * - @c "language,changed" - This is called when the program's language is
18006 * @section Genlist_Examples Examples
18008 * Here is a list of examples that use the genlist, trying to show some of
18009 * its capabilities:
18010 * - @ref genlist_example_01
18011 * - @ref genlist_example_02
18012 * - @ref genlist_example_03
18013 * - @ref genlist_example_04
18014 * - @ref genlist_example_05
18018 * @addtogroup Genlist
18023 * @enum _Elm_Genlist_Item_Flags
18024 * @typedef Elm_Genlist_Item_Flags
18026 * Defines if the item is of any special type (has subitems or it's the
18027 * index of a group), or is just a simple item.
18031 typedef enum _Elm_Genlist_Item_Flags
18033 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18034 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18035 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18036 } Elm_Genlist_Item_Flags;
18037 typedef enum _Elm_Genlist_Item_Field_Flags
18039 ELM_GENLIST_ITEM_FIELD_ALL = 0,
18040 ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
18041 ELM_GENLIST_ITEM_FIELD_ICON = (1 << 1),
18042 ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
18043 } Elm_Genlist_Item_Field_Flags;
18044 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
18045 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18046 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
18047 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
18048 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
18049 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
18050 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj);
18051 typedef void (*GenlistItemMovedFunc) ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
18054 * @struct _Elm_Genlist_Item_Class
18056 * Genlist item class definition structs.
18058 * This struct contains the style and fetching functions that will define the
18059 * contents of each item.
18061 * @see @ref Genlist_Item_Class
18063 struct _Elm_Genlist_Item_Class
18065 const char *item_style;
18067 GenlistItemLabelGetFunc label_get;
18068 GenlistItemIconGetFunc icon_get;
18069 GenlistItemStateGetFunc state_get;
18070 GenlistItemDelFunc del;
18071 GenlistItemMovedFunc moved;
18073 const char *edit_item_style;
18074 const char *mode_item_style;
18076 #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18078 * Add a new genlist widget to the given parent Elementary
18079 * (container) object
18081 * @param parent The parent object
18082 * @return a new genlist widget handle or @c NULL, on errors
18084 * This function inserts a new genlist widget on the canvas.
18086 * @see elm_genlist_item_append()
18087 * @see elm_genlist_item_del()
18088 * @see elm_genlist_clear()
18092 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18094 * Remove all items from a given genlist widget.
18096 * @param obj The genlist object
18098 * This removes (and deletes) all items in @p obj, leaving it empty.
18100 * @see elm_genlist_item_del(), to remove just one item.
18104 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18106 * Enable or disable multi-selection in the genlist
18108 * @param obj The genlist object
18109 * @param multi Multi-select enable/disable. Default is disabled.
18111 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18112 * the list. This allows more than 1 item to be selected. To retrieve the list
18113 * of selected items, use elm_genlist_selected_items_get().
18115 * @see elm_genlist_selected_items_get()
18116 * @see elm_genlist_multi_select_get()
18120 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18122 * Gets if multi-selection in genlist is enabled or disabled.
18124 * @param obj The genlist object
18125 * @return Multi-select enabled/disabled
18126 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18128 * @see elm_genlist_multi_select_set()
18132 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18134 * This sets the horizontal stretching mode.
18136 * @param obj The genlist object
18137 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18139 * This sets the mode used for sizing items horizontally. Valid modes
18140 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18141 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18142 * the scroller will scroll horizontally. Otherwise items are expanded
18143 * to fill the width of the viewport of the scroller. If it is
18144 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18145 * limited to that size.
18147 * @see elm_genlist_horizontal_get()
18151 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18153 * Gets the horizontal stretching mode.
18155 * @param obj The genlist object
18156 * @return The mode to use
18157 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18159 * @see elm_genlist_horizontal_set()
18163 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18165 * Set the always select mode.
18167 * @param obj The genlist object
18168 * @param always_select The always select mode (@c EINA_TRUE = on, @c
18169 * EINA_FALSE = off). Default is @c EINA_FALSE.
18171 * Items will only call their selection func and callback when first
18172 * becoming selected. Any further clicks will do nothing, unless you
18173 * enable always select with elm_genlist_always_select_mode_set().
18174 * This means that, even if selected, every click will make the selected
18175 * callbacks be called.
18177 * @see elm_genlist_always_select_mode_get()
18181 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18183 * Get the always select mode.
18185 * @param obj The genlist object
18186 * @return The always select mode
18187 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18189 * @see elm_genlist_always_select_mode_set()
18193 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18195 * Enable/disable the no select mode.
18197 * @param obj The genlist object
18198 * @param no_select The no select mode
18199 * (EINA_TRUE = on, EINA_FALSE = off)
18201 * This will turn off the ability to select items entirely and they
18202 * will neither appear selected nor call selected callback functions.
18204 * @see elm_genlist_no_select_mode_get()
18208 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18210 * Gets whether the no select mode is enabled.
18212 * @param obj The genlist object
18213 * @return The no select mode
18214 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18216 * @see elm_genlist_no_select_mode_set()
18220 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18222 * Enable/disable compress mode.
18224 * @param obj The genlist object
18225 * @param compress The compress mode
18226 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18228 * This will enable the compress mode where items are "compressed"
18229 * horizontally to fit the genlist scrollable viewport width. This is
18230 * special for genlist. Do not rely on
18231 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18232 * work as genlist needs to handle it specially.
18234 * @see elm_genlist_compress_mode_get()
18238 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18240 * Get whether the compress mode is enabled.
18242 * @param obj The genlist object
18243 * @return The compress mode
18244 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18246 * @see elm_genlist_compress_mode_set()
18250 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18252 * Enable/disable height-for-width mode.
18254 * @param obj The genlist object
18255 * @param setting The height-for-width mode (@c EINA_TRUE = on,
18256 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18258 * With height-for-width mode the item width will be fixed (restricted
18259 * to a minimum of) to the list width when calculating its size in
18260 * order to allow the height to be calculated based on it. This allows,
18261 * for instance, text block to wrap lines if the Edje part is
18262 * configured with "text.min: 0 1".
18264 * @note This mode will make list resize slower as it will have to
18265 * recalculate every item height again whenever the list width
18268 * @note When height-for-width mode is enabled, it also enables
18269 * compress mode (see elm_genlist_compress_mode_set()) and
18270 * disables homogeneous (see elm_genlist_homogeneous_set()).
18274 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18276 * Get whether the height-for-width mode is enabled.
18278 * @param obj The genlist object
18279 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18284 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18286 * Enable/disable horizontal and vertical bouncing effect.
18288 * @param obj The genlist object
18289 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18290 * EINA_FALSE = off). Default is @c EINA_FALSE.
18291 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18292 * EINA_FALSE = off). Default is @c EINA_TRUE.
18294 * This will enable or disable the scroller bouncing effect for the
18295 * genlist. See elm_scroller_bounce_set() for details.
18297 * @see elm_scroller_bounce_set()
18298 * @see elm_genlist_bounce_get()
18302 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18304 * Get whether the horizontal and vertical bouncing effect is enabled.
18306 * @param obj The genlist object
18307 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18309 * @param v_bounce Pointer to a bool to receive if the bounce vertically
18312 * @see elm_genlist_bounce_set()
18316 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18318 * Enable/disable homogenous mode.
18320 * @param obj The genlist object
18321 * @param homogeneous Assume the items within the genlist are of the
18322 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18325 * This will enable the homogeneous mode where items are of the same
18326 * height and width so that genlist may do the lazy-loading at its
18327 * maximum (which increases the performance for scrolling the list). This
18328 * implies 'compressed' mode.
18330 * @see elm_genlist_compress_mode_set()
18331 * @see elm_genlist_homogeneous_get()
18335 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18337 * Get whether the homogenous mode is enabled.
18339 * @param obj The genlist object
18340 * @return Assume the items within the genlist are of the same height
18341 * and width (EINA_TRUE = on, EINA_FALSE = off)
18343 * @see elm_genlist_homogeneous_set()
18347 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18349 * Set the maximum number of items within an item block
18351 * @param obj The genlist object
18352 * @param n Maximum number of items within an item block. Default is 32.
18354 * This will configure the block count to tune to the target with
18355 * particular performance matrix.
18357 * A block of objects will be used to reduce the number of operations due to
18358 * many objects in the screen. It can determine the visibility, or if the
18359 * object has changed, it theme needs to be updated, etc. doing this kind of
18360 * calculation to the entire block, instead of per object.
18362 * The default value for the block count is enough for most lists, so unless
18363 * you know you will have a lot of objects visible in the screen at the same
18364 * time, don't try to change this.
18366 * @see elm_genlist_block_count_get()
18367 * @see @ref Genlist_Implementation
18371 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18373 * Get the maximum number of items within an item block
18375 * @param obj The genlist object
18376 * @return Maximum number of items within an item block
18378 * @see elm_genlist_block_count_set()
18382 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18384 * Set the timeout in seconds for the longpress event.
18386 * @param obj The genlist object
18387 * @param timeout timeout in seconds. Default is 1.
18389 * This option will change how long it takes to send an event "longpressed"
18390 * after the mouse down signal is sent to the list. If this event occurs, no
18391 * "clicked" event will be sent.
18393 * @see elm_genlist_longpress_timeout_set()
18397 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18399 * Get the timeout in seconds for the longpress event.
18401 * @param obj The genlist object
18402 * @return timeout in seconds
18404 * @see elm_genlist_longpress_timeout_get()
18408 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18410 * Append a new item in a given genlist widget.
18412 * @param obj The genlist object
18413 * @param itc The item class for the item
18414 * @param data The item data
18415 * @param parent The parent item, or NULL if none
18416 * @param flags Item flags
18417 * @param func Convenience function called when the item is selected
18418 * @param func_data Data passed to @p func above.
18419 * @return A handle to the item added or @c NULL if not possible
18421 * This adds the given item to the end of the list or the end of
18422 * the children list if the @p parent is given.
18424 * @see elm_genlist_item_prepend()
18425 * @see elm_genlist_item_insert_before()
18426 * @see elm_genlist_item_insert_after()
18427 * @see elm_genlist_item_del()
18431 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);
18433 * Prepend a new item in a given genlist widget.
18435 * @param obj The genlist object
18436 * @param itc The item class for the item
18437 * @param data The item data
18438 * @param parent The parent item, or NULL if none
18439 * @param flags Item flags
18440 * @param func Convenience function called when the item is selected
18441 * @param func_data Data passed to @p func above.
18442 * @return A handle to the item added or NULL if not possible
18444 * This adds an item to the beginning of the list or beginning of the
18445 * children of the parent if given.
18447 * @see elm_genlist_item_append()
18448 * @see elm_genlist_item_insert_before()
18449 * @see elm_genlist_item_insert_after()
18450 * @see elm_genlist_item_del()
18454 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);
18456 * Insert an item before another in a genlist widget
18458 * @param obj The genlist object
18459 * @param itc The item class for the item
18460 * @param data The item data
18461 * @param before The item to place this new one before.
18462 * @param flags Item flags
18463 * @param func Convenience function called when the item is selected
18464 * @param func_data Data passed to @p func above.
18465 * @return A handle to the item added or @c NULL if not possible
18467 * This inserts an item before another in the list. It will be in the
18468 * same tree level or group as the item it is inserted before.
18470 * @see elm_genlist_item_append()
18471 * @see elm_genlist_item_prepend()
18472 * @see elm_genlist_item_insert_after()
18473 * @see elm_genlist_item_del()
18477 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);
18479 * Insert an item after another in a genlist widget
18481 * @param obj The genlist object
18482 * @param itc The item class for the item
18483 * @param data The item data
18484 * @param after The item to place this new one after.
18485 * @param flags Item flags
18486 * @param func Convenience function called when the item is selected
18487 * @param func_data Data passed to @p func above.
18488 * @return A handle to the item added or @c NULL if not possible
18490 * This inserts an item after another in the list. It will be in the
18491 * same tree level or group as the item it is inserted after.
18493 * @see elm_genlist_item_append()
18494 * @see elm_genlist_item_prepend()
18495 * @see elm_genlist_item_insert_before()
18496 * @see elm_genlist_item_del()
18500 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);
18502 * Insert a new item into the sorted genlist object
18504 * @param obj The genlist object
18505 * @param itc The item class for the item
18506 * @param data The item data
18507 * @param parent The parent item, or NULL if none
18508 * @param flags Item flags
18509 * @param comp The function called for the sort
18510 * @param func Convenience function called when item selected
18511 * @param func_data Data passed to @p func above.
18512 * @return A handle to the item added or NULL if not possible
18516 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);
18517 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);
18518 /* operations to retrieve existing items */
18520 * Get the selectd item in the genlist.
18522 * @param obj The genlist object
18523 * @return The selected item, or NULL if none is selected.
18525 * This gets the selected item in the list (if multi-selection is enabled, only
18526 * the item that was first selected in the list is returned - which is not very
18527 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18530 * If no item is selected, NULL is returned.
18532 * @see elm_genlist_selected_items_get()
18536 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18538 * Get a list of selected items in the genlist.
18540 * @param obj The genlist object
18541 * @return The list of selected items, or NULL if none are selected.
18543 * It returns a list of the selected items. This list pointer is only valid so
18544 * long as the selection doesn't change (no items are selected or unselected, or
18545 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18546 * pointers. The order of the items in this list is the order which they were
18547 * selected, i.e. the first item in this list is the first item that was
18548 * selected, and so on.
18550 * @note If not in multi-select mode, consider using function
18551 * elm_genlist_selected_item_get() instead.
18553 * @see elm_genlist_multi_select_set()
18554 * @see elm_genlist_selected_item_get()
18558 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18560 * Get the mode item style of items in the genlist
18561 * @param obj The genlist object
18562 * @return The mode item style string, or NULL if none is specified
18564 * This is a constant string and simply defines the name of the
18565 * style that will be used for mode animations. It can be
18566 * @c NULL if you don't plan to use Genlist mode. See
18567 * elm_genlist_item_mode_set() for more info.
18571 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18573 * Set the mode item style of items in the genlist
18574 * @param obj The genlist object
18575 * @param style The mode item style string, or NULL if none is desired
18577 * This is a constant string and simply defines the name of the
18578 * style that will be used for mode animations. It can be
18579 * @c NULL if you don't plan to use Genlist mode. See
18580 * elm_genlist_item_mode_set() for more info.
18584 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
18586 * Get a list of realized items in genlist
18588 * @param obj The genlist object
18589 * @return The list of realized items, nor NULL if none are realized.
18591 * This returns a list of the realized items in the genlist. The list
18592 * contains Elm_Genlist_Item pointers. The list must be freed by the
18593 * caller when done with eina_list_free(). The item pointers in the
18594 * list are only valid so long as those items are not deleted or the
18595 * genlist is not deleted.
18597 * @see elm_genlist_realized_items_update()
18601 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18603 * Get the item that is at the x, y canvas coords.
18605 * @param obj The gelinst object.
18606 * @param x The input x coordinate
18607 * @param y The input y coordinate
18608 * @param posret The position relative to the item returned here
18609 * @return The item at the coordinates or NULL if none
18611 * This returns the item at the given coordinates (which are canvas
18612 * relative, not object-relative). If an item is at that coordinate,
18613 * that item handle is returned, and if @p posret is not NULL, the
18614 * integer pointed to is set to a value of -1, 0 or 1, depending if
18615 * the coordinate is on the upper portion of that item (-1), on the
18616 * middle section (0) or on the lower part (1). If NULL is returned as
18617 * an item (no item found there), then posret may indicate -1 or 1
18618 * based if the coordinate is above or below all items respectively in
18623 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);
18625 * Get the first item in the genlist
18627 * This returns the first item in the list.
18629 * @param obj The genlist object
18630 * @return The first item, or NULL if none
18634 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18636 * Get the last item in the genlist
18638 * This returns the last item in the list.
18640 * @return The last item, or NULL if none
18644 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18646 * Set the scrollbar policy
18648 * @param obj The genlist object
18649 * @param policy_h Horizontal scrollbar policy.
18650 * @param policy_v Vertical scrollbar policy.
18652 * This sets the scrollbar visibility policy for the given genlist
18653 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
18654 * made visible if it is needed, and otherwise kept hidden.
18655 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
18656 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
18657 * respectively for the horizontal and vertical scrollbars. Default is
18658 * #ELM_SMART_SCROLLER_POLICY_AUTO
18660 * @see elm_genlist_scroller_policy_get()
18664 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
18666 * Get the scrollbar policy
18668 * @param obj The genlist object
18669 * @param policy_h Pointer to store the horizontal scrollbar policy.
18670 * @param policy_v Pointer to store the vertical scrollbar policy.
18672 * @see elm_genlist_scroller_policy_set()
18676 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);
18678 * Get the @b next item in a genlist widget's internal list of items,
18679 * given a handle to one of those items.
18681 * @param item The genlist item to fetch next from
18682 * @return The item after @p item, or @c NULL if there's none (and
18685 * This returns the item placed after the @p item, on the container
18688 * @see elm_genlist_item_prev_get()
18692 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18694 * Get the @b previous item in a genlist widget's internal list of items,
18695 * given a handle to one of those items.
18697 * @param item The genlist item to fetch previous from
18698 * @return The item before @p item, or @c NULL if there's none (and
18701 * This returns the item placed before the @p item, on the container
18704 * @see elm_genlist_item_next_get()
18708 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18710 * Get the genlist object's handle which contains a given genlist
18713 * @param item The item to fetch the container from
18714 * @return The genlist (parent) object
18716 * This returns the genlist object itself that an item belongs to.
18720 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18722 * Get the parent item of the given item
18724 * @param it The item
18725 * @return The parent of the item or @c NULL if it has no parent.
18727 * This returns the item that was specified as parent of the item @p it on
18728 * elm_genlist_item_append() and insertion related functions.
18732 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18734 * Remove all sub-items (children) of the given item
18736 * @param it The item
18738 * This removes all items that are children (and their descendants) of the
18739 * given item @p it.
18741 * @see elm_genlist_clear()
18742 * @see elm_genlist_item_del()
18746 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18748 * Set whether a given genlist item is selected or not
18750 * @param it The item
18751 * @param selected Use @c EINA_TRUE, to make it selected, @c
18752 * EINA_FALSE to make it unselected
18754 * This sets the selected state of an item. If multi selection is
18755 * not enabled on the containing genlist and @p selected is @c
18756 * EINA_TRUE, any other previously selected items will get
18757 * unselected in favor of this new one.
18759 * @see elm_genlist_item_selected_get()
18763 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
18765 * Get whether a given genlist item is selected or not
18767 * @param it The item
18768 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
18770 * @see elm_genlist_item_selected_set() for more details
18774 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18776 * Sets the expanded state of an item.
18778 * @param it The item
18779 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
18781 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
18784 * The theme will respond to this change visually, and a signal "expanded" or
18785 * "contracted" will be sent from the genlist with a pointer to the item that
18786 * has been expanded/contracted.
18788 * Calling this function won't show or hide any child of this item (if it is
18789 * a parent). You must manually delete and create them on the callbacks fo
18790 * the "expanded" or "contracted" signals.
18792 * @see elm_genlist_item_expanded_get()
18796 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
18798 * Get the expanded state of an item
18800 * @param it The item
18801 * @return The expanded state
18803 * This gets the expanded state of an item.
18805 * @see elm_genlist_item_expanded_set()
18809 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18811 * Get the depth of expanded item
18813 * @param it The genlist item object
18814 * @return The depth of expanded item
18818 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18820 * Set whether a given genlist item is disabled or not.
18822 * @param it The item
18823 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
18824 * to enable it back.
18826 * A disabled item cannot be selected or unselected. It will also
18827 * change its appearance, to signal the user it's disabled.
18829 * @see elm_genlist_item_disabled_get()
18833 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
18835 * Get whether a given genlist item is disabled or not.
18837 * @param it The item
18838 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
18841 * @see elm_genlist_item_disabled_set() for more details
18845 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18847 * Sets the display only state of an item.
18849 * @param it The item
18850 * @param display_only @c EINA_TRUE if the item is display only, @c
18851 * EINA_FALSE otherwise.
18853 * A display only item cannot be selected or unselected. It is for
18854 * display only and not selecting or otherwise clicking, dragging
18855 * etc. by the user, thus finger size rules will not be applied to
18858 * It's good to set group index items to display only state.
18860 * @see elm_genlist_item_display_only_get()
18864 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
18866 * Get the display only state of an item
18868 * @param it The item
18869 * @return @c EINA_TRUE if the item is display only, @c
18870 * EINA_FALSE otherwise.
18872 * @see elm_genlist_item_display_only_set()
18876 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18878 * Show the portion of a genlist's internal list containing a given
18879 * item, immediately.
18881 * @param it The item to display
18883 * This causes genlist to jump to the given item @p it and show it (by
18884 * immediately scrolling to that position), if it is not fully visible.
18886 * @see elm_genlist_item_bring_in()
18887 * @see elm_genlist_item_top_show()
18888 * @see elm_genlist_item_middle_show()
18892 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18894 * Animatedly bring in, to the visible are of a genlist, a given
18897 * @param it The item to display
18899 * This causes genlist to jump to the given item @p it and show it (by
18900 * animatedly scrolling), if it is not fully visible. This may use animation
18901 * to do so and take a period of time
18903 * @see elm_genlist_item_show()
18904 * @see elm_genlist_item_top_bring_in()
18905 * @see elm_genlist_item_middle_bring_in()
18909 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18911 * Show the portion of a genlist's internal list containing a given
18912 * item, immediately.
18914 * @param it The item to display
18916 * This causes genlist to jump to the given item @p it and show it (by
18917 * immediately scrolling to that position), if it is not fully visible.
18919 * The item will be positioned at the top of the genlist viewport.
18921 * @see elm_genlist_item_show()
18922 * @see elm_genlist_item_top_bring_in()
18926 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18928 * Animatedly bring in, to the visible are of a genlist, a given
18931 * @param it The item
18933 * This causes genlist to jump to the given item @p it and show it (by
18934 * animatedly scrolling), if it is not fully visible. This may use animation
18935 * to do so and take a period of time
18937 * The item will be positioned at the top of the genlist viewport.
18939 * @see elm_genlist_item_bring_in()
18940 * @see elm_genlist_item_top_show()
18944 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18946 * Show the portion of a genlist's internal list containing a given
18947 * item, immediately.
18949 * @param it The item to display
18951 * This causes genlist to jump to the given item @p it and show it (by
18952 * immediately scrolling to that position), if it is not fully visible.
18954 * The item will be positioned at the middle of the genlist viewport.
18956 * @see elm_genlist_item_show()
18957 * @see elm_genlist_item_middle_bring_in()
18961 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18963 * Animatedly bring in, to the visible are of a genlist, a given
18966 * @param it The item
18968 * This causes genlist to jump to the given item @p it and show it (by
18969 * animatedly scrolling), if it is not fully visible. This may use animation
18970 * to do so and take a period of time
18972 * The item will be positioned at the middle of the genlist viewport.
18974 * @see elm_genlist_item_bring_in()
18975 * @see elm_genlist_item_middle_show()
18979 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18981 * Remove a genlist item from the its parent, deleting it.
18983 * @param item The item to be removed.
18984 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
18986 * @see elm_genlist_clear(), to remove all items in a genlist at
18991 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18993 * Return the data associated to a given genlist item
18995 * @param item The genlist item.
18996 * @return the data associated to this item.
18998 * This returns the @c data value passed on the
18999 * elm_genlist_item_append() and related item addition calls.
19001 * @see elm_genlist_item_append()
19002 * @see elm_genlist_item_data_set()
19006 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19008 * Set the data associated to a given genlist item
19010 * @param item The genlist item
19011 * @param data The new data pointer to set on it
19013 * This @b overrides the @c data value passed on the
19014 * elm_genlist_item_append() and related item addition calls. This
19015 * function @b won't call elm_genlist_item_update() automatically,
19016 * so you'd issue it afterwards if you want to hove the item
19017 * updated to reflect the that new data.
19019 * @see elm_genlist_item_data_get()
19023 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19025 * Tells genlist to "orphan" icons fetchs by the item class
19027 * @param it The item
19029 * This instructs genlist to release references to icons in the item,
19030 * meaning that they will no longer be managed by genlist and are
19031 * floating "orphans" that can be re-used elsewhere if the user wants
19036 EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19037 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19039 * Get the real Evas object created to implement the view of a
19040 * given genlist item
19042 * @param item The genlist item.
19043 * @return the Evas object implementing this item's view.
19045 * This returns the actual Evas object used to implement the
19046 * specified genlist item's view. This may be @c NULL, as it may
19047 * not have been created or may have been deleted, at any time, by
19048 * the genlist. <b>Do not modify this object</b> (move, resize,
19049 * show, hide, etc.), as the genlist is controlling it. This
19050 * function is for querying, emitting custom signals or hooking
19051 * lower level callbacks for events on that object. Do not delete
19052 * this object under any circumstances.
19054 * @see elm_genlist_item_data_get()
19058 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19060 * Update the contents of an item
19062 * @param it The item
19064 * This updates an item by calling all the item class functions again
19065 * to get the icons, labels and states. Use this when the original
19066 * item data has changed and the changes are desired to be reflected.
19068 * Use elm_genlist_realized_items_update() to update all already realized
19071 * @see elm_genlist_realized_items_update()
19075 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19076 EAPI void elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
19078 * Update the item class of an item
19080 * @param it The item
19081 * @param itc The item class for the item
19083 * This sets another class fo the item, changing the way that it is
19084 * displayed. After changing the item class, elm_genlist_item_update() is
19085 * called on the item @p it.
19089 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19090 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19092 * Set the text to be shown in a given genlist item's tooltips.
19094 * @param item The genlist item
19095 * @param text The text to set in the content
19097 * This call will setup the text to be used as tooltip to that item
19098 * (analogous to elm_object_tooltip_text_set(), but being item
19099 * tooltips with higher precedence than object tooltips). It can
19100 * have only one tooltip at a time, so any previous tooltip data
19101 * will get removed.
19103 * In order to set an icon or something else as a tooltip, look at
19104 * elm_genlist_item_tooltip_content_cb_set().
19108 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19110 * Set the content to be shown in a given genlist item's tooltips
19112 * @param item The genlist item.
19113 * @param func The function returning the tooltip contents.
19114 * @param data What to provide to @a func as callback data/context.
19115 * @param del_cb Called when data is not needed anymore, either when
19116 * another callback replaces @p func, the tooltip is unset with
19117 * elm_genlist_item_tooltip_unset() or the owner @p item
19118 * dies. This callback receives as its first parameter the
19119 * given @p data, being @c event_info the item handle.
19121 * This call will setup the tooltip's contents to @p item
19122 * (analogous to elm_object_tooltip_content_cb_set(), but being
19123 * item tooltips with higher precedence than object tooltips). It
19124 * can have only one tooltip at a time, so any previous tooltip
19125 * content will get removed. @p func (with @p data) will be called
19126 * every time Elementary needs to show the tooltip and it should
19127 * return a valid Evas object, which will be fully managed by the
19128 * tooltip system, getting deleted when the tooltip is gone.
19130 * In order to set just a text as a tooltip, look at
19131 * elm_genlist_item_tooltip_text_set().
19135 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);
19137 * Unset a tooltip from a given genlist item
19139 * @param item genlist item to remove a previously set tooltip from.
19141 * This call removes any tooltip set on @p item. The callback
19142 * provided as @c del_cb to
19143 * elm_genlist_item_tooltip_content_cb_set() will be called to
19144 * notify it is not used anymore (and have resources cleaned, if
19147 * @see elm_genlist_item_tooltip_content_cb_set()
19151 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19153 * Set a different @b style for a given genlist item's tooltip.
19155 * @param item genlist item with tooltip set
19156 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19157 * "default", @c "transparent", etc)
19159 * Tooltips can have <b>alternate styles</b> to be displayed on,
19160 * which are defined by the theme set on Elementary. This function
19161 * works analogously as elm_object_tooltip_style_set(), but here
19162 * applied only to genlist item objects. The default style for
19163 * tooltips is @c "default".
19165 * @note before you set a style you should define a tooltip with
19166 * elm_genlist_item_tooltip_content_cb_set() or
19167 * elm_genlist_item_tooltip_text_set()
19169 * @see elm_genlist_item_tooltip_style_get()
19173 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19175 * Get the style set a given genlist item's tooltip.
19177 * @param item genlist item with tooltip already set on.
19178 * @return style the theme style in use, which defaults to
19179 * "default". If the object does not have a tooltip set,
19180 * then @c NULL is returned.
19182 * @see elm_genlist_item_tooltip_style_set() for more details
19186 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19188 * Set the type of mouse pointer/cursor decoration to be shown,
19189 * when the mouse pointer is over the given genlist widget item
19191 * @param item genlist item to customize cursor on
19192 * @param cursor the cursor type's name
19194 * This function works analogously as elm_object_cursor_set(), but
19195 * here the cursor's changing area is restricted to the item's
19196 * area, and not the whole widget's. Note that that item cursors
19197 * have precedence over widget cursors, so that a mouse over @p
19198 * item will always show cursor @p type.
19200 * If this function is called twice for an object, a previously set
19201 * cursor will be unset on the second call.
19203 * @see elm_object_cursor_set()
19204 * @see elm_genlist_item_cursor_get()
19205 * @see elm_genlist_item_cursor_unset()
19209 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19211 * Get the type of mouse pointer/cursor decoration set to be shown,
19212 * when the mouse pointer is over the given genlist widget item
19214 * @param item genlist item with custom cursor set
19215 * @return the cursor type's name or @c NULL, if no custom cursors
19216 * were set to @p item (and on errors)
19218 * @see elm_object_cursor_get()
19219 * @see elm_genlist_item_cursor_set() for more details
19220 * @see elm_genlist_item_cursor_unset()
19224 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19226 * Unset any custom mouse pointer/cursor decoration set to be
19227 * shown, when the mouse pointer is over the given genlist widget
19228 * item, thus making it show the @b default cursor again.
19230 * @param item a genlist item
19232 * Use this call to undo any custom settings on this item's cursor
19233 * decoration, bringing it back to defaults (no custom style set).
19235 * @see elm_object_cursor_unset()
19236 * @see elm_genlist_item_cursor_set() for more details
19240 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19242 * Set a different @b style for a given custom cursor set for a
19245 * @param item genlist item with custom cursor set
19246 * @param style the <b>theme style</b> to use (e.g. @c "default",
19247 * @c "transparent", etc)
19249 * This function only makes sense when one is using custom mouse
19250 * cursor decorations <b>defined in a theme file</b> , which can
19251 * have, given a cursor name/type, <b>alternate styles</b> on
19252 * it. It works analogously as elm_object_cursor_style_set(), but
19253 * here applied only to genlist item objects.
19255 * @warning Before you set a cursor style you should have defined a
19256 * custom cursor previously on the item, with
19257 * elm_genlist_item_cursor_set()
19259 * @see elm_genlist_item_cursor_engine_only_set()
19260 * @see elm_genlist_item_cursor_style_get()
19264 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19266 * Get the current @b style set for a given genlist item's custom
19269 * @param item genlist item with custom cursor set.
19270 * @return style the cursor style in use. If the object does not
19271 * have a cursor set, then @c NULL is returned.
19273 * @see elm_genlist_item_cursor_style_set() for more details
19277 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19279 * Set if the (custom) cursor for a given genlist item should be
19280 * searched in its theme, also, or should only rely on the
19281 * rendering engine.
19283 * @param item item with custom (custom) cursor already set on
19284 * @param engine_only Use @c EINA_TRUE to have cursors looked for
19285 * only on those provided by the rendering engine, @c EINA_FALSE to
19286 * have them searched on the widget's theme, as well.
19288 * @note This call is of use only if you've set a custom cursor
19289 * for genlist items, with elm_genlist_item_cursor_set().
19291 * @note By default, cursors will only be looked for between those
19292 * provided by the rendering engine.
19296 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19298 * Get if the (custom) cursor for a given genlist item is being
19299 * searched in its theme, also, or is only relying on the rendering
19302 * @param item a genlist item
19303 * @return @c EINA_TRUE, if cursors are being looked for only on
19304 * those provided by the rendering engine, @c EINA_FALSE if they
19305 * are being searched on the widget's theme, as well.
19307 * @see elm_genlist_item_cursor_engine_only_set(), for more details
19311 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19313 * Update the contents of all realized items.
19315 * @param obj The genlist object.
19317 * This updates all realized items by calling all the item class functions again
19318 * to get the icons, labels and states. Use this when the original
19319 * item data has changed and the changes are desired to be reflected.
19321 * To update just one item, use elm_genlist_item_update().
19323 * @see elm_genlist_realized_items_get()
19324 * @see elm_genlist_item_update()
19328 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19330 * Activate a genlist mode on an item
19332 * @param item The genlist item
19333 * @param mode Mode name
19334 * @param mode_set Boolean to define set or unset mode.
19336 * A genlist mode is a different way of selecting an item. Once a mode is
19337 * activated on an item, any other selected item is immediately unselected.
19338 * This feature provides an easy way of implementing a new kind of animation
19339 * for selecting an item, without having to entirely rewrite the item style
19340 * theme. However, the elm_genlist_selected_* API can't be used to get what
19341 * item is activate for a mode.
19343 * The current item style will still be used, but applying a genlist mode to
19344 * an item will select it using a different kind of animation.
19346 * The current active item for a mode can be found by
19347 * elm_genlist_mode_item_get().
19349 * The characteristics of genlist mode are:
19350 * - Only one mode can be active at any time, and for only one item.
19351 * - Genlist handles deactivating other items when one item is activated.
19352 * - A mode is defined in the genlist theme (edc), and more modes can easily
19354 * - A mode style and the genlist item style are different things. They
19355 * can be combined to provide a default style to the item, with some kind
19356 * of animation for that item when the mode is activated.
19358 * When a mode is activated on an item, a new view for that item is created.
19359 * The theme of this mode defines the animation that will be used to transit
19360 * the item from the old view to the new view. This second (new) view will be
19361 * active for that item while the mode is active on the item, and will be
19362 * destroyed after the mode is totally deactivated from that item.
19364 * @see elm_genlist_mode_get()
19365 * @see elm_genlist_mode_item_get()
19369 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19371 * Get the last (or current) genlist mode used.
19373 * @param obj The genlist object
19375 * This function just returns the name of the last used genlist mode. It will
19376 * be the current mode if it's still active.
19378 * @see elm_genlist_item_mode_set()
19379 * @see elm_genlist_mode_item_get()
19383 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19385 * Get active genlist mode item
19387 * @param obj The genlist object
19388 * @return The active item for that current mode. Or @c NULL if no item is
19389 * activated with any mode.
19391 * This function returns the item that was activated with a mode, by the
19392 * function elm_genlist_item_mode_set().
19394 * @see elm_genlist_item_mode_set()
19395 * @see elm_genlist_mode_get()
19399 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19404 * @param obj The genlist object
19405 * @param reorder_mode The reorder mode
19406 * (EINA_TRUE = on, EINA_FALSE = off)
19410 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19413 * Get the reorder mode
19415 * @param obj The genlist object
19416 * @return The reorder mode
19417 * (EINA_TRUE = on, EINA_FALSE = off)
19421 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19423 EAPI void elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
19424 EAPI Eina_Bool elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19425 EAPI void elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
19426 EAPI Eina_Bool elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19427 EAPI void elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
19428 EAPI void elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
19429 EAPI void elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19430 EAPI void elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19431 EAPI void elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19432 EAPI Eina_Bool elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19439 * @defgroup Check Check
19441 * @image html img/widget/check/preview-00.png
19442 * @image latex img/widget/check/preview-00.eps
19443 * @image html img/widget/check/preview-01.png
19444 * @image latex img/widget/check/preview-01.eps
19445 * @image html img/widget/check/preview-02.png
19446 * @image latex img/widget/check/preview-02.eps
19448 * @brief The check widget allows for toggling a value between true and
19451 * Check objects are a lot like radio objects in layout and functionality
19452 * except they do not work as a group, but independently and only toggle the
19453 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19454 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19455 * returns the current state. For convenience, like the radio objects, you
19456 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19457 * for it to modify.
19459 * Signals that you can add callbacks for are:
19460 * "changed" - This is called whenever the user changes the state of one of
19461 * the check object(event_info is NULL).
19463 * Default contents parts of the check widget that you can use for are:
19464 * @li "elm.swallow.content" - A icon of the check
19466 * Default text parts of the check widget that you can use for are:
19467 * @li "elm.text" - Label of the check
19469 * @ref tutorial_check should give you a firm grasp of how to use this widget
19474 * @brief Add a new Check object
19476 * @param parent The parent object
19477 * @return The new object or NULL if it cannot be created
19479 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19481 * @brief Set the text label of the check object
19483 * @param obj The check object
19484 * @param label The text label string in UTF-8
19486 * @deprecated use elm_object_text_set() instead.
19488 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19490 * @brief Get the text label of the check object
19492 * @param obj The check object
19493 * @return The text label string in UTF-8
19495 * @deprecated use elm_object_text_get() instead.
19497 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19499 * @brief Set the icon object of the check object
19501 * @param obj The check object
19502 * @param icon The icon object
19504 * Once the icon object is set, a previously set one will be deleted.
19505 * If you want to keep that old content object, use the
19506 * elm_object_content_unset() function.
19508 EINA_DEPRECATED EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19510 * @brief Get the icon object of the check object
19512 * @param obj The check object
19513 * @return The icon object
19515 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19517 * @brief Unset the icon used for the check object
19519 * @param obj The check object
19520 * @return The icon object that was being used
19522 * Unparent and return the icon object which was set for this widget.
19524 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19526 * @brief Set the on/off state of the check object
19528 * @param obj The check object
19529 * @param state The state to use (1 == on, 0 == off)
19531 * This sets the state of the check. If set
19532 * with elm_check_state_pointer_set() the state of that variable is also
19533 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19535 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19537 * @brief Get the state of the check object
19539 * @param obj The check object
19540 * @return The boolean state
19542 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19544 * @brief Set a convenience pointer to a boolean to change
19546 * @param obj The check object
19547 * @param statep Pointer to the boolean to modify
19549 * This sets a pointer to a boolean, that, in addition to the check objects
19550 * state will also be modified directly. To stop setting the object pointed
19551 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19552 * then when this is called, the check objects state will also be modified to
19553 * reflect the value of the boolean @p statep points to, just like calling
19554 * elm_check_state_set().
19556 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19562 * @defgroup Radio Radio
19564 * @image html img/widget/radio/preview-00.png
19565 * @image latex img/widget/radio/preview-00.eps
19567 * @brief Radio is a widget that allows for 1 or more options to be displayed
19568 * and have the user choose only 1 of them.
19570 * A radio object contains an indicator, an optional Label and an optional
19571 * icon object. While it's possible to have a group of only one radio they,
19572 * are normally used in groups of 2 or more. To add a radio to a group use
19573 * elm_radio_group_add(). The radio object(s) will select from one of a set
19574 * of integer values, so any value they are configuring needs to be mapped to
19575 * a set of integers. To configure what value that radio object represents,
19576 * use elm_radio_state_value_set() to set the integer it represents. To set
19577 * the value the whole group(which one is currently selected) is to indicate
19578 * use elm_radio_value_set() on any group member, and to get the groups value
19579 * use elm_radio_value_get(). For convenience the radio objects are also able
19580 * to directly set an integer(int) to the value that is selected. To specify
19581 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
19582 * The radio objects will modify this directly. That implies the pointer must
19583 * point to valid memory for as long as the radio objects exist.
19585 * Signals that you can add callbacks for are:
19586 * @li changed - This is called whenever the user changes the state of one of
19587 * the radio objects within the group of radio objects that work together.
19589 * Default contents parts of the radio widget that you can use for are:
19590 * @li "elm.swallow.content" - A icon of the radio
19592 * @ref tutorial_radio show most of this API in action.
19596 * @brief Add a new radio to the parent
19598 * @param parent The parent object
19599 * @return The new object or NULL if it cannot be created
19601 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19603 * @brief Set the text label of the radio object
19605 * @param obj The radio object
19606 * @param label The text label string in UTF-8
19608 * @deprecated use elm_object_text_set() instead.
19610 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19612 * @brief Get the text label of the radio object
19614 * @param obj The radio object
19615 * @return The text label string in UTF-8
19617 * @deprecated use elm_object_text_set() instead.
19619 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19621 * @brief Set the icon object of the radio object
19623 * @param obj The radio object
19624 * @param icon The icon object
19626 * Once the icon object is set, a previously set one will be deleted. If you
19627 * want to keep that old content object, use the elm_radio_icon_unset()
19630 * @deprecated use elm_object_content_set() instead.
19632 EINA_DEPRECATED EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19634 * @brief Get the icon object of the radio object
19636 * @param obj The radio object
19637 * @return The icon object
19639 * @see elm_radio_icon_set()
19641 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19643 * @brief Unset the icon used for the radio object
19645 * @param obj The radio object
19646 * @return The icon object that was being used
19648 * Unparent and return the icon object which was set for this widget.
19650 * @see elm_radio_icon_set()
19651 * @deprecated use elm_object_content_unset() instead.
19653 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19655 * @brief Add this radio to a group of other radio objects
19657 * @param obj The radio object
19658 * @param group Any object whose group the @p obj is to join.
19660 * Radio objects work in groups. Each member should have a different integer
19661 * value assigned. In order to have them work as a group, they need to know
19662 * about each other. This adds the given radio object to the group of which
19663 * the group object indicated is a member.
19665 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
19667 * @brief Set the integer value that this radio object represents
19669 * @param obj The radio object
19670 * @param value The value to use if this radio object is selected
19672 * This sets the value of the radio.
19674 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19676 * @brief Get the integer value that this radio object represents
19678 * @param obj The radio object
19679 * @return The value used if this radio object is selected
19681 * This gets the value of the radio.
19683 * @see elm_radio_value_set()
19685 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19687 * @brief Set the value of the radio.
19689 * @param obj The radio object
19690 * @param value The value to use for the group
19692 * This sets the value of the radio group and will also set the value if
19693 * pointed to, to the value supplied, but will not call any callbacks.
19695 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19697 * @brief Get the state of the radio object
19699 * @param obj The radio object
19700 * @return The integer state
19702 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19704 * @brief Set a convenience pointer to a integer to change
19706 * @param obj The radio object
19707 * @param valuep Pointer to the integer to modify
19709 * This sets a pointer to a integer, that, in addition to the radio objects
19710 * state will also be modified directly. To stop setting the object pointed
19711 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
19712 * when this is called, the radio objects state will also be modified to
19713 * reflect the value of the integer valuep points to, just like calling
19714 * elm_radio_value_set().
19716 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
19722 * @defgroup Pager Pager
19724 * @image html img/widget/pager/preview-00.png
19725 * @image latex img/widget/pager/preview-00.eps
19727 * @brief Widget that allows flipping between 1 or more “pages” of objects.
19729 * The flipping between “pages” of objects is animated. All content in pager
19730 * is kept in a stack, the last content to be added will be on the top of the
19731 * stack(be visible).
19733 * Objects can be pushed or popped from the stack or deleted as normal.
19734 * Pushes and pops will animate (and a pop will delete the object once the
19735 * animation is finished). Any object already in the pager can be promoted to
19736 * the top(from its current stacking position) through the use of
19737 * elm_pager_content_promote(). Objects are pushed to the top with
19738 * elm_pager_content_push() and when the top item is no longer wanted, simply
19739 * pop it with elm_pager_content_pop() and it will also be deleted. If an
19740 * object is no longer needed and is not the top item, just delete it as
19741 * normal. You can query which objects are the top and bottom with
19742 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
19744 * Signals that you can add callbacks for are:
19745 * "hide,finished" - when the previous page is hided
19747 * This widget has the following styles available:
19750 * @li fade_translucide
19751 * @li fade_invisible
19752 * @note This styles affect only the flipping animations, the appearance when
19753 * not animating is unaffected by styles.
19755 * @ref tutorial_pager gives a good overview of the usage of the API.
19759 * Add a new pager to the parent
19761 * @param parent The parent object
19762 * @return The new object or NULL if it cannot be created
19766 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19768 * @brief Push an object to the top of the pager stack (and show it).
19770 * @param obj The pager object
19771 * @param content The object to push
19773 * The object pushed becomes a child of the pager, it will be controlled and
19774 * deleted when the pager is deleted.
19776 * @note If the content is already in the stack use
19777 * elm_pager_content_promote().
19778 * @warning Using this function on @p content already in the stack results in
19779 * undefined behavior.
19781 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19783 * @brief Pop the object that is on top of the stack
19785 * @param obj The pager object
19787 * This pops the object that is on the top(visible) of the pager, makes it
19788 * disappear, then deletes the object. The object that was underneath it on
19789 * the stack will become visible.
19791 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
19793 * @brief Moves an object already in the pager stack to the top of the stack.
19795 * @param obj The pager object
19796 * @param content The object to promote
19798 * This will take the @p content and move it to the top of the stack as
19799 * if it had been pushed there.
19801 * @note If the content isn't already in the stack use
19802 * elm_pager_content_push().
19803 * @warning Using this function on @p content not already in the stack
19804 * results in undefined behavior.
19806 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19808 * @brief Return the object at the bottom of the pager stack
19810 * @param obj The pager object
19811 * @return The bottom object or NULL if none
19813 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19815 * @brief Return the object at the top of the pager stack
19817 * @param obj The pager object
19818 * @return The top object or NULL if none
19820 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19822 EAPI void elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
19823 EAPI void elm_pager_animation_disabled_set(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
19830 * @defgroup Slideshow Slideshow
19832 * @image html img/widget/slideshow/preview-00.png
19833 * @image latex img/widget/slideshow/preview-00.eps
19835 * This widget, as the name indicates, is a pre-made image
19836 * slideshow panel, with API functions acting on (child) image
19837 * items presentation. Between those actions, are:
19838 * - advance to next/previous image
19839 * - select the style of image transition animation
19840 * - set the exhibition time for each image
19841 * - start/stop the slideshow
19843 * The transition animations are defined in the widget's theme,
19844 * consequently new animations can be added without having to
19845 * update the widget's code.
19847 * @section Slideshow_Items Slideshow items
19849 * For slideshow items, just like for @ref Genlist "genlist" ones,
19850 * the user defines a @b classes, specifying functions that will be
19851 * called on the item's creation and deletion times.
19853 * The #Elm_Slideshow_Item_Class structure contains the following
19856 * - @c func.get - When an item is displayed, this function is
19857 * called, and it's where one should create the item object, de
19858 * facto. For example, the object can be a pure Evas image object
19859 * or an Elementary @ref Photocam "photocam" widget. See
19860 * #SlideshowItemGetFunc.
19861 * - @c func.del - When an item is no more displayed, this function
19862 * is called, where the user must delete any data associated to
19863 * the item. See #SlideshowItemDelFunc.
19865 * @section Slideshow_Caching Slideshow caching
19867 * The slideshow provides facilities to have items adjacent to the
19868 * one being displayed <b>already "realized"</b> (i.e. loaded) for
19869 * you, so that the system does not have to decode image data
19870 * anymore at the time it has to actually switch images on its
19871 * viewport. The user is able to set the numbers of items to be
19872 * cached @b before and @b after the current item, in the widget's
19875 * Smart events one can add callbacks for are:
19877 * - @c "changed" - when the slideshow switches its view to a new
19880 * List of examples for the slideshow widget:
19881 * @li @ref slideshow_example
19885 * @addtogroup Slideshow
19889 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
19890 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
19891 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
19892 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
19893 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
19896 * @struct _Elm_Slideshow_Item_Class
19898 * Slideshow item class definition. See @ref Slideshow_Items for
19901 struct _Elm_Slideshow_Item_Class
19903 struct _Elm_Slideshow_Item_Class_Func
19905 SlideshowItemGetFunc get;
19906 SlideshowItemDelFunc del;
19908 }; /**< #Elm_Slideshow_Item_Class member definitions */
19911 * Add a new slideshow widget to the given parent Elementary
19912 * (container) object
19914 * @param parent The parent object
19915 * @return A new slideshow widget handle or @c NULL, on errors
19917 * This function inserts a new slideshow widget on the canvas.
19919 * @ingroup Slideshow
19921 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19924 * Add (append) a new item in a given slideshow widget.
19926 * @param obj The slideshow object
19927 * @param itc The item class for the item
19928 * @param data The item's data
19929 * @return A handle to the item added or @c NULL, on errors
19931 * Add a new item to @p obj's internal list of items, appending it.
19932 * The item's class must contain the function really fetching the
19933 * image object to show for this item, which could be an Evas image
19934 * object or an Elementary photo, for example. The @p data
19935 * parameter is going to be passed to both class functions of the
19938 * @see #Elm_Slideshow_Item_Class
19939 * @see elm_slideshow_item_sorted_insert()
19941 * @ingroup Slideshow
19943 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
19946 * Insert a new item into the given slideshow widget, using the @p func
19947 * function to sort items (by item handles).
19949 * @param obj The slideshow object
19950 * @param itc The item class for the item
19951 * @param data The item's data
19952 * @param func The comparing function to be used to sort slideshow
19953 * items <b>by #Elm_Slideshow_Item item handles</b>
19954 * @return Returns The slideshow item handle, on success, or
19955 * @c NULL, on errors
19957 * Add a new item to @p obj's internal list of items, in a position
19958 * determined by the @p func comparing function. The item's class
19959 * must contain the function really fetching the image object to
19960 * show for this item, which could be an Evas image object or an
19961 * Elementary photo, for example. The @p data parameter is going to
19962 * be passed to both class functions of the item.
19964 * @see #Elm_Slideshow_Item_Class
19965 * @see elm_slideshow_item_add()
19967 * @ingroup Slideshow
19969 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);
19972 * Display a given slideshow widget's item, programmatically.
19974 * @param obj The slideshow object
19975 * @param item The item to display on @p obj's viewport
19977 * The change between the current item and @p item will use the
19978 * transition @p obj is set to use (@see
19979 * elm_slideshow_transition_set()).
19981 * @ingroup Slideshow
19983 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
19986 * Slide to the @b next item, in a given slideshow widget
19988 * @param obj The slideshow object
19990 * The sliding animation @p obj is set to use will be the
19991 * transition effect used, after this call is issued.
19993 * @note If the end of the slideshow's internal list of items is
19994 * reached, it'll wrap around to the list's beginning, again.
19996 * @ingroup Slideshow
19998 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20001 * Slide to the @b previous item, in a given slideshow widget
20003 * @param obj The slideshow object
20005 * The sliding animation @p obj is set to use will be the
20006 * transition effect used, after this call is issued.
20008 * @note If the beginning of the slideshow's internal list of items
20009 * is reached, it'll wrap around to the list's end, again.
20011 * @ingroup Slideshow
20013 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20016 * Returns the list of sliding transition/effect names available, for a
20017 * given slideshow widget.
20019 * @param obj The slideshow object
20020 * @return The list of transitions (list of @b stringshared strings
20023 * The transitions, which come from @p obj's theme, must be an EDC
20024 * data item named @c "transitions" on the theme file, with (prefix)
20025 * names of EDC programs actually implementing them.
20027 * The available transitions for slideshows on the default theme are:
20028 * - @c "fade" - the current item fades out, while the new one
20029 * fades in to the slideshow's viewport.
20030 * - @c "black_fade" - the current item fades to black, and just
20031 * then, the new item will fade in.
20032 * - @c "horizontal" - the current item slides horizontally, until
20033 * it gets out of the slideshow's viewport, while the new item
20034 * comes from the left to take its place.
20035 * - @c "vertical" - the current item slides vertically, until it
20036 * gets out of the slideshow's viewport, while the new item comes
20037 * from the bottom to take its place.
20038 * - @c "square" - the new item starts to appear from the middle of
20039 * the current one, but with a tiny size, growing until its
20040 * target (full) size and covering the old one.
20042 * @warning The stringshared strings get no new references
20043 * exclusive to the user grabbing the list, here, so if you'd like
20044 * to use them out of this call's context, you'd better @c
20045 * eina_stringshare_ref() them.
20047 * @see elm_slideshow_transition_set()
20049 * @ingroup Slideshow
20051 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20054 * Set the current slide transition/effect in use for a given
20057 * @param obj The slideshow object
20058 * @param transition The new transition's name string
20060 * If @p transition is implemented in @p obj's theme (i.e., is
20061 * contained in the list returned by
20062 * elm_slideshow_transitions_get()), this new sliding effect will
20063 * be used on the widget.
20065 * @see elm_slideshow_transitions_get() for more details
20067 * @ingroup Slideshow
20069 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20072 * Get the current slide transition/effect in use for a given
20075 * @param obj The slideshow object
20076 * @return The current transition's name
20078 * @see elm_slideshow_transition_set() for more details
20080 * @ingroup Slideshow
20082 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20085 * Set the interval between each image transition on a given
20086 * slideshow widget, <b>and start the slideshow, itself</b>
20088 * @param obj The slideshow object
20089 * @param timeout The new displaying timeout for images
20091 * After this call, the slideshow widget will start cycling its
20092 * view, sequentially and automatically, with the images of the
20093 * items it has. The time between each new image displayed is going
20094 * to be @p timeout, in @b seconds. If a different timeout was set
20095 * previously and an slideshow was in progress, it will continue
20096 * with the new time between transitions, after this call.
20098 * @note A value less than or equal to 0 on @p timeout will disable
20099 * the widget's internal timer, thus halting any slideshow which
20100 * could be happening on @p obj.
20102 * @see elm_slideshow_timeout_get()
20104 * @ingroup Slideshow
20106 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20109 * Get the interval set for image transitions on a given slideshow
20112 * @param obj The slideshow object
20113 * @return Returns the timeout set on it
20115 * @see elm_slideshow_timeout_set() for more details
20117 * @ingroup Slideshow
20119 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20122 * Set if, after a slideshow is started, for a given slideshow
20123 * widget, its items should be displayed cyclically or not.
20125 * @param obj The slideshow object
20126 * @param loop Use @c EINA_TRUE to make it cycle through items or
20127 * @c EINA_FALSE for it to stop at the end of @p obj's internal
20130 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20131 * ignore what is set by this functions, i.e., they'll @b always
20132 * cycle through items. This affects only the "automatic"
20133 * slideshow, as set by elm_slideshow_timeout_set().
20135 * @see elm_slideshow_loop_get()
20137 * @ingroup Slideshow
20139 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20142 * Get if, after a slideshow is started, for a given slideshow
20143 * widget, its items are to be displayed cyclically or not.
20145 * @param obj The slideshow object
20146 * @return @c EINA_TRUE, if the items in @p obj will be cycled
20147 * through or @c EINA_FALSE, otherwise
20149 * @see elm_slideshow_loop_set() for more details
20151 * @ingroup Slideshow
20153 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20156 * Remove all items from a given slideshow widget
20158 * @param obj The slideshow object
20160 * This removes (and deletes) all items in @p obj, leaving it
20163 * @see elm_slideshow_item_del(), to remove just one item.
20165 * @ingroup Slideshow
20167 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20170 * Get the internal list of items in a given slideshow widget.
20172 * @param obj The slideshow object
20173 * @return The list of items (#Elm_Slideshow_Item as data) or
20174 * @c NULL on errors.
20176 * This list is @b not to be modified in any way and must not be
20177 * freed. Use the list members with functions like
20178 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20180 * @warning This list is only valid until @p obj object's internal
20181 * items list is changed. It should be fetched again with another
20182 * call to this function when changes happen.
20184 * @ingroup Slideshow
20186 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20189 * Delete a given item from a slideshow widget.
20191 * @param item The slideshow item
20193 * @ingroup Slideshow
20195 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20198 * Return the data associated with a given slideshow item
20200 * @param item The slideshow item
20201 * @return Returns the data associated to this item
20203 * @ingroup Slideshow
20205 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20208 * Returns the currently displayed item, in a given slideshow widget
20210 * @param obj The slideshow object
20211 * @return A handle to the item being displayed in @p obj or
20212 * @c NULL, if none is (and on errors)
20214 * @ingroup Slideshow
20216 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20219 * Get the real Evas object created to implement the view of a
20220 * given slideshow item
20222 * @param item The slideshow item.
20223 * @return the Evas object implementing this item's view.
20225 * This returns the actual Evas object used to implement the
20226 * specified slideshow item's view. This may be @c NULL, as it may
20227 * not have been created or may have been deleted, at any time, by
20228 * the slideshow. <b>Do not modify this object</b> (move, resize,
20229 * show, hide, etc.), as the slideshow is controlling it. This
20230 * function is for querying, emitting custom signals or hooking
20231 * lower level callbacks for events on that object. Do not delete
20232 * this object under any circumstances.
20234 * @see elm_slideshow_item_data_get()
20236 * @ingroup Slideshow
20238 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20241 * Get the the item, in a given slideshow widget, placed at
20242 * position @p nth, in its internal items list
20244 * @param obj The slideshow object
20245 * @param nth The number of the item to grab a handle to (0 being
20247 * @return The item stored in @p obj at position @p nth or @c NULL,
20248 * if there's no item with that index (and on errors)
20250 * @ingroup Slideshow
20252 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20255 * Set the current slide layout in use for a given slideshow widget
20257 * @param obj The slideshow object
20258 * @param layout The new layout's name string
20260 * If @p layout is implemented in @p obj's theme (i.e., is contained
20261 * in the list returned by elm_slideshow_layouts_get()), this new
20262 * images layout will be used on the widget.
20264 * @see elm_slideshow_layouts_get() for more details
20266 * @ingroup Slideshow
20268 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20271 * Get the current slide layout in use for a given slideshow widget
20273 * @param obj The slideshow object
20274 * @return The current layout's name
20276 * @see elm_slideshow_layout_set() for more details
20278 * @ingroup Slideshow
20280 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20283 * Returns the list of @b layout names available, for a given
20284 * slideshow widget.
20286 * @param obj The slideshow object
20287 * @return The list of layouts (list of @b stringshared strings
20290 * Slideshow layouts will change how the widget is to dispose each
20291 * image item in its viewport, with regard to cropping, scaling,
20294 * The layouts, which come from @p obj's theme, must be an EDC
20295 * data item name @c "layouts" on the theme file, with (prefix)
20296 * names of EDC programs actually implementing them.
20298 * The available layouts for slideshows on the default theme are:
20299 * - @c "fullscreen" - item images with original aspect, scaled to
20300 * touch top and down slideshow borders or, if the image's heigh
20301 * is not enough, left and right slideshow borders.
20302 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20303 * one, but always leaving 10% of the slideshow's dimensions of
20304 * distance between the item image's borders and the slideshow
20305 * borders, for each axis.
20307 * @warning The stringshared strings get no new references
20308 * exclusive to the user grabbing the list, here, so if you'd like
20309 * to use them out of this call's context, you'd better @c
20310 * eina_stringshare_ref() them.
20312 * @see elm_slideshow_layout_set()
20314 * @ingroup Slideshow
20316 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20319 * Set the number of items to cache, on a given slideshow widget,
20320 * <b>before the current item</b>
20322 * @param obj The slideshow object
20323 * @param count Number of items to cache before the current one
20325 * The default value for this property is @c 2. See
20326 * @ref Slideshow_Caching "slideshow caching" for more details.
20328 * @see elm_slideshow_cache_before_get()
20330 * @ingroup Slideshow
20332 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20335 * Retrieve the number of items to cache, on a given slideshow widget,
20336 * <b>before the current item</b>
20338 * @param obj The slideshow object
20339 * @return The number of items set to be cached before the current one
20341 * @see elm_slideshow_cache_before_set() for more details
20343 * @ingroup Slideshow
20345 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20348 * Set the number of items to cache, on a given slideshow widget,
20349 * <b>after the current item</b>
20351 * @param obj The slideshow object
20352 * @param count Number of items to cache after the current one
20354 * The default value for this property is @c 2. See
20355 * @ref Slideshow_Caching "slideshow caching" for more details.
20357 * @see elm_slideshow_cache_after_get()
20359 * @ingroup Slideshow
20361 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20364 * Retrieve the number of items to cache, on a given slideshow widget,
20365 * <b>after the current item</b>
20367 * @param obj The slideshow object
20368 * @return The number of items set to be cached after the current one
20370 * @see elm_slideshow_cache_after_set() for more details
20372 * @ingroup Slideshow
20374 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20377 * Get the number of items stored in a given slideshow widget
20379 * @param obj The slideshow object
20380 * @return The number of items on @p obj, at the moment of this call
20382 * @ingroup Slideshow
20384 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20391 * @defgroup Fileselector File Selector
20393 * @image html img/widget/fileselector/preview-00.png
20394 * @image latex img/widget/fileselector/preview-00.eps
20396 * A file selector is a widget that allows a user to navigate
20397 * through a file system, reporting file selections back via its
20400 * It contains shortcut buttons for home directory (@c ~) and to
20401 * jump one directory upwards (..), as well as cancel/ok buttons to
20402 * confirm/cancel a given selection. After either one of those two
20403 * former actions, the file selector will issue its @c "done" smart
20406 * There's a text entry on it, too, showing the name of the current
20407 * selection. There's the possibility of making it editable, so it
20408 * is useful on file saving dialogs on applications, where one
20409 * gives a file name to save contents to, in a given directory in
20410 * the system. This custom file name will be reported on the @c
20411 * "done" smart callback (explained in sequence).
20413 * Finally, it has a view to display file system items into in two
20418 * If Elementary is built with support of the Ethumb thumbnailing
20419 * library, the second form of view will display preview thumbnails
20420 * of files which it supports.
20422 * Smart callbacks one can register to:
20424 * - @c "selected" - the user has clicked on a file (when not in
20425 * folders-only mode) or directory (when in folders-only mode)
20426 * - @c "directory,open" - the list has been populated with new
20427 * content (@c event_info is a pointer to the directory's
20428 * path, a @b stringshared string)
20429 * - @c "done" - the user has clicked on the "ok" or "cancel"
20430 * buttons (@c event_info is a pointer to the selection's
20431 * path, a @b stringshared string)
20433 * Here is an example on its usage:
20434 * @li @ref fileselector_example
20438 * @addtogroup Fileselector
20443 * Defines how a file selector widget is to layout its contents
20444 * (file system entries).
20446 typedef enum _Elm_Fileselector_Mode
20448 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20449 ELM_FILESELECTOR_GRID, /**< layout as a grid */
20450 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20451 } Elm_Fileselector_Mode;
20454 * Add a new file selector widget to the given parent Elementary
20455 * (container) object
20457 * @param parent The parent object
20458 * @return a new file selector widget handle or @c NULL, on errors
20460 * This function inserts a new file selector widget on the canvas.
20462 * @ingroup Fileselector
20464 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20467 * Enable/disable the file name entry box where the user can type
20468 * in a name for a file, in a given file selector widget
20470 * @param obj The file selector object
20471 * @param is_save @c EINA_TRUE to make the file selector a "saving
20472 * dialog", @c EINA_FALSE otherwise
20474 * Having the entry editable is useful on file saving dialogs on
20475 * applications, where one gives a file name to save contents to,
20476 * in a given directory in the system. This custom file name will
20477 * be reported on the @c "done" smart callback.
20479 * @see elm_fileselector_is_save_get()
20481 * @ingroup Fileselector
20483 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20486 * Get whether the given file selector is in "saving dialog" mode
20488 * @param obj The file selector object
20489 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20490 * mode, @c EINA_FALSE otherwise (and on errors)
20492 * @see elm_fileselector_is_save_set() for more details
20494 * @ingroup Fileselector
20496 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20499 * Enable/disable folder-only view for a given file selector widget
20501 * @param obj The file selector object
20502 * @param only @c EINA_TRUE to make @p obj only display
20503 * directories, @c EINA_FALSE to make files to be displayed in it
20506 * If enabled, the widget's view will only display folder items,
20509 * @see elm_fileselector_folder_only_get()
20511 * @ingroup Fileselector
20513 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20516 * Get whether folder-only view is set for a given file selector
20519 * @param obj The file selector object
20520 * @return only @c EINA_TRUE if @p obj is only displaying
20521 * directories, @c EINA_FALSE if files are being displayed in it
20522 * too (and on errors)
20524 * @see elm_fileselector_folder_only_get()
20526 * @ingroup Fileselector
20528 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20531 * Enable/disable the "ok" and "cancel" buttons on a given file
20534 * @param obj The file selector object
20535 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
20537 * @note A file selector without those buttons will never emit the
20538 * @c "done" smart event, and is only usable if one is just hooking
20539 * to the other two events.
20541 * @see elm_fileselector_buttons_ok_cancel_get()
20543 * @ingroup Fileselector
20545 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
20548 * Get whether the "ok" and "cancel" buttons on a given file
20549 * selector widget are being shown.
20551 * @param obj The file selector object
20552 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
20553 * otherwise (and on errors)
20555 * @see elm_fileselector_buttons_ok_cancel_set() for more details
20557 * @ingroup Fileselector
20559 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20562 * Enable/disable a tree view in the given file selector widget,
20563 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
20565 * @param obj The file selector object
20566 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
20569 * In a tree view, arrows are created on the sides of directories,
20570 * allowing them to expand in place.
20572 * @note If it's in other mode, the changes made by this function
20573 * will only be visible when one switches back to "list" mode.
20575 * @see elm_fileselector_expandable_get()
20577 * @ingroup Fileselector
20579 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
20582 * Get whether tree view is enabled for the given file selector
20585 * @param obj The file selector object
20586 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
20587 * otherwise (and or errors)
20589 * @see elm_fileselector_expandable_set() for more details
20591 * @ingroup Fileselector
20593 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20596 * Set, programmatically, the @b directory that a given file
20597 * selector widget will display contents from
20599 * @param obj The file selector object
20600 * @param path The path to display in @p obj
20602 * This will change the @b directory that @p obj is displaying. It
20603 * will also clear the text entry area on the @p obj object, which
20604 * displays select files' names.
20606 * @see elm_fileselector_path_get()
20608 * @ingroup Fileselector
20610 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20613 * Get the parent directory's path that a given file selector
20614 * widget is displaying
20616 * @param obj The file selector object
20617 * @return The (full) path of the directory the file selector is
20618 * displaying, a @b stringshared string
20620 * @see elm_fileselector_path_set()
20622 * @ingroup Fileselector
20624 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20627 * Set, programmatically, the currently selected file/directory in
20628 * the given file selector widget
20630 * @param obj The file selector object
20631 * @param path The (full) path to a file or directory
20632 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
20633 * latter case occurs if the directory or file pointed to do not
20636 * @see elm_fileselector_selected_get()
20638 * @ingroup Fileselector
20640 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20643 * Get the currently selected item's (full) path, in the given file
20646 * @param obj The file selector object
20647 * @return The absolute path of the selected item, a @b
20648 * stringshared string
20650 * @note Custom editions on @p obj object's text entry, if made,
20651 * will appear on the return string of this function, naturally.
20653 * @see elm_fileselector_selected_set() for more details
20655 * @ingroup Fileselector
20657 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20660 * Set the mode in which a given file selector widget will display
20661 * (layout) file system entries in its view
20663 * @param obj The file selector object
20664 * @param mode The mode of the fileselector, being it one of
20665 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
20666 * first one, naturally, will display the files in a list. The
20667 * latter will make the widget to display its entries in a grid
20670 * @note By using elm_fileselector_expandable_set(), the user may
20671 * trigger a tree view for that list.
20673 * @note If Elementary is built with support of the Ethumb
20674 * thumbnailing library, the second form of view will display
20675 * preview thumbnails of files which it supports. You must have
20676 * elm_need_ethumb() called in your Elementary for thumbnailing to
20679 * @see elm_fileselector_expandable_set().
20680 * @see elm_fileselector_mode_get().
20682 * @ingroup Fileselector
20684 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
20687 * Get the mode in which a given file selector widget is displaying
20688 * (layouting) file system entries in its view
20690 * @param obj The fileselector object
20691 * @return The mode in which the fileselector is at
20693 * @see elm_fileselector_mode_set() for more details
20695 * @ingroup Fileselector
20697 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20704 * @defgroup Progressbar Progress bar
20706 * The progress bar is a widget for visually representing the
20707 * progress status of a given job/task.
20709 * A progress bar may be horizontal or vertical. It may display an
20710 * icon besides it, as well as primary and @b units labels. The
20711 * former is meant to label the widget as a whole, while the
20712 * latter, which is formatted with floating point values (and thus
20713 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
20714 * units"</c>), is meant to label the widget's <b>progress
20715 * value</b>. Label, icon and unit strings/objects are @b optional
20716 * for progress bars.
20718 * A progress bar may be @b inverted, in which state it gets its
20719 * values inverted, with high values being on the left or top and
20720 * low values on the right or bottom, as opposed to normally have
20721 * the low values on the former and high values on the latter,
20722 * respectively, for horizontal and vertical modes.
20724 * The @b span of the progress, as set by
20725 * elm_progressbar_span_size_set(), is its length (horizontally or
20726 * vertically), unless one puts size hints on the widget to expand
20727 * on desired directions, by any container. That length will be
20728 * scaled by the object or applications scaling factor. At any
20729 * point code can query the progress bar for its value with
20730 * elm_progressbar_value_get().
20732 * Available widget styles for progress bars:
20734 * - @c "wheel" (simple style, no text, no progression, only
20735 * "pulse" effect is available)
20737 * Default contents parts of the progressbar widget that you can use for are:
20738 * @li "elm.swallow.content" - A icon of the progressbar
20740 * Here is an example on its usage:
20741 * @li @ref progressbar_example
20745 * Add a new progress bar widget to the given parent Elementary
20746 * (container) object
20748 * @param parent The parent object
20749 * @return a new progress bar widget handle or @c NULL, on errors
20751 * This function inserts a new progress bar widget on the canvas.
20753 * @ingroup Progressbar
20755 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20758 * Set whether a given progress bar widget is at "pulsing mode" or
20761 * @param obj The progress bar object
20762 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
20763 * @c EINA_FALSE to put it back to its default one
20765 * By default, progress bars will display values from the low to
20766 * high value boundaries. There are, though, contexts in which the
20767 * state of progression of a given task is @b unknown. For those,
20768 * one can set a progress bar widget to a "pulsing state", to give
20769 * the user an idea that some computation is being held, but
20770 * without exact progress values. In the default theme it will
20771 * animate its bar with the contents filling in constantly and back
20772 * to non-filled, in a loop. To start and stop this pulsing
20773 * animation, one has to explicitly call elm_progressbar_pulse().
20775 * @see elm_progressbar_pulse_get()
20776 * @see elm_progressbar_pulse()
20778 * @ingroup Progressbar
20780 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
20783 * Get whether a given progress bar widget is at "pulsing mode" or
20786 * @param obj The progress bar object
20787 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
20788 * if it's in the default one (and on errors)
20790 * @ingroup Progressbar
20792 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20795 * Start/stop a given progress bar "pulsing" animation, if its
20798 * @param obj The progress bar object
20799 * @param state @c EINA_TRUE, to @b start the pulsing animation,
20800 * @c EINA_FALSE to @b stop it
20802 * @note This call won't do anything if @p obj is not under "pulsing mode".
20804 * @see elm_progressbar_pulse_set() for more details.
20806 * @ingroup Progressbar
20808 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
20811 * Set the progress value (in percentage) on a given progress bar
20814 * @param obj The progress bar object
20815 * @param val The progress value (@b must be between @c 0.0 and @c
20818 * Use this call to set progress bar levels.
20820 * @note If you passes a value out of the specified range for @p
20821 * val, it will be interpreted as the @b closest of the @b boundary
20822 * values in the range.
20824 * @ingroup Progressbar
20826 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
20829 * Get the progress value (in percentage) on a given progress bar
20832 * @param obj The progress bar object
20833 * @return The value of the progressbar
20835 * @see elm_progressbar_value_set() for more details
20837 * @ingroup Progressbar
20839 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20842 * Set the label of a given progress bar widget
20844 * @param obj The progress bar object
20845 * @param label The text label string, in UTF-8
20847 * @ingroup Progressbar
20848 * @deprecated use elm_object_text_set() instead.
20850 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20853 * Get the label of a given progress bar widget
20855 * @param obj The progressbar object
20856 * @return The text label string, in UTF-8
20858 * @ingroup Progressbar
20859 * @deprecated use elm_object_text_set() instead.
20861 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20864 * Set the icon object of a given progress bar widget
20866 * @param obj The progress bar object
20867 * @param icon The icon object
20869 * Use this call to decorate @p obj with an icon next to it.
20871 * @note Once the icon object is set, a previously set one will be
20872 * deleted. If you want to keep that old content object, use the
20873 * elm_progressbar_icon_unset() function.
20875 * @see elm_progressbar_icon_get()
20876 * @deprecated use elm_object_content_set() instead.
20878 * @ingroup Progressbar
20880 EINA_DEPRECATED EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20883 * Retrieve the icon object set for a given progress bar widget
20885 * @param obj The progress bar object
20886 * @return The icon object's handle, if @p obj had one set, or @c NULL,
20887 * otherwise (and on errors)
20889 * @see elm_progressbar_icon_set() for more details
20890 * @deprecated use elm_object_content_set() instead.
20892 * @ingroup Progressbar
20894 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20897 * Unset an icon set on a given progress bar widget
20899 * @param obj The progress bar object
20900 * @return The icon object that was being used, if any was set, or
20901 * @c NULL, otherwise (and on errors)
20903 * This call will unparent and return the icon object which was set
20904 * for this widget, previously, on success.
20906 * @see elm_progressbar_icon_set() for more details
20907 * @deprecated use elm_object_content_unset() instead.
20909 * @ingroup Progressbar
20911 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20914 * Set the (exact) length of the bar region of a given progress bar
20917 * @param obj The progress bar object
20918 * @param size The length of the progress bar's bar region
20920 * This sets the minimum width (when in horizontal mode) or height
20921 * (when in vertical mode) of the actual bar area of the progress
20922 * bar @p obj. This in turn affects the object's minimum size. Use
20923 * this when you're not setting other size hints expanding on the
20924 * given direction (like weight and alignment hints) and you would
20925 * like it to have a specific size.
20927 * @note Icon, label and unit text around @p obj will require their
20928 * own space, which will make @p obj to require more the @p size,
20931 * @see elm_progressbar_span_size_get()
20933 * @ingroup Progressbar
20935 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
20938 * Get the length set for the bar region of a given progress bar
20941 * @param obj The progress bar object
20942 * @return The length of the progress bar's bar region
20944 * If that size was not set previously, with
20945 * elm_progressbar_span_size_set(), this call will return @c 0.
20947 * @ingroup Progressbar
20949 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20952 * Set the format string for a given progress bar widget's units
20955 * @param obj The progress bar object
20956 * @param format The format string for @p obj's units label
20958 * If @c NULL is passed on @p format, it will make @p obj's units
20959 * area to be hidden completely. If not, it'll set the <b>format
20960 * string</b> for the units label's @b text. The units label is
20961 * provided a floating point value, so the units text is up display
20962 * at most one floating point falue. Note that the units label is
20963 * optional. Use a format string such as "%1.2f meters" for
20966 * @note The default format string for a progress bar is an integer
20967 * percentage, as in @c "%.0f %%".
20969 * @see elm_progressbar_unit_format_get()
20971 * @ingroup Progressbar
20973 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
20976 * Retrieve the format string set for a given progress bar widget's
20979 * @param obj The progress bar object
20980 * @return The format set string for @p obj's units label or
20981 * @c NULL, if none was set (and on errors)
20983 * @see elm_progressbar_unit_format_set() for more details
20985 * @ingroup Progressbar
20987 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20990 * Set the orientation of a given progress bar widget
20992 * @param obj The progress bar object
20993 * @param horizontal Use @c EINA_TRUE to make @p obj to be
20994 * @b horizontal, @c EINA_FALSE to make it @b vertical
20996 * Use this function to change how your progress bar is to be
20997 * disposed: vertically or horizontally.
20999 * @see elm_progressbar_horizontal_get()
21001 * @ingroup Progressbar
21003 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21006 * Retrieve the orientation of a given progress bar widget
21008 * @param obj The progress bar object
21009 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21010 * @c EINA_FALSE if it's @b vertical (and on errors)
21012 * @see elm_progressbar_horizontal_set() for more details
21014 * @ingroup Progressbar
21016 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21019 * Invert a given progress bar widget's displaying values order
21021 * @param obj The progress bar object
21022 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21023 * @c EINA_FALSE to bring it back to default, non-inverted values.
21025 * A progress bar may be @b inverted, in which state it gets its
21026 * values inverted, with high values being on the left or top and
21027 * low values on the right or bottom, as opposed to normally have
21028 * the low values on the former and high values on the latter,
21029 * respectively, for horizontal and vertical modes.
21031 * @see elm_progressbar_inverted_get()
21033 * @ingroup Progressbar
21035 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21038 * Get whether a given progress bar widget's displaying values are
21041 * @param obj The progress bar object
21042 * @return @c EINA_TRUE, if @p obj has inverted values,
21043 * @c EINA_FALSE otherwise (and on errors)
21045 * @see elm_progressbar_inverted_set() for more details
21047 * @ingroup Progressbar
21049 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21052 * @defgroup Separator Separator
21054 * @brief Separator is a very thin object used to separate other objects.
21056 * A separator can be vertical or horizontal.
21058 * @ref tutorial_separator is a good example of how to use a separator.
21062 * @brief Add a separator object to @p parent
21064 * @param parent The parent object
21066 * @return The separator object, or NULL upon failure
21068 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21070 * @brief Set the horizontal mode of a separator object
21072 * @param obj The separator object
21073 * @param horizontal If true, the separator is horizontal
21075 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21077 * @brief Get the horizontal mode of a separator object
21079 * @param obj The separator object
21080 * @return If true, the separator is horizontal
21082 * @see elm_separator_horizontal_set()
21084 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21090 * @defgroup Spinner Spinner
21091 * @ingroup Elementary
21093 * @image html img/widget/spinner/preview-00.png
21094 * @image latex img/widget/spinner/preview-00.eps
21096 * A spinner is a widget which allows the user to increase or decrease
21097 * numeric values using arrow buttons, or edit values directly, clicking
21098 * over it and typing the new value.
21100 * By default the spinner will not wrap and has a label
21101 * of "%.0f" (just showing the integer value of the double).
21103 * A spinner has a label that is formatted with floating
21104 * point values and thus accepts a printf-style format string, like
21107 * It also allows specific values to be replaced by pre-defined labels.
21109 * Smart callbacks one can register to:
21111 * - "changed" - Whenever the spinner value is changed.
21112 * - "delay,changed" - A short time after the value is changed by the user.
21113 * This will be called only when the user stops dragging for a very short
21114 * period or when they release their finger/mouse, so it avoids possibly
21115 * expensive reactions to the value change.
21117 * Available styles for it:
21119 * - @c "vertical": up/down buttons at the right side and text left aligned.
21121 * Here is an example on its usage:
21122 * @ref spinner_example
21126 * @addtogroup Spinner
21131 * Add a new spinner widget to the given parent Elementary
21132 * (container) object.
21134 * @param parent The parent object.
21135 * @return a new spinner widget handle or @c NULL, on errors.
21137 * This function inserts a new spinner widget on the canvas.
21142 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21145 * Set the format string of the displayed label.
21147 * @param obj The spinner object.
21148 * @param fmt The format string for the label display.
21150 * If @c NULL, this sets the format to "%.0f". If not it sets the format
21151 * string for the label text. The label text is provided a floating point
21152 * value, so the label text can display up to 1 floating point value.
21153 * Note that this is optional.
21155 * Use a format string such as "%1.2f meters" for example, and it will
21156 * display values like: "3.14 meters" for a value equal to 3.14159.
21158 * Default is "%0.f".
21160 * @see elm_spinner_label_format_get()
21164 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21167 * Get the label format of the spinner.
21169 * @param obj The spinner object.
21170 * @return The text label format string in UTF-8.
21172 * @see elm_spinner_label_format_set() for details.
21176 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21179 * Set the minimum and maximum values for the spinner.
21181 * @param obj The spinner object.
21182 * @param min The minimum value.
21183 * @param max The maximum value.
21185 * Define the allowed range of values to be selected by the user.
21187 * If actual value is less than @p min, it will be updated to @p min. If it
21188 * is bigger then @p max, will be updated to @p max. Actual value can be
21189 * get with elm_spinner_value_get().
21191 * By default, min is equal to 0, and max is equal to 100.
21193 * @warning Maximum must be greater than minimum.
21195 * @see elm_spinner_min_max_get()
21199 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21202 * Get the minimum and maximum values of the spinner.
21204 * @param obj The spinner object.
21205 * @param min Pointer where to store the minimum value.
21206 * @param max Pointer where to store the maximum value.
21208 * @note If only one value is needed, the other pointer can be passed
21211 * @see elm_spinner_min_max_set() for details.
21215 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21218 * Set the step used to increment or decrement the spinner value.
21220 * @param obj The spinner object.
21221 * @param step The step value.
21223 * This value will be incremented or decremented to the displayed value.
21224 * It will be incremented while the user keep right or top arrow pressed,
21225 * and will be decremented while the user keep left or bottom arrow pressed.
21227 * The interval to increment / decrement can be set with
21228 * elm_spinner_interval_set().
21230 * By default step value is equal to 1.
21232 * @see elm_spinner_step_get()
21236 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21239 * Get the step used to increment or decrement the spinner value.
21241 * @param obj The spinner object.
21242 * @return The step value.
21244 * @see elm_spinner_step_get() for more details.
21248 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21251 * Set the value the spinner displays.
21253 * @param obj The spinner object.
21254 * @param val The value to be displayed.
21256 * Value will be presented on the label following format specified with
21257 * elm_spinner_format_set().
21259 * @warning The value must to be between min and max values. This values
21260 * are set by elm_spinner_min_max_set().
21262 * @see elm_spinner_value_get().
21263 * @see elm_spinner_format_set().
21264 * @see elm_spinner_min_max_set().
21268 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21271 * Get the value displayed by the spinner.
21273 * @param obj The spinner object.
21274 * @return The value displayed.
21276 * @see elm_spinner_value_set() for details.
21280 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21283 * Set whether the spinner should wrap when it reaches its
21284 * minimum or maximum value.
21286 * @param obj The spinner object.
21287 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21290 * Disabled by default. If disabled, when the user tries to increment the
21292 * but displayed value plus step value is bigger than maximum value,
21294 * won't allow it. The same happens when the user tries to decrement it,
21295 * but the value less step is less than minimum value.
21297 * When wrap is enabled, in such situations it will allow these changes,
21298 * but will get the value that would be less than minimum and subtracts
21299 * from maximum. Or add the value that would be more than maximum to
21303 * @li min value = 10
21304 * @li max value = 50
21305 * @li step value = 20
21306 * @li displayed value = 20
21308 * When the user decrement value (using left or bottom arrow), it will
21309 * displays @c 40, because max - (min - (displayed - step)) is
21310 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21312 * @see elm_spinner_wrap_get().
21316 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21319 * Get whether the spinner should wrap when it reaches its
21320 * minimum or maximum value.
21322 * @param obj The spinner object
21323 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21324 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21326 * @see elm_spinner_wrap_set() for details.
21330 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21333 * Set whether the spinner can be directly edited by the user or not.
21335 * @param obj The spinner object.
21336 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21337 * don't allow users to edit it directly.
21339 * Spinner objects can have edition @b disabled, in which state they will
21340 * be changed only by arrows.
21341 * Useful for contexts
21342 * where you don't want your users to interact with it writting the value.
21344 * when using special values, the user can see real value instead
21345 * of special label on edition.
21347 * It's enabled by default.
21349 * @see elm_spinner_editable_get()
21353 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21356 * Get whether the spinner can be directly edited by the user or not.
21358 * @param obj The spinner object.
21359 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21360 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21362 * @see elm_spinner_editable_set() for details.
21366 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21369 * Set a special string to display in the place of the numerical value.
21371 * @param obj The spinner object.
21372 * @param value The value to be replaced.
21373 * @param label The label to be used.
21375 * It's useful for cases when a user should select an item that is
21376 * better indicated by a label than a value. For example, weekdays or months.
21380 * sp = elm_spinner_add(win);
21381 * elm_spinner_min_max_set(sp, 1, 3);
21382 * elm_spinner_special_value_add(sp, 1, "January");
21383 * elm_spinner_special_value_add(sp, 2, "February");
21384 * elm_spinner_special_value_add(sp, 3, "March");
21385 * evas_object_show(sp);
21390 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21393 * Set the interval on time updates for an user mouse button hold
21394 * on spinner widgets' arrows.
21396 * @param obj The spinner object.
21397 * @param interval The (first) interval value in seconds.
21399 * This interval value is @b decreased while the user holds the
21400 * mouse pointer either incrementing or decrementing spinner's value.
21402 * This helps the user to get to a given value distant from the
21403 * current one easier/faster, as it will start to change quicker and
21404 * quicker on mouse button holds.
21406 * The calculation for the next change interval value, starting from
21407 * the one set with this call, is the previous interval divided by
21408 * @c 1.05, so it decreases a little bit.
21410 * The default starting interval value for automatic changes is
21413 * @see elm_spinner_interval_get()
21417 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21420 * Get the interval on time updates for an user mouse button hold
21421 * on spinner widgets' arrows.
21423 * @param obj The spinner object.
21424 * @return The (first) interval value, in seconds, set on it.
21426 * @see elm_spinner_interval_set() for more details.
21430 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21437 * @defgroup Index Index
21439 * @image html img/widget/index/preview-00.png
21440 * @image latex img/widget/index/preview-00.eps
21442 * An index widget gives you an index for fast access to whichever
21443 * group of other UI items one might have. It's a list of text
21444 * items (usually letters, for alphabetically ordered access).
21446 * Index widgets are by default hidden and just appear when the
21447 * user clicks over it's reserved area in the canvas. In its
21448 * default theme, it's an area one @ref Fingers "finger" wide on
21449 * the right side of the index widget's container.
21451 * When items on the index are selected, smart callbacks get
21452 * called, so that its user can make other container objects to
21453 * show a given area or child object depending on the index item
21454 * selected. You'd probably be using an index together with @ref
21455 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21458 * Smart events one can add callbacks for are:
21459 * - @c "changed" - When the selected index item changes. @c
21460 * event_info is the selected item's data pointer.
21461 * - @c "delay,changed" - When the selected index item changes, but
21462 * after a small idling period. @c event_info is the selected
21463 * item's data pointer.
21464 * - @c "selected" - When the user releases a mouse button and
21465 * selects an item. @c event_info is the selected item's data
21467 * - @c "level,up" - when the user moves a finger from the first
21468 * level to the second level
21469 * - @c "level,down" - when the user moves a finger from the second
21470 * level to the first level
21472 * The @c "delay,changed" event is so that it'll wait a small time
21473 * before actually reporting those events and, moreover, just the
21474 * last event happening on those time frames will actually be
21477 * Here are some examples on its usage:
21478 * @li @ref index_example_01
21479 * @li @ref index_example_02
21483 * @addtogroup Index
21487 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21490 * Add a new index widget to the given parent Elementary
21491 * (container) object
21493 * @param parent The parent object
21494 * @return a new index widget handle or @c NULL, on errors
21496 * This function inserts a new index widget on the canvas.
21500 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21503 * Set whether a given index widget is or not visible,
21506 * @param obj The index object
21507 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21509 * Not to be confused with visible as in @c evas_object_show() --
21510 * visible with regard to the widget's auto hiding feature.
21512 * @see elm_index_active_get()
21516 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21519 * Get whether a given index widget is currently visible or not.
21521 * @param obj The index object
21522 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21524 * @see elm_index_active_set() for more details
21528 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21531 * Set the items level for a given index widget.
21533 * @param obj The index object.
21534 * @param level @c 0 or @c 1, the currently implemented levels.
21536 * @see elm_index_item_level_get()
21540 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21543 * Get the items level set for a given index widget.
21545 * @param obj The index object.
21546 * @return @c 0 or @c 1, which are the levels @p obj might be at.
21548 * @see elm_index_item_level_set() for more information
21552 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21555 * Returns the last selected item's data, for a given index widget.
21557 * @param obj The index object.
21558 * @return The item @b data associated to the last selected item on
21559 * @p obj (or @c NULL, on errors).
21561 * @warning The returned value is @b not an #Elm_Index_Item item
21562 * handle, but the data associated to it (see the @c item parameter
21563 * in elm_index_item_append(), as an example).
21567 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21570 * Append a new item on a given index widget.
21572 * @param obj The index object.
21573 * @param letter Letter under which the item should be indexed
21574 * @param item The item data to set for the index's item
21576 * Despite the most common usage of the @p letter argument is for
21577 * single char strings, one could use arbitrary strings as index
21580 * @c item will be the pointer returned back on @c "changed", @c
21581 * "delay,changed" and @c "selected" smart events.
21585 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21588 * Prepend a new item on a given index widget.
21590 * @param obj The index object.
21591 * @param letter Letter under which the item should be indexed
21592 * @param item The item data to set for the index's item
21594 * Despite the most common usage of the @p letter argument is for
21595 * single char strings, one could use arbitrary strings as index
21598 * @c item will be the pointer returned back on @c "changed", @c
21599 * "delay,changed" and @c "selected" smart events.
21603 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21606 * Append a new item, on a given index widget, <b>after the item
21607 * having @p relative as data</b>.
21609 * @param obj The index object.
21610 * @param letter Letter under which the item should be indexed
21611 * @param item The item data to set for the index's item
21612 * @param relative The item data of the index item to be the
21613 * predecessor of this new one
21615 * Despite the most common usage of the @p letter argument is for
21616 * single char strings, one could use arbitrary strings as index
21619 * @c item will be the pointer returned back on @c "changed", @c
21620 * "delay,changed" and @c "selected" smart events.
21622 * @note If @p relative is @c NULL or if it's not found to be data
21623 * set on any previous item on @p obj, this function will behave as
21624 * elm_index_item_append().
21628 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21631 * Prepend a new item, on a given index widget, <b>after the item
21632 * having @p relative as data</b>.
21634 * @param obj The index object.
21635 * @param letter Letter under which the item should be indexed
21636 * @param item The item data to set for the index's item
21637 * @param relative The item data of the index item to be the
21638 * successor of this new one
21640 * Despite the most common usage of the @p letter argument is for
21641 * single char strings, one could use arbitrary strings as index
21644 * @c item will be the pointer returned back on @c "changed", @c
21645 * "delay,changed" and @c "selected" smart events.
21647 * @note If @p relative is @c NULL or if it's not found to be data
21648 * set on any previous item on @p obj, this function will behave as
21649 * elm_index_item_prepend().
21653 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21656 * Insert a new item into the given index widget, using @p cmp_func
21657 * function to sort items (by item handles).
21659 * @param obj The index object.
21660 * @param letter Letter under which the item should be indexed
21661 * @param item The item data to set for the index's item
21662 * @param cmp_func The comparing function to be used to sort index
21663 * items <b>by #Elm_Index_Item item handles</b>
21664 * @param cmp_data_func A @b fallback function to be called for the
21665 * sorting of index items <b>by item data</b>). It will be used
21666 * when @p cmp_func returns @c 0 (equality), which means an index
21667 * item with provided item data already exists. To decide which
21668 * data item should be pointed to by the index item in question, @p
21669 * cmp_data_func will be used. If @p cmp_data_func returns a
21670 * non-negative value, the previous index item data will be
21671 * replaced by the given @p item pointer. If the previous data need
21672 * to be freed, it should be done by the @p cmp_data_func function,
21673 * because all references to it will be lost. If this function is
21674 * not provided (@c NULL is given), index items will be @b
21675 * duplicated, if @p cmp_func returns @c 0.
21677 * Despite the most common usage of the @p letter argument is for
21678 * single char strings, one could use arbitrary strings as index
21681 * @c item will be the pointer returned back on @c "changed", @c
21682 * "delay,changed" and @c "selected" smart events.
21686 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);
21689 * Remove an item from a given index widget, <b>to be referenced by
21690 * it's data value</b>.
21692 * @param obj The index object
21693 * @param item The item's data pointer for the item to be removed
21696 * If a deletion callback is set, via elm_index_item_del_cb_set(),
21697 * that callback function will be called by this one.
21699 * @warning The item to be removed from @p obj will be found via
21700 * its item data pointer, and not by an #Elm_Index_Item handle.
21704 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21707 * Find a given index widget's item, <b>using item data</b>.
21709 * @param obj The index object
21710 * @param item The item data pointed to by the desired index item
21711 * @return The index item handle, if found, or @c NULL otherwise
21715 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21718 * Removes @b all items from a given index widget.
21720 * @param obj The index object.
21722 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
21723 * that callback function will be called for each item in @p obj.
21727 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21730 * Go to a given items level on a index widget
21732 * @param obj The index object
21733 * @param level The index level (one of @c 0 or @c 1)
21737 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21740 * Return the data associated with a given index widget item
21742 * @param it The index widget item handle
21743 * @return The data associated with @p it
21745 * @see elm_index_item_data_set()
21749 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21752 * Set the data associated with a given index widget item
21754 * @param it The index widget item handle
21755 * @param data The new data pointer to set to @p it
21757 * This sets new item data on @p it.
21759 * @warning The old data pointer won't be touched by this function, so
21760 * the user had better to free that old data himself/herself.
21764 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
21767 * Set the function to be called when a given index widget item is freed.
21769 * @param it The item to set the callback on
21770 * @param func The function to call on the item's deletion
21772 * When called, @p func will have both @c data and @c event_info
21773 * arguments with the @p it item's data value and, naturally, the
21774 * @c obj argument with a handle to the parent index widget.
21778 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
21781 * Get the letter (string) set on a given index widget item.
21783 * @param it The index item handle
21784 * @return The letter string set on @p it
21788 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21792 EAPI void elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
21799 * @defgroup Photocam Photocam
21801 * @image html img/widget/photocam/preview-00.png
21802 * @image latex img/widget/photocam/preview-00.eps
21804 * This is a widget specifically for displaying high-resolution digital
21805 * camera photos giving speedy feedback (fast load), low memory footprint
21806 * and zooming and panning as well as fitting logic. It is entirely focused
21807 * on jpeg images, and takes advantage of properties of the jpeg format (via
21808 * evas loader features in the jpeg loader).
21810 * Signals that you can add callbacks for are:
21811 * @li "clicked" - This is called when a user has clicked the photo without
21813 * @li "press" - This is called when a user has pressed down on the photo.
21814 * @li "longpressed" - This is called when a user has pressed down on the
21815 * photo for a long time without dragging around.
21816 * @li "clicked,double" - This is called when a user has double-clicked the
21818 * @li "load" - Photo load begins.
21819 * @li "loaded" - This is called when the image file load is complete for the
21820 * first view (low resolution blurry version).
21821 * @li "load,detail" - Photo detailed data load begins.
21822 * @li "loaded,detail" - This is called when the image file load is complete
21823 * for the detailed image data (full resolution needed).
21824 * @li "zoom,start" - Zoom animation started.
21825 * @li "zoom,stop" - Zoom animation stopped.
21826 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
21827 * @li "scroll" - the content has been scrolled (moved)
21828 * @li "scroll,anim,start" - scrolling animation has started
21829 * @li "scroll,anim,stop" - scrolling animation has stopped
21830 * @li "scroll,drag,start" - dragging the contents around has started
21831 * @li "scroll,drag,stop" - dragging the contents around has stopped
21833 * @ref tutorial_photocam shows the API in action.
21837 * @brief Types of zoom available.
21839 typedef enum _Elm_Photocam_Zoom_Mode
21841 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
21842 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
21843 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
21844 ELM_PHOTOCAM_ZOOM_MODE_LAST
21845 } Elm_Photocam_Zoom_Mode;
21847 * @brief Add a new Photocam object
21849 * @param parent The parent object
21850 * @return The new object or NULL if it cannot be created
21852 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21854 * @brief Set the photo file to be shown
21856 * @param obj The photocam object
21857 * @param file The photo file
21858 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
21860 * This sets (and shows) the specified file (with a relative or absolute
21861 * path) and will return a load error (same error that
21862 * evas_object_image_load_error_get() will return). The image will change and
21863 * adjust its size at this point and begin a background load process for this
21864 * photo that at some time in the future will be displayed at the full
21867 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
21869 * @brief Returns the path of the current image file
21871 * @param obj The photocam object
21872 * @return Returns the path
21874 * @see elm_photocam_file_set()
21876 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21878 * @brief Set the zoom level of the photo
21880 * @param obj The photocam object
21881 * @param zoom The zoom level to set
21883 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
21884 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
21885 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
21886 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
21889 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
21891 * @brief Get the zoom level of the photo
21893 * @param obj The photocam object
21894 * @return The current zoom level
21896 * This returns the current zoom level of the photocam object. Note that if
21897 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
21898 * (which is the default), the zoom level may be changed at any time by the
21899 * photocam object itself to account for photo size and photocam viewpoer
21902 * @see elm_photocam_zoom_set()
21903 * @see elm_photocam_zoom_mode_set()
21905 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21907 * @brief Set the zoom mode
21909 * @param obj The photocam object
21910 * @param mode The desired mode
21912 * This sets the zoom mode to manual or one of several automatic levels.
21913 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
21914 * elm_photocam_zoom_set() and will stay at that level until changed by code
21915 * or until zoom mode is changed. This is the default mode. The Automatic
21916 * modes will allow the photocam object to automatically adjust zoom mode
21917 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
21918 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
21919 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
21920 * pixels within the frame are left unfilled.
21922 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
21924 * @brief Get the zoom mode
21926 * @param obj The photocam object
21927 * @return The current zoom mode
21929 * This gets the current zoom mode of the photocam object.
21931 * @see elm_photocam_zoom_mode_set()
21933 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21935 * @brief Get the current image pixel width and height
21937 * @param obj The photocam object
21938 * @param w A pointer to the width return
21939 * @param h A pointer to the height return
21941 * This gets the current photo pixel width and height (for the original).
21942 * The size will be returned in the integers @p w and @p h that are pointed
21945 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
21947 * @brief Get the area of the image that is currently shown
21950 * @param x A pointer to the X-coordinate of region
21951 * @param y A pointer to the Y-coordinate of region
21952 * @param w A pointer to the width
21953 * @param h A pointer to the height
21955 * @see elm_photocam_image_region_show()
21956 * @see elm_photocam_image_region_bring_in()
21958 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
21960 * @brief Set the viewed portion of the image
21962 * @param obj The photocam object
21963 * @param x X-coordinate of region in image original pixels
21964 * @param y Y-coordinate of region in image original pixels
21965 * @param w Width of region in image original pixels
21966 * @param h Height of region in image original pixels
21968 * This shows the region of the image without using animation.
21970 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
21972 * @brief Bring in the viewed portion of the image
21974 * @param obj The photocam object
21975 * @param x X-coordinate of region in image original pixels
21976 * @param y Y-coordinate of region in image original pixels
21977 * @param w Width of region in image original pixels
21978 * @param h Height of region in image original pixels
21980 * This shows the region of the image using animation.
21982 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
21984 * @brief Set the paused state for photocam
21986 * @param obj The photocam object
21987 * @param paused The pause state to set
21989 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
21990 * photocam. The default is off. This will stop zooming using animation on
21991 * zoom levels changes and change instantly. This will stop any existing
21992 * animations that are running.
21994 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21996 * @brief Get the paused state for photocam
21998 * @param obj The photocam object
21999 * @return The current paused state
22001 * This gets the current paused state for the photocam object.
22003 * @see elm_photocam_paused_set()
22005 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22007 * @brief Get the internal low-res image used for photocam
22009 * @param obj The photocam object
22010 * @return The internal image object handle, or NULL if none exists
22012 * This gets the internal image object inside photocam. Do not modify it. It
22013 * is for inspection only, and hooking callbacks to. Nothing else. It may be
22014 * deleted at any time as well.
22016 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22018 * @brief Set the photocam scrolling bouncing.
22020 * @param obj The photocam object
22021 * @param h_bounce bouncing for horizontal
22022 * @param v_bounce bouncing for vertical
22024 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22026 * @brief Get the photocam scrolling bouncing.
22028 * @param obj The photocam object
22029 * @param h_bounce bouncing for horizontal
22030 * @param v_bounce bouncing for vertical
22032 * @see elm_photocam_bounce_set()
22034 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22040 * @defgroup Map Map
22041 * @ingroup Elementary
22043 * @image html img/widget/map/preview-00.png
22044 * @image latex img/widget/map/preview-00.eps
22046 * This is a widget specifically for displaying a map. It uses basically
22047 * OpenStreetMap provider http://www.openstreetmap.org/,
22048 * but custom providers can be added.
22050 * It supports some basic but yet nice features:
22051 * @li zoom and scroll
22052 * @li markers with content to be displayed when user clicks over it
22053 * @li group of markers
22056 * Smart callbacks one can listen to:
22058 * - "clicked" - This is called when a user has clicked the map without
22060 * - "press" - This is called when a user has pressed down on the map.
22061 * - "longpressed" - This is called when a user has pressed down on the map
22062 * for a long time without dragging around.
22063 * - "clicked,double" - This is called when a user has double-clicked
22065 * - "load,detail" - Map detailed data load begins.
22066 * - "loaded,detail" - This is called when all currently visible parts of
22067 * the map are loaded.
22068 * - "zoom,start" - Zoom animation started.
22069 * - "zoom,stop" - Zoom animation stopped.
22070 * - "zoom,change" - Zoom changed when using an auto zoom mode.
22071 * - "scroll" - the content has been scrolled (moved).
22072 * - "scroll,anim,start" - scrolling animation has started.
22073 * - "scroll,anim,stop" - scrolling animation has stopped.
22074 * - "scroll,drag,start" - dragging the contents around has started.
22075 * - "scroll,drag,stop" - dragging the contents around has stopped.
22076 * - "downloaded" - This is called when all currently required map images
22078 * - "route,load" - This is called when route request begins.
22079 * - "route,loaded" - This is called when route request ends.
22080 * - "name,load" - This is called when name request begins.
22081 * - "name,loaded- This is called when name request ends.
22083 * Available style for map widget:
22086 * Available style for markers:
22091 * Available style for marker bubble:
22094 * List of examples:
22095 * @li @ref map_example_01
22096 * @li @ref map_example_02
22097 * @li @ref map_example_03
22106 * @enum _Elm_Map_Zoom_Mode
22107 * @typedef Elm_Map_Zoom_Mode
22109 * Set map's zoom behavior. It can be set to manual or automatic.
22111 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22113 * Values <b> don't </b> work as bitmask, only one can be choosen.
22115 * @note Valid sizes are 2^zoom, consequently the map may be smaller
22116 * than the scroller view.
22118 * @see elm_map_zoom_mode_set()
22119 * @see elm_map_zoom_mode_get()
22123 typedef enum _Elm_Map_Zoom_Mode
22125 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22126 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22127 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22128 ELM_MAP_ZOOM_MODE_LAST
22129 } Elm_Map_Zoom_Mode;
22132 * @enum _Elm_Map_Route_Sources
22133 * @typedef Elm_Map_Route_Sources
22135 * Set route service to be used. By default used source is
22136 * #ELM_MAP_ROUTE_SOURCE_YOURS.
22138 * @see elm_map_route_source_set()
22139 * @see elm_map_route_source_get()
22143 typedef enum _Elm_Map_Route_Sources
22145 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22146 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. */
22147 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22148 ELM_MAP_ROUTE_SOURCE_LAST
22149 } Elm_Map_Route_Sources;
22151 typedef enum _Elm_Map_Name_Sources
22153 ELM_MAP_NAME_SOURCE_NOMINATIM,
22154 ELM_MAP_NAME_SOURCE_LAST
22155 } Elm_Map_Name_Sources;
22158 * @enum _Elm_Map_Route_Type
22159 * @typedef Elm_Map_Route_Type
22161 * Set type of transport used on route.
22163 * @see elm_map_route_add()
22167 typedef enum _Elm_Map_Route_Type
22169 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22170 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22171 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22172 ELM_MAP_ROUTE_TYPE_LAST
22173 } Elm_Map_Route_Type;
22176 * @enum _Elm_Map_Route_Method
22177 * @typedef Elm_Map_Route_Method
22179 * Set the routing method, what should be priorized, time or distance.
22181 * @see elm_map_route_add()
22185 typedef enum _Elm_Map_Route_Method
22187 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22188 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22189 ELM_MAP_ROUTE_METHOD_LAST
22190 } Elm_Map_Route_Method;
22192 typedef enum _Elm_Map_Name_Method
22194 ELM_MAP_NAME_METHOD_SEARCH,
22195 ELM_MAP_NAME_METHOD_REVERSE,
22196 ELM_MAP_NAME_METHOD_LAST
22197 } Elm_Map_Name_Method;
22199 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(). */
22200 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(). */
22201 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(). */
22202 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(). */
22203 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
22204 typedef struct _Elm_Map_Track Elm_Map_Track;
22206 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. */
22207 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22208 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22209 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22211 typedef char *(*ElmMapModuleSourceFunc) (void);
22212 typedef int (*ElmMapModuleZoomMinFunc) (void);
22213 typedef int (*ElmMapModuleZoomMaxFunc) (void);
22214 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22215 typedef int (*ElmMapModuleRouteSourceFunc) (void);
22216 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22217 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22218 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22219 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22222 * Add a new map widget to the given parent Elementary (container) object.
22224 * @param parent The parent object.
22225 * @return a new map widget handle or @c NULL, on errors.
22227 * This function inserts a new map widget on the canvas.
22231 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22234 * Set the zoom level of the map.
22236 * @param obj The map object.
22237 * @param zoom The zoom level to set.
22239 * This sets the zoom level.
22241 * It will respect limits defined by elm_map_source_zoom_min_set() and
22242 * elm_map_source_zoom_max_set().
22244 * By default these values are 0 (world map) and 18 (maximum zoom).
22246 * This function should be used when zoom mode is set to
22247 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22248 * with elm_map_zoom_mode_set().
22250 * @see elm_map_zoom_mode_set().
22251 * @see elm_map_zoom_get().
22255 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22258 * Get the zoom level of the map.
22260 * @param obj The map object.
22261 * @return The current zoom level.
22263 * This returns the current zoom level of the map object.
22265 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22266 * (which is the default), the zoom level may be changed at any time by the
22267 * map object itself to account for map size and map viewport size.
22269 * @see elm_map_zoom_set() for details.
22273 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22276 * Set the zoom mode used by the map object.
22278 * @param obj The map object.
22279 * @param mode The zoom mode of the map, being it one of
22280 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22281 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22283 * This sets the zoom mode to manual or one of the automatic levels.
22284 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22285 * elm_map_zoom_set() and will stay at that level until changed by code
22286 * or until zoom mode is changed. This is the default mode.
22288 * The Automatic modes will allow the map object to automatically
22289 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22290 * adjust zoom so the map fits inside the scroll frame with no pixels
22291 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22292 * ensure no pixels within the frame are left unfilled. Do not forget that
22293 * the valid sizes are 2^zoom, consequently the map may be smaller than
22294 * the scroller view.
22296 * @see elm_map_zoom_set()
22300 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22303 * Get the zoom mode used by the map object.
22305 * @param obj The map object.
22306 * @return The zoom mode of the map, being it one of
22307 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22308 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22310 * This function returns the current zoom mode used by the map object.
22312 * @see elm_map_zoom_mode_set() for more details.
22316 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22319 * Get the current coordinates of the map.
22321 * @param obj The map object.
22322 * @param lon Pointer where to store longitude.
22323 * @param lat Pointer where to store latitude.
22325 * This gets the current center coordinates of the map object. It can be
22326 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22328 * @see elm_map_geo_region_bring_in()
22329 * @see elm_map_geo_region_show()
22333 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22336 * Animatedly bring in given coordinates to the center of the map.
22338 * @param obj The map object.
22339 * @param lon Longitude to center at.
22340 * @param lat Latitude to center at.
22342 * This causes map to jump to the given @p lat and @p lon coordinates
22343 * and show it (by scrolling) in the center of the viewport, if it is not
22344 * already centered. This will use animation to do so and take a period
22345 * of time to complete.
22347 * @see elm_map_geo_region_show() for a function to avoid animation.
22348 * @see elm_map_geo_region_get()
22352 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22355 * Show the given coordinates at the center of the map, @b immediately.
22357 * @param obj The map object.
22358 * @param lon Longitude to center at.
22359 * @param lat Latitude to center at.
22361 * This causes map to @b redraw its viewport's contents to the
22362 * region contining the given @p lat and @p lon, that will be moved to the
22363 * center of the map.
22365 * @see elm_map_geo_region_bring_in() for a function to move with animation.
22366 * @see elm_map_geo_region_get()
22370 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22373 * Pause or unpause the map.
22375 * @param obj The map object.
22376 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22379 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22382 * The default is off.
22384 * This will stop zooming using animation, changing zoom levels will
22385 * change instantly. This will stop any existing animations that are running.
22387 * @see elm_map_paused_get()
22391 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22394 * Get a value whether map is paused or not.
22396 * @param obj The map object.
22397 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22398 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22400 * This gets the current paused state for the map object.
22402 * @see elm_map_paused_set() for details.
22406 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22409 * Set to show markers during zoom level changes or not.
22411 * @param obj The map object.
22412 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22415 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22418 * The default is off.
22420 * This will stop zooming using animation, changing zoom levels will
22421 * change instantly. This will stop any existing animations that are running.
22423 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22426 * The default is off.
22428 * Enabling it will force the map to stop displaying the markers during
22429 * zoom level changes. Set to on if you have a large number of markers.
22431 * @see elm_map_paused_markers_get()
22435 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22438 * Get a value whether markers will be displayed on zoom level changes or not
22440 * @param obj The map object.
22441 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22442 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22444 * This gets the current markers paused state for the map object.
22446 * @see elm_map_paused_markers_set() for details.
22450 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22453 * Get the information of downloading status.
22455 * @param obj The map object.
22456 * @param try_num Pointer where to store number of tiles being downloaded.
22457 * @param finish_num Pointer where to store number of tiles successfully
22460 * This gets the current downloading status for the map object, the number
22461 * of tiles being downloaded and the number of tiles already downloaded.
22465 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22468 * Convert a pixel coordinate (x,y) into a geographic coordinate
22469 * (longitude, latitude).
22471 * @param obj The map object.
22472 * @param x the coordinate.
22473 * @param y the coordinate.
22474 * @param size the size in pixels of the map.
22475 * The map is a square and generally his size is : pow(2.0, zoom)*256.
22476 * @param lon Pointer where to store the longitude that correspond to x.
22477 * @param lat Pointer where to store the latitude that correspond to y.
22479 * @note Origin pixel point is the top left corner of the viewport.
22480 * Map zoom and size are taken on account.
22482 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22486 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);
22489 * Convert a geographic coordinate (longitude, latitude) into a pixel
22490 * coordinate (x, y).
22492 * @param obj The map object.
22493 * @param lon the longitude.
22494 * @param lat the latitude.
22495 * @param size the size in pixels of the map. The map is a square
22496 * and generally his size is : pow(2.0, zoom)*256.
22497 * @param x Pointer where to store the horizontal pixel coordinate that
22498 * correspond to the longitude.
22499 * @param y Pointer where to store the vertical pixel coordinate that
22500 * correspond to the latitude.
22502 * @note Origin pixel point is the top left corner of the viewport.
22503 * Map zoom and size are taken on account.
22505 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22509 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);
22512 * Convert a geographic coordinate (longitude, latitude) into a name
22515 * @param obj The map object.
22516 * @param lon the longitude.
22517 * @param lat the latitude.
22518 * @return name A #Elm_Map_Name handle for this coordinate.
22520 * To get the string for this address, elm_map_name_address_get()
22523 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
22527 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22530 * Convert a name (address) into a geographic coordinate
22531 * (longitude, latitude).
22533 * @param obj The map object.
22534 * @param name The address.
22535 * @return name A #Elm_Map_Name handle for this address.
22537 * To get the longitude and latitude, elm_map_name_region_get()
22540 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
22544 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
22547 * Convert a pixel coordinate into a rotated pixel coordinate.
22549 * @param obj The map object.
22550 * @param x horizontal coordinate of the point to rotate.
22551 * @param y vertical coordinate of the point to rotate.
22552 * @param cx rotation's center horizontal position.
22553 * @param cy rotation's center vertical position.
22554 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
22555 * @param xx Pointer where to store rotated x.
22556 * @param yy Pointer where to store rotated y.
22560 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);
22563 * Add a new marker to the map object.
22565 * @param obj The map object.
22566 * @param lon The longitude of the marker.
22567 * @param lat The latitude of the marker.
22568 * @param clas The class, to use when marker @b isn't grouped to others.
22569 * @param clas_group The class group, to use when marker is grouped to others
22570 * @param data The data passed to the callbacks.
22572 * @return The created marker or @c NULL upon failure.
22574 * A marker will be created and shown in a specific point of the map, defined
22575 * by @p lon and @p lat.
22577 * It will be displayed using style defined by @p class when this marker
22578 * is displayed alone (not grouped). A new class can be created with
22579 * elm_map_marker_class_new().
22581 * If the marker is grouped to other markers, it will be displayed with
22582 * style defined by @p class_group. Markers with the same group are grouped
22583 * if they are close. A new group class can be created with
22584 * elm_map_marker_group_class_new().
22586 * Markers created with this method can be deleted with
22587 * elm_map_marker_remove().
22589 * A marker can have associated content to be displayed by a bubble,
22590 * when a user click over it, as well as an icon. These objects will
22591 * be fetch using class' callback functions.
22593 * @see elm_map_marker_class_new()
22594 * @see elm_map_marker_group_class_new()
22595 * @see elm_map_marker_remove()
22599 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);
22602 * Set the maximum numbers of markers' content to be displayed in a group.
22604 * @param obj The map object.
22605 * @param max The maximum numbers of items displayed in a bubble.
22607 * A bubble will be displayed when the user clicks over the group,
22608 * and will place the content of markers that belong to this group
22611 * A group can have a long list of markers, consequently the creation
22612 * of the content of the bubble can be very slow.
22614 * In order to avoid this, a maximum number of items is displayed
22617 * By default this number is 30.
22619 * Marker with the same group class are grouped if they are close.
22621 * @see elm_map_marker_add()
22625 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
22628 * Remove a marker from the map.
22630 * @param marker The marker to remove.
22632 * @see elm_map_marker_add()
22636 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22639 * Get the current coordinates of the marker.
22641 * @param marker marker.
22642 * @param lat Pointer where to store the marker's latitude.
22643 * @param lon Pointer where to store the marker's longitude.
22645 * These values are set when adding markers, with function
22646 * elm_map_marker_add().
22648 * @see elm_map_marker_add()
22652 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
22655 * Animatedly bring in given marker to the center of the map.
22657 * @param marker The marker to center at.
22659 * This causes map to jump to the given @p marker's coordinates
22660 * and show it (by scrolling) in the center of the viewport, if it is not
22661 * already centered. This will use animation to do so and take a period
22662 * of time to complete.
22664 * @see elm_map_marker_show() for a function to avoid animation.
22665 * @see elm_map_marker_region_get()
22669 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22672 * Show the given marker at the center of the map, @b immediately.
22674 * @param marker The marker to center at.
22676 * This causes map to @b redraw its viewport's contents to the
22677 * region contining the given @p marker's coordinates, that will be
22678 * moved to the center of the map.
22680 * @see elm_map_marker_bring_in() for a function to move with animation.
22681 * @see elm_map_markers_list_show() if more than one marker need to be
22683 * @see elm_map_marker_region_get()
22687 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22690 * Move and zoom the map to display a list of markers.
22692 * @param markers A list of #Elm_Map_Marker handles.
22694 * The map will be centered on the center point of the markers in the list.
22695 * Then the map will be zoomed in order to fit the markers using the maximum
22696 * zoom which allows display of all the markers.
22698 * @warning All the markers should belong to the same map object.
22700 * @see elm_map_marker_show() to show a single marker.
22701 * @see elm_map_marker_bring_in()
22705 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
22708 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
22710 * @param marker The marker wich content should be returned.
22711 * @return Return the evas object if it exists, else @c NULL.
22713 * To set callback function #ElmMapMarkerGetFunc for the marker class,
22714 * elm_map_marker_class_get_cb_set() should be used.
22716 * This content is what will be inside the bubble that will be displayed
22717 * when an user clicks over the marker.
22719 * This returns the actual Evas object used to be placed inside
22720 * the bubble. This may be @c NULL, as it may
22721 * not have been created or may have been deleted, at any time, by
22722 * the map. <b>Do not modify this object</b> (move, resize,
22723 * show, hide, etc.), as the map is controlling it. This
22724 * function is for querying, emitting custom signals or hooking
22725 * lower level callbacks for events on that object. Do not delete
22726 * this object under any circumstances.
22730 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22733 * Update the marker
22735 * @param marker The marker to be updated.
22737 * If a content is set to this marker, it will call function to delete it,
22738 * #ElmMapMarkerDelFunc, and then will fetch the content again with
22739 * #ElmMapMarkerGetFunc.
22741 * These functions are set for the marker class with
22742 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
22746 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22749 * Close all the bubbles opened by the user.
22751 * @param obj The map object.
22753 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
22754 * when the user clicks on a marker.
22756 * This functions is set for the marker class with
22757 * elm_map_marker_class_get_cb_set().
22761 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
22764 * Create a new group class.
22766 * @param obj The map object.
22767 * @return Returns the new group class.
22769 * Each marker must be associated to a group class. Markers in the same
22770 * group are grouped if they are close.
22772 * The group class defines the style of the marker when a marker is grouped
22773 * to others markers. When it is alone, another class will be used.
22775 * A group class will need to be provided when creating a marker with
22776 * elm_map_marker_add().
22778 * Some properties and functions can be set by class, as:
22779 * - style, with elm_map_group_class_style_set()
22780 * - data - to be associated to the group class. It can be set using
22781 * elm_map_group_class_data_set().
22782 * - min zoom to display markers, set with
22783 * elm_map_group_class_zoom_displayed_set().
22784 * - max zoom to group markers, set using
22785 * elm_map_group_class_zoom_grouped_set().
22786 * - visibility - set if markers will be visible or not, set with
22787 * elm_map_group_class_hide_set().
22788 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
22789 * It can be set using elm_map_group_class_icon_cb_set().
22791 * @see elm_map_marker_add()
22792 * @see elm_map_group_class_style_set()
22793 * @see elm_map_group_class_data_set()
22794 * @see elm_map_group_class_zoom_displayed_set()
22795 * @see elm_map_group_class_zoom_grouped_set()
22796 * @see elm_map_group_class_hide_set()
22797 * @see elm_map_group_class_icon_cb_set()
22801 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
22804 * Set the marker's style of a group class.
22806 * @param clas The group class.
22807 * @param style The style to be used by markers.
22809 * Each marker must be associated to a group class, and will use the style
22810 * defined by such class when grouped to other markers.
22812 * The following styles are provided by default theme:
22813 * @li @c radio - blue circle
22814 * @li @c radio2 - green circle
22817 * @see elm_map_group_class_new() for more details.
22818 * @see elm_map_marker_add()
22822 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
22825 * Set the icon callback function of a group class.
22827 * @param clas The group class.
22828 * @param icon_get The callback function that will return the icon.
22830 * Each marker must be associated to a group class, and it can display a
22831 * custom icon. The function @p icon_get must return this icon.
22833 * @see elm_map_group_class_new() for more details.
22834 * @see elm_map_marker_add()
22838 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
22841 * Set the data associated to the group class.
22843 * @param clas The group class.
22844 * @param data The new user data.
22846 * This data will be passed for callback functions, like icon get callback,
22847 * that can be set with elm_map_group_class_icon_cb_set().
22849 * If a data was previously set, the object will lose the pointer for it,
22850 * so if needs to be freed, you must do it yourself.
22852 * @see elm_map_group_class_new() for more details.
22853 * @see elm_map_group_class_icon_cb_set()
22854 * @see elm_map_marker_add()
22858 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
22861 * Set the minimum zoom from where the markers are displayed.
22863 * @param clas The group class.
22864 * @param zoom The minimum zoom.
22866 * Markers only will be displayed when the map is displayed at @p zoom
22869 * @see elm_map_group_class_new() for more details.
22870 * @see elm_map_marker_add()
22874 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
22877 * Set the zoom from where the markers are no more grouped.
22879 * @param clas The group class.
22880 * @param zoom The maximum zoom.
22882 * Markers only will be grouped when the map is displayed at
22883 * less than @p zoom.
22885 * @see elm_map_group_class_new() for more details.
22886 * @see elm_map_marker_add()
22890 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
22893 * Set if the markers associated to the group class @clas are hidden or not.
22895 * @param clas The group class.
22896 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
22899 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
22904 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
22907 * Create a new marker class.
22909 * @param obj The map object.
22910 * @return Returns the new group class.
22912 * Each marker must be associated to a class.
22914 * The marker class defines the style of the marker when a marker is
22915 * displayed alone, i.e., not grouped to to others markers. When grouped
22916 * it will use group class style.
22918 * A marker class will need to be provided when creating a marker with
22919 * elm_map_marker_add().
22921 * Some properties and functions can be set by class, as:
22922 * - style, with elm_map_marker_class_style_set()
22923 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
22924 * It can be set using elm_map_marker_class_icon_cb_set().
22925 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
22926 * Set using elm_map_marker_class_get_cb_set().
22927 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
22928 * Set using elm_map_marker_class_del_cb_set().
22930 * @see elm_map_marker_add()
22931 * @see elm_map_marker_class_style_set()
22932 * @see elm_map_marker_class_icon_cb_set()
22933 * @see elm_map_marker_class_get_cb_set()
22934 * @see elm_map_marker_class_del_cb_set()
22938 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
22941 * Set the marker's style of a marker class.
22943 * @param clas The marker class.
22944 * @param style The style to be used by markers.
22946 * Each marker must be associated to a marker class, and will use the style
22947 * defined by such class when alone, i.e., @b not grouped to other markers.
22949 * The following styles are provided by default theme:
22954 * @see elm_map_marker_class_new() for more details.
22955 * @see elm_map_marker_add()
22959 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
22962 * Set the icon callback function of a marker class.
22964 * @param clas The marker class.
22965 * @param icon_get The callback function that will return the icon.
22967 * Each marker must be associated to a marker class, and it can display a
22968 * custom icon. The function @p icon_get must return this icon.
22970 * @see elm_map_marker_class_new() for more details.
22971 * @see elm_map_marker_add()
22975 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
22978 * Set the bubble content callback function of a marker class.
22980 * @param clas The marker class.
22981 * @param get The callback function that will return the content.
22983 * Each marker must be associated to a marker class, and it can display a
22984 * a content on a bubble that opens when the user click over the marker.
22985 * The function @p get must return this content object.
22987 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
22990 * @see elm_map_marker_class_new() for more details.
22991 * @see elm_map_marker_class_del_cb_set()
22992 * @see elm_map_marker_add()
22996 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
22999 * Set the callback function used to delete bubble content of a marker class.
23001 * @param clas The marker class.
23002 * @param del The callback function that will delete the content.
23004 * Each marker must be associated to a marker class, and it can display a
23005 * a content on a bubble that opens when the user click over the marker.
23006 * The function to return such content can be set with
23007 * elm_map_marker_class_get_cb_set().
23009 * If this content must be freed, a callback function need to be
23010 * set for that task with this function.
23012 * If this callback is defined it will have to delete (or not) the
23013 * object inside, but if the callback is not defined the object will be
23014 * destroyed with evas_object_del().
23016 * @see elm_map_marker_class_new() for more details.
23017 * @see elm_map_marker_class_get_cb_set()
23018 * @see elm_map_marker_add()
23022 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23025 * Get the list of available sources.
23027 * @param obj The map object.
23028 * @return The source names list.
23030 * It will provide a list with all available sources, that can be set as
23031 * current source with elm_map_source_name_set(), or get with
23032 * elm_map_source_name_get().
23034 * Available sources:
23040 * @see elm_map_source_name_set() for more details.
23041 * @see elm_map_source_name_get()
23045 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23048 * Set the source of the map.
23050 * @param obj The map object.
23051 * @param source The source to be used.
23053 * Map widget retrieves images that composes the map from a web service.
23054 * This web service can be set with this method.
23056 * A different service can return a different maps with different
23057 * information and it can use different zoom values.
23059 * The @p source_name need to match one of the names provided by
23060 * elm_map_source_names_get().
23062 * The current source can be get using elm_map_source_name_get().
23064 * @see elm_map_source_names_get()
23065 * @see elm_map_source_name_get()
23070 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23073 * Get the name of currently used source.
23075 * @param obj The map object.
23076 * @return Returns the name of the source in use.
23078 * @see elm_map_source_name_set() for more details.
23082 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23085 * Set the source of the route service to be used by the map.
23087 * @param obj The map object.
23088 * @param source The route service to be used, being it one of
23089 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23090 * and #ELM_MAP_ROUTE_SOURCE_ORS.
23092 * Each one has its own algorithm, so the route retrieved may
23093 * differ depending on the source route. Now, only the default is working.
23095 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23096 * http://www.yournavigation.org/.
23098 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23099 * assumptions. Its routing core is based on Contraction Hierarchies.
23101 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23103 * @see elm_map_route_source_get().
23107 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23110 * Get the current route source.
23112 * @param obj The map object.
23113 * @return The source of the route service used by the map.
23115 * @see elm_map_route_source_set() for details.
23119 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23122 * Set the minimum zoom of the source.
23124 * @param obj The map object.
23125 * @param zoom New minimum zoom value to be used.
23127 * By default, it's 0.
23131 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23134 * Get the minimum zoom of the source.
23136 * @param obj The map object.
23137 * @return Returns the minimum zoom of the source.
23139 * @see elm_map_source_zoom_min_set() for details.
23143 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23146 * Set the maximum zoom of the source.
23148 * @param obj The map object.
23149 * @param zoom New maximum zoom value to be used.
23151 * By default, it's 18.
23155 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23158 * Get the maximum zoom of the source.
23160 * @param obj The map object.
23161 * @return Returns the maximum zoom of the source.
23163 * @see elm_map_source_zoom_min_set() for details.
23167 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23170 * Set the user agent used by the map object to access routing services.
23172 * @param obj The map object.
23173 * @param user_agent The user agent to be used by the map.
23175 * User agent is a client application implementing a network protocol used
23176 * in communications within a client–server distributed computing system
23178 * The @p user_agent identification string will transmitted in a header
23179 * field @c User-Agent.
23181 * @see elm_map_user_agent_get()
23185 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23188 * Get the user agent used by the map object.
23190 * @param obj The map object.
23191 * @return The user agent identification string used by the map.
23193 * @see elm_map_user_agent_set() for details.
23197 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23200 * Add a new route to the map object.
23202 * @param obj The map object.
23203 * @param type The type of transport to be considered when tracing a route.
23204 * @param method The routing method, what should be priorized.
23205 * @param flon The start longitude.
23206 * @param flat The start latitude.
23207 * @param tlon The destination longitude.
23208 * @param tlat The destination latitude.
23210 * @return The created route or @c NULL upon failure.
23212 * A route will be traced by point on coordinates (@p flat, @p flon)
23213 * to point on coordinates (@p tlat, @p tlon), using the route service
23214 * set with elm_map_route_source_set().
23216 * It will take @p type on consideration to define the route,
23217 * depending if the user will be walking or driving, the route may vary.
23218 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23219 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23221 * Another parameter is what the route should priorize, the minor distance
23222 * or the less time to be spend on the route. So @p method should be one
23223 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23225 * Routes created with this method can be deleted with
23226 * elm_map_route_remove(), colored with elm_map_route_color_set(),
23227 * and distance can be get with elm_map_route_distance_get().
23229 * @see elm_map_route_remove()
23230 * @see elm_map_route_color_set()
23231 * @see elm_map_route_distance_get()
23232 * @see elm_map_route_source_set()
23236 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);
23239 * Remove a route from the map.
23241 * @param route The route to remove.
23243 * @see elm_map_route_add()
23247 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23250 * Set the route color.
23252 * @param route The route object.
23253 * @param r Red channel value, from 0 to 255.
23254 * @param g Green channel value, from 0 to 255.
23255 * @param b Blue channel value, from 0 to 255.
23256 * @param a Alpha channel value, from 0 to 255.
23258 * It uses an additive color model, so each color channel represents
23259 * how much of each primary colors must to be used. 0 represents
23260 * ausence of this color, so if all of the three are set to 0,
23261 * the color will be black.
23263 * These component values should be integers in the range 0 to 255,
23264 * (single 8-bit byte).
23266 * This sets the color used for the route. By default, it is set to
23267 * solid red (r = 255, g = 0, b = 0, a = 255).
23269 * For alpha channel, 0 represents completely transparent, and 255, opaque.
23271 * @see elm_map_route_color_get()
23275 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23278 * Get the route color.
23280 * @param route The route object.
23281 * @param r Pointer where to store the red channel value.
23282 * @param g Pointer where to store the green channel value.
23283 * @param b Pointer where to store the blue channel value.
23284 * @param a Pointer where to store the alpha channel value.
23286 * @see elm_map_route_color_set() for details.
23290 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23293 * Get the route distance in kilometers.
23295 * @param route The route object.
23296 * @return The distance of route (unit : km).
23300 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23303 * Get the information of route nodes.
23305 * @param route The route object.
23306 * @return Returns a string with the nodes of route.
23310 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23313 * Get the information of route waypoint.
23315 * @param route the route object.
23316 * @return Returns a string with information about waypoint of route.
23320 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23323 * Get the address of the name.
23325 * @param name The name handle.
23326 * @return Returns the address string of @p name.
23328 * This gets the coordinates of the @p name, created with one of the
23329 * conversion functions.
23331 * @see elm_map_utils_convert_name_into_coord()
23332 * @see elm_map_utils_convert_coord_into_name()
23336 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23339 * Get the current coordinates of the name.
23341 * @param name The name handle.
23342 * @param lat Pointer where to store the latitude.
23343 * @param lon Pointer where to store The longitude.
23345 * This gets the coordinates of the @p name, created with one of the
23346 * conversion functions.
23348 * @see elm_map_utils_convert_name_into_coord()
23349 * @see elm_map_utils_convert_coord_into_name()
23353 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23356 * Remove a name from the map.
23358 * @param name The name to remove.
23360 * Basically the struct handled by @p name will be freed, so convertions
23361 * between address and coordinates will be lost.
23363 * @see elm_map_utils_convert_name_into_coord()
23364 * @see elm_map_utils_convert_coord_into_name()
23368 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23373 * @param obj The map object.
23374 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23375 * @param cx Rotation's center horizontal position.
23376 * @param cy Rotation's center vertical position.
23378 * @see elm_map_rotate_get()
23382 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23385 * Get the rotate degree of the map
23387 * @param obj The map object
23388 * @param degree Pointer where to store degrees from 0.0 to 360.0
23389 * to rotate arount Z axis.
23390 * @param cx Pointer where to store rotation's center horizontal position.
23391 * @param cy Pointer where to store rotation's center vertical position.
23393 * @see elm_map_rotate_set() to set map rotation.
23397 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);
23400 * Enable or disable mouse wheel to be used to zoom in / out the map.
23402 * @param obj The map object.
23403 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23406 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23408 * It's disabled by default.
23410 * @see elm_map_wheel_disabled_get()
23414 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23417 * Get a value whether mouse wheel is enabled or not.
23419 * @param obj The map object.
23420 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23421 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23423 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23425 * @see elm_map_wheel_disabled_set() for details.
23429 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23433 * Add a track on the map
23435 * @param obj The map object.
23436 * @param emap The emap route object.
23437 * @return The route object. This is an elm object of type Route.
23439 * @see elm_route_add() for details.
23443 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23447 * Remove a track from the map
23449 * @param obj The map object.
23450 * @param route The track to remove.
23454 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23461 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23463 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23465 EAPI double elm_route_lon_min_get(Evas_Object *obj);
23466 EAPI double elm_route_lat_min_get(Evas_Object *obj);
23467 EAPI double elm_route_lon_max_get(Evas_Object *obj);
23468 EAPI double elm_route_lat_max_get(Evas_Object *obj);
23472 * @defgroup Panel Panel
23474 * @image html img/widget/panel/preview-00.png
23475 * @image latex img/widget/panel/preview-00.eps
23477 * @brief A panel is a type of animated container that contains subobjects.
23478 * It can be expanded or contracted by clicking the button on it's edge.
23480 * Orientations are as follows:
23481 * @li ELM_PANEL_ORIENT_TOP
23482 * @li ELM_PANEL_ORIENT_LEFT
23483 * @li ELM_PANEL_ORIENT_RIGHT
23485 * To set/get/unset the content of the panel, you can use
23486 * elm_object_content_set/get/unset APIs.
23487 * Once the content object is set, a previously set one will be deleted.
23488 * If you want to keep that old content object, use the
23489 * elm_object_content_unset() function
23491 * @ref tutorial_panel shows one way to use this widget.
23494 typedef enum _Elm_Panel_Orient
23496 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23497 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23498 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23499 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23500 } Elm_Panel_Orient;
23502 * @brief Adds a panel object
23504 * @param parent The parent object
23506 * @return The panel object, or NULL on failure
23508 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23510 * @brief Sets the orientation of the panel
23512 * @param parent The parent object
23513 * @param orient The panel orientation. Can be one of the following:
23514 * @li ELM_PANEL_ORIENT_TOP
23515 * @li ELM_PANEL_ORIENT_LEFT
23516 * @li ELM_PANEL_ORIENT_RIGHT
23518 * Sets from where the panel will (dis)appear.
23520 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
23522 * @brief Get the orientation of the panel.
23524 * @param obj The panel object
23525 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
23527 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23529 * @brief Set the content of the panel.
23531 * @param obj The panel object
23532 * @param content The panel content
23534 * Once the content object is set, a previously set one will be deleted.
23535 * If you want to keep that old content object, use the
23536 * elm_panel_content_unset() function.
23538 EINA_DEPRECATED EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23540 * @brief Get the content of the panel.
23542 * @param obj The panel object
23543 * @return The content that is being used
23545 * Return the content object which is set for this widget.
23547 * @see elm_panel_content_set()
23549 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23551 * @brief Unset the content of the panel.
23553 * @param obj The panel object
23554 * @return The content that was being used
23556 * Unparent and return the content object which was set for this widget.
23558 * @see elm_panel_content_set()
23560 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23562 * @brief Set the state of the panel.
23564 * @param obj The panel object
23565 * @param hidden If true, the panel will run the animation to contract
23567 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
23569 * @brief Get the state of the panel.
23571 * @param obj The panel object
23572 * @param hidden If true, the panel is in the "hide" state
23574 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23576 * @brief Toggle the hidden state of the panel from code
23578 * @param obj The panel object
23580 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
23586 * @defgroup Panes Panes
23587 * @ingroup Elementary
23589 * @image html img/widget/panes/preview-00.png
23590 * @image latex img/widget/panes/preview-00.eps width=\textwidth
23592 * @image html img/panes.png
23593 * @image latex img/panes.eps width=\textwidth
23595 * The panes adds a dragable bar between two contents. When dragged
23596 * this bar will resize contents size.
23598 * Panes can be displayed vertically or horizontally, and contents
23599 * size proportion can be customized (homogeneous by default).
23601 * Smart callbacks one can listen to:
23602 * - "press" - The panes has been pressed (button wasn't released yet).
23603 * - "unpressed" - The panes was released after being pressed.
23604 * - "clicked" - The panes has been clicked>
23605 * - "clicked,double" - The panes has been double clicked
23607 * Available styles for it:
23610 * Default contents parts of the panes widget that you can use for are:
23611 * @li "elm.swallow.left" - A leftside content of the panes
23612 * @li "elm.swallow.right" - A rightside content of the panes
23614 * If panes is displayed vertically, left content will be displayed at
23617 * Here is an example on its usage:
23618 * @li @ref panes_example
23621 #define ELM_PANES_CONTENT_LEFT "elm.swallow.left"
23622 #define ELM_PANES_CONTENT_RIGHT "elm.swallow.right"
23625 * @addtogroup Panes
23630 * Add a new panes widget to the given parent Elementary
23631 * (container) object.
23633 * @param parent The parent object.
23634 * @return a new panes widget handle or @c NULL, on errors.
23636 * This function inserts a new panes widget on the canvas.
23640 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23643 * Set the left content of the panes widget.
23645 * @param obj The panes object.
23646 * @param content The new left content object.
23648 * Once the content object is set, a previously set one will be deleted.
23649 * If you want to keep that old content object, use the
23650 * elm_panes_content_left_unset() function.
23652 * If panes is displayed vertically, left content will be displayed at
23655 * @see elm_panes_content_left_get()
23656 * @see elm_panes_content_right_set() to set content on the other side.
23660 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23663 * Set the right content of the panes widget.
23665 * @param obj The panes object.
23666 * @param content The new right content object.
23668 * Once the content object is set, a previously set one will be deleted.
23669 * If you want to keep that old content object, use the
23670 * elm_panes_content_right_unset() function.
23672 * If panes is displayed vertically, left content will be displayed at
23675 * @see elm_panes_content_right_get()
23676 * @see elm_panes_content_left_set() to set content on the other side.
23680 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23683 * Get the left content of the panes.
23685 * @param obj The panes object.
23686 * @return The left content object that is being used.
23688 * Return the left content object which is set for this widget.
23690 * @see elm_panes_content_left_set() for details.
23694 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23697 * Get the right content of the panes.
23699 * @param obj The panes object
23700 * @return The right content object that is being used
23702 * Return the right content object which is set for this widget.
23704 * @see elm_panes_content_right_set() for details.
23708 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23711 * Unset the left content used for the panes.
23713 * @param obj The panes object.
23714 * @return The left content object that was being used.
23716 * Unparent and return the left content object which was set for this widget.
23718 * @see elm_panes_content_left_set() for details.
23719 * @see elm_panes_content_left_get().
23723 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23726 * Unset the right content used for the panes.
23728 * @param obj The panes object.
23729 * @return The right content object that was being used.
23731 * Unparent and return the right content object which was set for this
23734 * @see elm_panes_content_right_set() for details.
23735 * @see elm_panes_content_right_get().
23739 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23742 * Get the size proportion of panes widget's left side.
23744 * @param obj The panes object.
23745 * @return float value between 0.0 and 1.0 representing size proportion
23748 * @see elm_panes_content_left_size_set() for more details.
23752 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23755 * Set the size proportion of panes widget's left side.
23757 * @param obj The panes object.
23758 * @param size Value between 0.0 and 1.0 representing size proportion
23761 * By default it's homogeneous, i.e., both sides have the same size.
23763 * If something different is required, it can be set with this function.
23764 * For example, if the left content should be displayed over
23765 * 75% of the panes size, @p size should be passed as @c 0.75.
23766 * This way, right content will be resized to 25% of panes size.
23768 * If displayed vertically, left content is displayed at top, and
23769 * right content at bottom.
23771 * @note This proportion will change when user drags the panes bar.
23773 * @see elm_panes_content_left_size_get()
23777 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
23780 * Set the orientation of a given panes widget.
23782 * @param obj The panes object.
23783 * @param horizontal Use @c EINA_TRUE to make @p obj to be
23784 * @b horizontal, @c EINA_FALSE to make it @b vertical.
23786 * Use this function to change how your panes is to be
23787 * disposed: vertically or horizontally.
23789 * By default it's displayed horizontally.
23791 * @see elm_panes_horizontal_get()
23795 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
23798 * Retrieve the orientation of a given panes widget.
23800 * @param obj The panes object.
23801 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
23802 * @c EINA_FALSE if it's @b vertical (and on errors).
23804 * @see elm_panes_horizontal_set() for more details.
23808 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23809 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
23810 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23817 * @defgroup Flip Flip
23819 * @image html img/widget/flip/preview-00.png
23820 * @image latex img/widget/flip/preview-00.eps
23822 * This widget holds 2 content objects(Evas_Object): one on the front and one
23823 * on the back. It allows you to flip from front to back and vice-versa using
23824 * various animations.
23826 * If either the front or back contents are not set the flip will treat that
23827 * as transparent. So if you wore to set the front content but not the back,
23828 * and then call elm_flip_go() you would see whatever is below the flip.
23830 * For a list of supported animations see elm_flip_go().
23832 * Signals that you can add callbacks for are:
23833 * "animate,begin" - when a flip animation was started
23834 * "animate,done" - when a flip animation is finished
23836 * @ref tutorial_flip show how to use most of the API.
23840 typedef enum _Elm_Flip_Mode
23842 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
23843 ELM_FLIP_ROTATE_X_CENTER_AXIS,
23844 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
23845 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
23846 ELM_FLIP_CUBE_LEFT,
23847 ELM_FLIP_CUBE_RIGHT,
23849 ELM_FLIP_CUBE_DOWN,
23850 ELM_FLIP_PAGE_LEFT,
23851 ELM_FLIP_PAGE_RIGHT,
23855 typedef enum _Elm_Flip_Interaction
23857 ELM_FLIP_INTERACTION_NONE,
23858 ELM_FLIP_INTERACTION_ROTATE,
23859 ELM_FLIP_INTERACTION_CUBE,
23860 ELM_FLIP_INTERACTION_PAGE
23861 } Elm_Flip_Interaction;
23862 typedef enum _Elm_Flip_Direction
23864 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
23865 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
23866 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
23867 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
23868 } Elm_Flip_Direction;
23870 * @brief Add a new flip to the parent
23872 * @param parent The parent object
23873 * @return The new object or NULL if it cannot be created
23875 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23877 * @brief Set the front content of the flip widget.
23879 * @param obj The flip object
23880 * @param content The new front content object
23882 * Once the content object is set, a previously set one will be deleted.
23883 * If you want to keep that old content object, use the
23884 * elm_flip_content_front_unset() function.
23886 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23888 * @brief Set the back content of the flip widget.
23890 * @param obj The flip object
23891 * @param content The new back content object
23893 * Once the content object is set, a previously set one will be deleted.
23894 * If you want to keep that old content object, use the
23895 * elm_flip_content_back_unset() function.
23897 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23899 * @brief Get the front content used for the flip
23901 * @param obj The flip object
23902 * @return The front content object that is being used
23904 * Return the front content object which is set for this widget.
23906 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23908 * @brief Get the back content used for the flip
23910 * @param obj The flip object
23911 * @return The back content object that is being used
23913 * Return the back content object which is set for this widget.
23915 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23917 * @brief Unset the front content used for the flip
23919 * @param obj The flip object
23920 * @return The front content object that was being used
23922 * Unparent and return the front content object which was set for this widget.
23924 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23926 * @brief Unset the back content used for the flip
23928 * @param obj The flip object
23929 * @return The back content object that was being used
23931 * Unparent and return the back content object which was set for this widget.
23933 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23935 * @brief Get flip front visibility state
23937 * @param obj The flip objct
23938 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
23941 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23943 * @brief Set flip perspective
23945 * @param obj The flip object
23946 * @param foc The coordinate to set the focus on
23947 * @param x The X coordinate
23948 * @param y The Y coordinate
23950 * @warning This function currently does nothing.
23952 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
23954 * @brief Runs the flip animation
23956 * @param obj The flip object
23957 * @param mode The mode type
23959 * Flips the front and back contents using the @p mode animation. This
23960 * efectively hides the currently visible content and shows the hidden one.
23962 * There a number of possible animations to use for the flipping:
23963 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
23964 * around a horizontal axis in the middle of its height, the other content
23965 * is shown as the other side of the flip.
23966 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
23967 * around a vertical axis in the middle of its width, the other content is
23968 * shown as the other side of the flip.
23969 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
23970 * around a diagonal axis in the middle of its width, the other content is
23971 * shown as the other side of the flip.
23972 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
23973 * around a diagonal axis in the middle of its height, the other content is
23974 * shown as the other side of the flip.
23975 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
23976 * as if the flip was a cube, the other content is show as the right face of
23978 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
23979 * right as if the flip was a cube, the other content is show as the left
23980 * face of the cube.
23981 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
23982 * flip was a cube, the other content is show as the bottom face of the cube.
23983 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
23984 * the flip was a cube, the other content is show as the upper face of the
23986 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
23987 * if the flip was a book, the other content is shown as the page below that.
23988 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
23989 * as if the flip was a book, the other content is shown as the page below
23991 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
23992 * flip was a book, the other content is shown as the page below that.
23993 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
23994 * flip was a book, the other content is shown as the page below that.
23996 * @image html elm_flip.png
23997 * @image latex elm_flip.eps width=\textwidth
23999 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24001 * @brief Set the interactive flip mode
24003 * @param obj The flip object
24004 * @param mode The interactive flip mode to use
24006 * This sets if the flip should be interactive (allow user to click and
24007 * drag a side of the flip to reveal the back page and cause it to flip).
24008 * By default a flip is not interactive. You may also need to set which
24009 * sides of the flip are "active" for flipping and how much space they use
24010 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24011 * and elm_flip_interacton_direction_hitsize_set()
24013 * The four avilable mode of interaction are:
24014 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24015 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24016 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24017 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24019 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24020 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24021 * happen, those can only be acheived with elm_flip_go();
24023 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24025 * @brief Get the interactive flip mode
24027 * @param obj The flip object
24028 * @return The interactive flip mode
24030 * Returns the interactive flip mode set by elm_flip_interaction_set()
24032 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24034 * @brief Set which directions of the flip respond to interactive flip
24036 * @param obj The flip object
24037 * @param dir The direction to change
24038 * @param enabled If that direction is enabled or not
24040 * By default all directions are disabled, so you may want to enable the
24041 * desired directions for flipping if you need interactive flipping. You must
24042 * call this function once for each direction that should be enabled.
24044 * @see elm_flip_interaction_set()
24046 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24048 * @brief Get the enabled state of that flip direction
24050 * @param obj The flip object
24051 * @param dir The direction to check
24052 * @return If that direction is enabled or not
24054 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24056 * @see elm_flip_interaction_set()
24058 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24060 * @brief Set the amount of the flip that is sensitive to interactive flip
24062 * @param obj The flip object
24063 * @param dir The direction to modify
24064 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24066 * Set the amount of the flip that is sensitive to interactive flip, with 0
24067 * representing no area in the flip and 1 representing the entire flip. There
24068 * is however a consideration to be made in that the area will never be
24069 * smaller than the finger size set(as set in your Elementary configuration).
24071 * @see elm_flip_interaction_set()
24073 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24075 * @brief Get the amount of the flip that is sensitive to interactive flip
24077 * @param obj The flip object
24078 * @param dir The direction to check
24079 * @return The size set for that direction
24081 * Returns the amount os sensitive area set by
24082 * elm_flip_interacton_direction_hitsize_set().
24084 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24089 /* scrolledentry */
24090 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24091 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24092 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24093 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24094 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24095 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24096 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24097 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24098 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24099 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24100 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24101 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24102 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24103 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24104 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24105 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24106 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24107 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24108 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24109 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24110 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24111 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24112 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24113 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24114 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24115 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24116 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24117 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24118 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24119 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24120 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24121 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24122 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24123 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24124 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24125 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);
24126 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24127 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24128 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);
24129 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24130 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);
24131 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24132 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24133 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24134 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24135 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24136 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24137 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24138 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24139 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);
24140 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);
24141 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);
24142 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);
24143 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);
24144 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);
24145 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24146 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24147 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24148 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24149 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24150 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24151 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24152 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
24153 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
24154 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
24155 EINA_DEPRECATED EAPI Ecore_IMF_Context *elm_scrolled_entry_imf_context_get(Evas_Object *obj);
24156 EINA_DEPRECATED EAPI void elm_scrolled_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
24157 EINA_DEPRECATED EAPI void elm_scrolled_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
24160 * @defgroup Conformant Conformant
24161 * @ingroup Elementary
24163 * @image html img/widget/conformant/preview-00.png
24164 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24166 * @image html img/conformant.png
24167 * @image latex img/conformant.eps width=\textwidth
24169 * The aim is to provide a widget that can be used in elementary apps to
24170 * account for space taken up by the indicator, virtual keypad & softkey
24171 * windows when running the illume2 module of E17.
24173 * So conformant content will be sized and positioned considering the
24174 * space required for such stuff, and when they popup, as a keyboard
24175 * shows when an entry is selected, conformant content won't change.
24177 * Available styles for it:
24180 * Default contents parts of the conformant widget that you can use for are:
24182 * @li "elm.swallow.content" - A content of the conformant
24184 * See how to use this widget in this example:
24185 * @ref conformant_example
24189 * @addtogroup Conformant
24194 * Add a new conformant widget to the given parent Elementary
24195 * (container) object.
24197 * @param parent The parent object.
24198 * @return A new conformant widget handle or @c NULL, on errors.
24200 * This function inserts a new conformant widget on the canvas.
24202 * @ingroup Conformant
24204 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24207 * Set the content of the conformant widget.
24209 * @param obj The conformant object.
24210 * @param content The content to be displayed by the conformant.
24212 * Content will be sized and positioned considering the space required
24213 * to display a virtual keyboard. So it won't fill all the conformant
24214 * size. This way is possible to be sure that content won't resize
24215 * or be re-positioned after the keyboard is displayed.
24217 * Once the content object is set, a previously set one will be deleted.
24218 * If you want to keep that old content object, use the
24219 * elm_object_content_unset() function.
24221 * @see elm_object_content_unset()
24222 * @see elm_object_content_get()
24224 * @ingroup Conformant
24226 EINA_DEPRECATED EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24229 * Get the content of the conformant widget.
24231 * @param obj The conformant object.
24232 * @return The content that is being used.
24234 * Return the content object which is set for this widget.
24235 * It won't be unparent from conformant. For that, use
24236 * elm_object_content_unset().
24238 * @see elm_object_content_set().
24239 * @see elm_object_content_unset()
24241 * @ingroup Conformant
24243 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24246 * Unset the content of the conformant widget.
24248 * @param obj The conformant object.
24249 * @return The content that was being used.
24251 * Unparent and return the content object which was set for this widget.
24253 * @see elm_object_content_set().
24255 * @ingroup Conformant
24257 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24260 * Returns the Evas_Object that represents the content area.
24262 * @param obj The conformant object.
24263 * @return The content area of the widget.
24265 * @ingroup Conformant
24267 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24274 * @defgroup Mapbuf Mapbuf
24275 * @ingroup Elementary
24277 * @image html img/widget/mapbuf/preview-00.png
24278 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24280 * This holds one content object and uses an Evas Map of transformation
24281 * points to be later used with this content. So the content will be
24282 * moved, resized, etc as a single image. So it will improve performance
24283 * when you have a complex interafce, with a lot of elements, and will
24284 * need to resize or move it frequently (the content object and its
24287 * To set/get/unset the content of the mapbuf, you can use
24288 * elm_object_content_set/get/unset APIs.
24289 * Once the content object is set, a previously set one will be deleted.
24290 * If you want to keep that old content object, use the
24291 * elm_object_content_unset() function.
24293 * To enable map, elm_mapbuf_enabled_set() should be used.
24295 * See how to use this widget in this example:
24296 * @ref mapbuf_example
24300 * @addtogroup Mapbuf
24305 * Add a new mapbuf widget to the given parent Elementary
24306 * (container) object.
24308 * @param parent The parent object.
24309 * @return A new mapbuf widget handle or @c NULL, on errors.
24311 * This function inserts a new mapbuf widget on the canvas.
24315 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24318 * Set the content of the mapbuf.
24320 * @param obj The mapbuf object.
24321 * @param content The content that will be filled in this mapbuf object.
24323 * Once the content object is set, a previously set one will be deleted.
24324 * If you want to keep that old content object, use the
24325 * elm_mapbuf_content_unset() function.
24327 * To enable map, elm_mapbuf_enabled_set() should be used.
24331 EINA_DEPRECATED EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24334 * Get the content of the mapbuf.
24336 * @param obj The mapbuf object.
24337 * @return The content that is being used.
24339 * Return the content object which is set for this widget.
24341 * @see elm_mapbuf_content_set() for details.
24345 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24348 * Unset the content of the mapbuf.
24350 * @param obj The mapbuf object.
24351 * @return The content that was being used.
24353 * Unparent and return the content object which was set for this widget.
24355 * @see elm_mapbuf_content_set() for details.
24359 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24362 * Enable or disable the map.
24364 * @param obj The mapbuf object.
24365 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24367 * This enables the map that is set or disables it. On enable, the object
24368 * geometry will be saved, and the new geometry will change (position and
24369 * size) to reflect the map geometry set.
24371 * Also, when enabled, alpha and smooth states will be used, so if the
24372 * content isn't solid, alpha should be enabled, for example, otherwise
24373 * a black retangle will fill the content.
24375 * When disabled, the stored map will be freed and geometry prior to
24376 * enabling the map will be restored.
24378 * It's disabled by default.
24380 * @see elm_mapbuf_alpha_set()
24381 * @see elm_mapbuf_smooth_set()
24385 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24388 * Get a value whether map is enabled or not.
24390 * @param obj The mapbuf object.
24391 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24392 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24394 * @see elm_mapbuf_enabled_set() for details.
24398 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24401 * Enable or disable smooth map rendering.
24403 * @param obj The mapbuf object.
24404 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24407 * This sets smoothing for map rendering. If the object is a type that has
24408 * its own smoothing settings, then both the smooth settings for this object
24409 * and the map must be turned off.
24411 * By default smooth maps are enabled.
24415 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24418 * Get a value whether smooth map rendering is enabled or not.
24420 * @param obj The mapbuf object.
24421 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24422 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24424 * @see elm_mapbuf_smooth_set() for details.
24428 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24431 * Set or unset alpha flag for map rendering.
24433 * @param obj The mapbuf object.
24434 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24437 * This sets alpha flag for map rendering. If the object is a type that has
24438 * its own alpha settings, then this will take precedence. Only image objects
24439 * have this currently. It stops alpha blending of the map area, and is
24440 * useful if you know the object and/or all sub-objects is 100% solid.
24442 * Alpha is enabled by default.
24446 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24449 * Get a value whether alpha blending is enabled or not.
24451 * @param obj The mapbuf object.
24452 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24453 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24455 * @see elm_mapbuf_alpha_set() for details.
24459 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24466 * @defgroup Flipselector Flip Selector
24468 * A flip selector is a widget to show a set of @b text items, one
24469 * at a time, with the same sheet switching style as the @ref Clock
24470 * "clock" widget, when one changes the current displaying sheet
24471 * (thus, the "flip" in the name).
24473 * User clicks to flip sheets which are @b held for some time will
24474 * make the flip selector to flip continuosly and automatically for
24475 * the user. The interval between flips will keep growing in time,
24476 * so that it helps the user to reach an item which is distant from
24477 * the current selection.
24479 * Smart callbacks one can register to:
24480 * - @c "selected" - when the widget's selected text item is changed
24481 * - @c "overflowed" - when the widget's current selection is changed
24482 * from the first item in its list to the last
24483 * - @c "underflowed" - when the widget's current selection is changed
24484 * from the last item in its list to the first
24486 * Available styles for it:
24489 * Here is an example on its usage:
24490 * @li @ref flipselector_example
24494 * @addtogroup Flipselector
24498 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
24501 * Add a new flip selector widget to the given parent Elementary
24502 * (container) widget
24504 * @param parent The parent object
24505 * @return a new flip selector widget handle or @c NULL, on errors
24507 * This function inserts a new flip selector widget on the canvas.
24509 * @ingroup Flipselector
24511 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24514 * Programmatically select the next item of a flip selector widget
24516 * @param obj The flipselector object
24518 * @note The selection will be animated. Also, if it reaches the
24519 * end of its list of member items, it will continue with the first
24522 * @ingroup Flipselector
24524 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24527 * Programmatically select the previous item of a flip selector
24530 * @param obj The flipselector object
24532 * @note The selection will be animated. Also, if it reaches the
24533 * beginning of its list of member items, it will continue with the
24534 * last one backwards.
24536 * @ingroup Flipselector
24538 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24541 * Append a (text) item to a flip selector widget
24543 * @param obj The flipselector object
24544 * @param label The (text) label of the new item
24545 * @param func Convenience callback function to take place when
24547 * @param data Data passed to @p func, above
24548 * @return A handle to the item added or @c NULL, on errors
24550 * The widget's list of labels to show will be appended with the
24551 * given value. If the user wishes so, a callback function pointer
24552 * can be passed, which will get called when this same item is
24555 * @note The current selection @b won't be modified by appending an
24556 * element to the list.
24558 * @note The maximum length of the text label is going to be
24559 * determined <b>by the widget's theme</b>. Strings larger than
24560 * that value are going to be @b truncated.
24562 * @ingroup Flipselector
24564 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24567 * Prepend a (text) item to a flip selector widget
24569 * @param obj The flipselector object
24570 * @param label The (text) label of the new item
24571 * @param func Convenience callback function to take place when
24573 * @param data Data passed to @p func, above
24574 * @return A handle to the item added or @c NULL, on errors
24576 * The widget's list of labels to show will be prepended with the
24577 * given value. If the user wishes so, a callback function pointer
24578 * can be passed, which will get called when this same item is
24581 * @note The current selection @b won't be modified by prepending
24582 * an element to the list.
24584 * @note The maximum length of the text label is going to be
24585 * determined <b>by the widget's theme</b>. Strings larger than
24586 * that value are going to be @b truncated.
24588 * @ingroup Flipselector
24590 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24593 * Get the internal list of items in a given flip selector widget.
24595 * @param obj The flipselector object
24596 * @return The list of items (#Elm_Flipselector_Item as data) or @c
24599 * This list is @b not to be modified in any way and must not be
24600 * freed. Use the list members with functions like
24601 * elm_flipselector_item_label_set(),
24602 * elm_flipselector_item_label_get(), elm_flipselector_item_del(),
24603 * elm_flipselector_item_del(),
24604 * elm_flipselector_item_selected_get(),
24605 * elm_flipselector_item_selected_set().
24607 * @warning This list is only valid until @p obj object's internal
24608 * items list is changed. It should be fetched again with another
24609 * call to this function when changes happen.
24611 * @ingroup Flipselector
24613 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24616 * Get the first item in the given flip selector widget's list of
24619 * @param obj The flipselector object
24620 * @return The first item or @c NULL, if it has no items (and on
24623 * @see elm_flipselector_item_append()
24624 * @see elm_flipselector_last_item_get()
24626 * @ingroup Flipselector
24628 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24631 * Get the last item in the given flip selector widget's list of
24634 * @param obj The flipselector object
24635 * @return The last item or @c NULL, if it has no items (and on
24638 * @see elm_flipselector_item_prepend()
24639 * @see elm_flipselector_first_item_get()
24641 * @ingroup Flipselector
24643 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24646 * Get the currently selected item in a flip selector widget.
24648 * @param obj The flipselector object
24649 * @return The selected item or @c NULL, if the widget has no items
24652 * @ingroup Flipselector
24654 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24657 * Set whether a given flip selector widget's item should be the
24658 * currently selected one.
24660 * @param item The flip selector item
24661 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
24663 * This sets whether @p item is or not the selected (thus, under
24664 * display) one. If @p item is different than one under display,
24665 * the latter will be unselected. If the @p item is set to be
24666 * unselected, on the other hand, the @b first item in the widget's
24667 * internal members list will be the new selected one.
24669 * @see elm_flipselector_item_selected_get()
24671 * @ingroup Flipselector
24673 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24676 * Get whether a given flip selector widget's item is the currently
24679 * @param item The flip selector item
24680 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
24683 * @see elm_flipselector_item_selected_set()
24685 * @ingroup Flipselector
24687 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24690 * Delete a given item from a flip selector widget.
24692 * @param item The item to delete
24694 * @ingroup Flipselector
24696 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24699 * Get the label of a given flip selector widget's item.
24701 * @param item The item to get label from
24702 * @return The text label of @p item or @c NULL, on errors
24704 * @see elm_flipselector_item_label_set()
24706 * @ingroup Flipselector
24708 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24711 * Set the label of a given flip selector widget's item.
24713 * @param item The item to set label on
24714 * @param label The text label string, in UTF-8 encoding
24716 * @see elm_flipselector_item_label_get()
24718 * @ingroup Flipselector
24720 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24723 * Gets the item before @p item in a flip selector widget's
24724 * internal list of items.
24726 * @param item The item to fetch previous from
24727 * @return The item before the @p item, in its parent's list. If
24728 * there is no previous item for @p item or there's an
24729 * error, @c NULL is returned.
24731 * @see elm_flipselector_item_next_get()
24733 * @ingroup Flipselector
24735 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24738 * Gets the item after @p item in a flip selector widget's
24739 * internal list of items.
24741 * @param item The item to fetch next from
24742 * @return The item after the @p item, in its parent's list. If
24743 * there is no next item for @p item or there's an
24744 * error, @c NULL is returned.
24746 * @see elm_flipselector_item_next_get()
24748 * @ingroup Flipselector
24750 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24753 * Set the interval on time updates for an user mouse button hold
24754 * on a flip selector widget.
24756 * @param obj The flip selector object
24757 * @param interval The (first) interval value in seconds
24759 * This interval value is @b decreased while the user holds the
24760 * mouse pointer either flipping up or flipping doww a given flip
24763 * This helps the user to get to a given item distant from the
24764 * current one easier/faster, as it will start to flip quicker and
24765 * quicker on mouse button holds.
24767 * The calculation for the next flip interval value, starting from
24768 * the one set with this call, is the previous interval divided by
24769 * 1.05, so it decreases a little bit.
24771 * The default starting interval value for automatic flips is
24774 * @see elm_flipselector_interval_get()
24776 * @ingroup Flipselector
24778 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
24781 * Get the interval on time updates for an user mouse button hold
24782 * on a flip selector widget.
24784 * @param obj The flip selector object
24785 * @return The (first) interval value, in seconds, set on it
24787 * @see elm_flipselector_interval_set() for more details
24789 * @ingroup Flipselector
24791 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24798 * @addtogroup Animator Animator
24799 * @ingroup Elementary
24801 * @brief Functions to ease creation of animations.
24803 * elm_animator is designed to provide an easy way to create animations.
24804 * Creating an animation with elm_animator is as simple as setting a
24805 * duration, an operating callback and telling it to run the animation.
24806 * However that is not the full extent of elm_animator's ability, animations
24807 * can be paused and resumed, reversed and the animation need not be linear.
24809 * To run an animation you must specify at least a duration and operation
24810 * callback, not setting any other properties will create a linear animation
24811 * that runs once and is not reversed.
24813 * @ref elm_animator_example_page_01 "This" example should make all of that
24816 * @warning elm_animator is @b not a widget.
24820 * @brief Type of curve desired for animation.
24822 * The speed in which an animation happens doesn't have to be linear, some
24823 * animations will look better if they're accelerating or decelerating, so
24824 * elm_animator provides four options in this regard:
24825 * @image html elm_animator_curve_style.png
24826 * @image latex elm_animator_curve_style.eps width=\textwidth
24827 * As can be seen in the image the speed of the animation will be:
24828 * @li ELM_ANIMATOR_CURVE_LINEAR constant
24829 * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
24830 * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
24831 * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
24835 ELM_ANIMATOR_CURVE_LINEAR,
24836 ELM_ANIMATOR_CURVE_IN_OUT,
24837 ELM_ANIMATOR_CURVE_IN,
24838 ELM_ANIMATOR_CURVE_OUT
24839 } Elm_Animator_Curve_Style;
24840 typedef struct _Elm_Animator Elm_Animator;
24842 * Called back per loop of an elementary animators cycle
24843 * @param data user-data given to elm_animator_operation_callback_set()
24844 * @param animator the animator being run
24845 * @param double the position in the animation
24847 typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
24849 * Called back when an elementary animator finishes
24850 * @param data user-data given to elm_animator_completion_callback_set()
24852 typedef void (*Elm_Animator_Completion_Cb) (void *data);
24855 * @brief Create a new animator.
24857 * @param[in] parent Parent object
24859 * The @a parent argument can be set to NULL for no parent. If a parent is set
24860 * there is no need to call elm_animator_del(), when the parent is deleted it
24861 * will delete the animator.
24862 * @deprecated Use @ref Transit instead.
24865 EINA_DEPRECATED EAPI Elm_Animator* elm_animator_add(Evas_Object *parent);
24867 * Deletes the animator freeing any resources it used. If the animator was
24868 * created with a NULL parent this must be called, otherwise it will be
24869 * automatically called when the parent is deleted.
24871 * @param[in] animator Animator object
24872 * @deprecated Use @ref Transit instead.
24874 EINA_DEPRECATED EAPI void elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
24876 * Set the duration of the animation.
24878 * @param[in] animator Animator object
24879 * @param[in] duration Duration in second
24880 * @deprecated Use @ref Transit instead.
24882 EINA_DEPRECATED EAPI void elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
24884 * @brief Set the callback function for animator operation.
24886 * @param[in] animator Animator object
24887 * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
24888 * @param[in] data Callback function user argument
24890 * The @p func callback will be called with a frame value in range [0, 1] which
24891 * indicates how far along the animation should be. It is the job of @p func to
24892 * actually change the state of any object(or objects) that are being animated.
24893 * @deprecated Use @ref Transit instead.
24895 EINA_DEPRECATED EAPI void elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
24897 * Set the callback function for the when the animation ends.
24899 * @param[in] animator Animator object
24900 * @param[in] func Callback function pointe
24901 * @param[in] data Callback function user argument
24903 * @warning @a func will not be executed if elm_animator_stop() is called.
24904 * @deprecated Use @ref Transit instead.
24906 EINA_DEPRECATED EAPI void elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
24908 * @brief Stop animator.
24910 * @param[in] animator Animator object
24912 * If called before elm_animator_animate() it does nothing. If there is an
24913 * animation in progress the animation will be stopped(the operation callback
24914 * will not be executed again) and it can't be restarted using
24915 * elm_animator_resume().
24916 * @deprecated Use @ref Transit instead.
24918 EINA_DEPRECATED EAPI void elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
24920 * Set the animator repeat count.
24922 * @param[in] animator Animator object
24923 * @param[in] repeat_cnt Repeat count
24924 * @deprecated Use @ref Transit instead.
24926 EINA_DEPRECATED EAPI void elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
24928 * @brief Start animation.
24930 * @param[in] animator Animator object
24932 * This function starts the animation if the nescessary properties(duration
24933 * and operation callback) have been set. Once started the animation will
24934 * run until complete or elm_animator_stop() is called.
24935 * @deprecated Use @ref Transit instead.
24937 EINA_DEPRECATED EAPI void elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
24939 * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
24941 * @param[in] animator Animator object
24942 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
24943 * @deprecated Use @ref Transit instead.
24945 EINA_DEPRECATED EAPI void elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
24947 * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
24949 * @param[in] animator Animator object
24950 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
24951 * @deprecated Use @ref Transit instead.
24953 EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
24955 * @brief Sets wether the animation should be automatically reversed.
24957 * @param[in] animator Animator object
24958 * @param[in] reverse Reverse or not
24960 * This controls wether the animation will be run on reverse imediately after
24961 * running forward. When this is set together with repetition the animation
24962 * will run in reverse once for each time it ran forward.@n
24963 * Runnin an animation in reverse is accomplished by calling the operation
24964 * callback with a frame value starting at 1 and diminshing until 0.
24965 * @deprecated Use @ref Transit instead.
24967 EINA_DEPRECATED EAPI void elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
24969 * Gets wether the animation will automatically reversed
24971 * @param[in] animator Animator object
24972 * @deprecated Use @ref Transit instead.
24974 EINA_DEPRECATED EAPI Eina_Bool elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
24976 * Gets the status for the animator operation. The status of the animator @b
24977 * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
24978 * only informs if the animation was started and has not ended(either normally
24979 * or through elm_animator_stop()).
24981 * @param[in] animator Animator object
24982 * @deprecated Use @ref Transit instead.
24984 EINA_DEPRECATED EAPI Eina_Bool elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
24986 * Gets how many times the animation will be repeated
24988 * @param[in] animator Animator object
24989 * @deprecated Use @ref Transit instead.
24991 EINA_DEPRECATED EAPI unsigned int elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
24993 * Pause the animator.
24995 * @param[in] animator Animator object
24997 * This causes the animation to be temporarily stopped(the operation callback
24998 * will not be called). If the animation is not yet running this is a no-op.
24999 * Once an animation has been paused with this function it can be resumed
25000 * using elm_animator_resume().
25001 * @deprecated Use @ref Transit instead.
25003 EINA_DEPRECATED EAPI void elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
25005 * @brief Resumes the animator.
25007 * @param[in] animator Animator object
25009 * Resumes an animation that was paused using elm_animator_pause(), after
25010 * calling this function calls to the operation callback will happen
25011 * normally. If an animation is stopped by means of elm_animator_stop it
25012 * @b can't be restarted with this function.@n
25014 * @warning When an animation is resumed it doesn't start from where it was paused, it
25015 * will go to where it would have been if it had not been paused. If an
25016 * animation with a duration of 3 seconds is paused after 1 second for 1 second
25017 * it will resume as if it had ben animating for 2 seconds, the operating
25018 * callback will be called with a frame value of aproximately 2/3.
25019 * @deprecated Use @ref Transit instead.
25021 EINA_DEPRECATED EAPI void elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
25027 * @addtogroup Calendar
25032 * @enum _Elm_Calendar_Mark_Repeat
25033 * @typedef Elm_Calendar_Mark_Repeat
25035 * Event periodicity, used to define if a mark should be repeated
25036 * @b beyond event's day. It's set when a mark is added.
25038 * So, for a mark added to 13th May with periodicity set to WEEKLY,
25039 * there will be marks every week after this date. Marks will be displayed
25040 * at 13th, 20th, 27th, 3rd June ...
25042 * Values don't work as bitmask, only one can be choosen.
25044 * @see elm_calendar_mark_add()
25046 * @ingroup Calendar
25048 typedef enum _Elm_Calendar_Mark_Repeat
25050 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25051 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25052 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25053 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*/
25054 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. */
25055 } Elm_Calendar_Mark_Repeat;
25057 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(). */
25060 * Add a new calendar widget to the given parent Elementary
25061 * (container) object.
25063 * @param parent The parent object.
25064 * @return a new calendar widget handle or @c NULL, on errors.
25066 * This function inserts a new calendar widget on the canvas.
25068 * @ref calendar_example_01
25070 * @ingroup Calendar
25072 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25075 * Get weekdays names displayed by the calendar.
25077 * @param obj The calendar object.
25078 * @return Array of seven strings to be used as weekday names.
25080 * By default, weekdays abbreviations get from system are displayed:
25081 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25082 * The first string is related to Sunday, the second to Monday...
25084 * @see elm_calendar_weekdays_name_set()
25086 * @ref calendar_example_05
25088 * @ingroup Calendar
25090 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25093 * Set weekdays names to be displayed by the calendar.
25095 * @param obj The calendar object.
25096 * @param weekdays Array of seven strings to be used as weekday names.
25097 * @warning It must have 7 elements, or it will access invalid memory.
25098 * @warning The strings must be NULL terminated ('@\0').
25100 * By default, weekdays abbreviations get from system are displayed:
25101 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25103 * The first string should be related to Sunday, the second to Monday...
25105 * The usage should be like this:
25107 * const char *weekdays[] =
25109 * "Sunday", "Monday", "Tuesday", "Wednesday",
25110 * "Thursday", "Friday", "Saturday"
25112 * elm_calendar_weekdays_names_set(calendar, weekdays);
25115 * @see elm_calendar_weekdays_name_get()
25117 * @ref calendar_example_02
25119 * @ingroup Calendar
25121 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25124 * Set the minimum and maximum values for the year
25126 * @param obj The calendar object
25127 * @param min The minimum year, greater than 1901;
25128 * @param max The maximum year;
25130 * Maximum must be greater than minimum, except if you don't wan't to set
25132 * Default values are 1902 and -1.
25134 * If the maximum year is a negative value, it will be limited depending
25135 * on the platform architecture (year 2037 for 32 bits);
25137 * @see elm_calendar_min_max_year_get()
25139 * @ref calendar_example_03
25141 * @ingroup Calendar
25143 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25146 * Get the minimum and maximum values for the year
25148 * @param obj The calendar object.
25149 * @param min The minimum year.
25150 * @param max The maximum year.
25152 * Default values are 1902 and -1.
25154 * @see elm_calendar_min_max_year_get() for more details.
25156 * @ref calendar_example_05
25158 * @ingroup Calendar
25160 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25163 * Enable or disable day selection
25165 * @param obj The calendar object.
25166 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25169 * Enabled by default. If disabled, the user still can select months,
25170 * but not days. Selected days are highlighted on calendar.
25171 * It should be used if you won't need such selection for the widget usage.
25173 * When a day is selected, or month is changed, smart callbacks for
25174 * signal "changed" will be called.
25176 * @see elm_calendar_day_selection_enable_get()
25178 * @ref calendar_example_04
25180 * @ingroup Calendar
25182 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25185 * Get a value whether day selection is enabled or not.
25187 * @see elm_calendar_day_selection_enable_set() for details.
25189 * @param obj The calendar object.
25190 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25191 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25193 * @ref calendar_example_05
25195 * @ingroup Calendar
25197 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25201 * Set selected date to be highlighted on calendar.
25203 * @param obj The calendar object.
25204 * @param selected_time A @b tm struct to represent the selected date.
25206 * Set the selected date, changing the displayed month if needed.
25207 * Selected date changes when the user goes to next/previous month or
25208 * select a day pressing over it on calendar.
25210 * @see elm_calendar_selected_time_get()
25212 * @ref calendar_example_04
25214 * @ingroup Calendar
25216 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25219 * Get selected date.
25221 * @param obj The calendar object
25222 * @param selected_time A @b tm struct to point to selected date
25223 * @return EINA_FALSE means an error ocurred and returned time shouldn't
25226 * Get date selected by the user or set by function
25227 * elm_calendar_selected_time_set().
25228 * Selected date changes when the user goes to next/previous month or
25229 * select a day pressing over it on calendar.
25231 * @see elm_calendar_selected_time_get()
25233 * @ref calendar_example_05
25235 * @ingroup Calendar
25237 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25240 * Set a function to format the string that will be used to display
25243 * @param obj The calendar object
25244 * @param format_function Function to set the month-year string given
25245 * the selected date
25247 * By default it uses strftime with "%B %Y" format string.
25248 * It should allocate the memory that will be used by the string,
25249 * that will be freed by the widget after usage.
25250 * A pointer to the string and a pointer to the time struct will be provided.
25255 * _format_month_year(struct tm *selected_time)
25258 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25259 * return strdup(buf);
25262 * elm_calendar_format_function_set(calendar, _format_month_year);
25265 * @ref calendar_example_02
25267 * @ingroup Calendar
25269 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25272 * Add a new mark to the calendar
25274 * @param obj The calendar object
25275 * @param mark_type A string used to define the type of mark. It will be
25276 * emitted to the theme, that should display a related modification on these
25277 * days representation.
25278 * @param mark_time A time struct to represent the date of inclusion of the
25279 * mark. For marks that repeats it will just be displayed after the inclusion
25280 * date in the calendar.
25281 * @param repeat Repeat the event following this periodicity. Can be a unique
25282 * mark (that don't repeat), daily, weekly, monthly or annually.
25283 * @return The created mark or @p NULL upon failure.
25285 * Add a mark that will be drawn in the calendar respecting the insertion
25286 * time and periodicity. It will emit the type as signal to the widget theme.
25287 * Default theme supports "holiday" and "checked", but it can be extended.
25289 * It won't immediately update the calendar, drawing the marks.
25290 * For this, call elm_calendar_marks_draw(). However, when user selects
25291 * next or previous month calendar forces marks drawn.
25293 * Marks created with this method can be deleted with
25294 * elm_calendar_mark_del().
25298 * struct tm selected_time;
25299 * time_t current_time;
25301 * current_time = time(NULL) + 5 * 84600;
25302 * localtime_r(¤t_time, &selected_time);
25303 * elm_calendar_mark_add(cal, "holiday", selected_time,
25304 * ELM_CALENDAR_ANNUALLY);
25306 * current_time = time(NULL) + 1 * 84600;
25307 * localtime_r(¤t_time, &selected_time);
25308 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25310 * elm_calendar_marks_draw(cal);
25313 * @see elm_calendar_marks_draw()
25314 * @see elm_calendar_mark_del()
25316 * @ref calendar_example_06
25318 * @ingroup Calendar
25320 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);
25323 * Delete mark from the calendar.
25325 * @param mark The mark to be deleted.
25327 * If deleting all calendar marks is required, elm_calendar_marks_clear()
25328 * should be used instead of getting marks list and deleting each one.
25330 * @see elm_calendar_mark_add()
25332 * @ref calendar_example_06
25334 * @ingroup Calendar
25336 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25339 * Remove all calendar's marks
25341 * @param obj The calendar object.
25343 * @see elm_calendar_mark_add()
25344 * @see elm_calendar_mark_del()
25346 * @ingroup Calendar
25348 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25352 * Get a list of all the calendar marks.
25354 * @param obj The calendar object.
25355 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25357 * @see elm_calendar_mark_add()
25358 * @see elm_calendar_mark_del()
25359 * @see elm_calendar_marks_clear()
25361 * @ingroup Calendar
25363 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25366 * Draw calendar marks.
25368 * @param obj The calendar object.
25370 * Should be used after adding, removing or clearing marks.
25371 * It will go through the entire marks list updating the calendar.
25372 * If lots of marks will be added, add all the marks and then call
25375 * When the month is changed, i.e. user selects next or previous month,
25376 * marks will be drawed.
25378 * @see elm_calendar_mark_add()
25379 * @see elm_calendar_mark_del()
25380 * @see elm_calendar_marks_clear()
25382 * @ref calendar_example_06
25384 * @ingroup Calendar
25386 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25387 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25388 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25389 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25392 * Set a day text color to the same that represents Saturdays.
25394 * @param obj The calendar object.
25395 * @param pos The text position. Position is the cell counter, from left
25396 * to right, up to down. It starts on 0 and ends on 41.
25398 * @deprecated use elm_calendar_mark_add() instead like:
25401 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25402 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25405 * @see elm_calendar_mark_add()
25407 * @ingroup Calendar
25409 EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25412 * Set a day text color to the same that represents Sundays.
25414 * @param obj The calendar object.
25415 * @param pos The text position. Position is the cell counter, from left
25416 * to right, up to down. It starts on 0 and ends on 41.
25418 * @deprecated use elm_calendar_mark_add() instead like:
25421 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25422 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25425 * @see elm_calendar_mark_add()
25427 * @ingroup Calendar
25429 EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25432 * Set a day text color to the same that represents Weekdays.
25434 * @param obj The calendar object
25435 * @param pos The text position. Position is the cell counter, from left
25436 * to right, up to down. It starts on 0 and ends on 41.
25438 * @deprecated use elm_calendar_mark_add() instead like:
25441 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25443 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25444 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25445 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25446 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25447 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25448 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25449 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25450 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25451 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25454 * @see elm_calendar_mark_add()
25456 * @ingroup Calendar
25458 EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25461 * Set the interval on time updates for an user mouse button hold
25462 * on calendar widgets' month selection.
25464 * @param obj The calendar object
25465 * @param interval The (first) interval value in seconds
25467 * This interval value is @b decreased while the user holds the
25468 * mouse pointer either selecting next or previous month.
25470 * This helps the user to get to a given month distant from the
25471 * current one easier/faster, as it will start to change quicker and
25472 * quicker on mouse button holds.
25474 * The calculation for the next change interval value, starting from
25475 * the one set with this call, is the previous interval divided by
25476 * 1.05, so it decreases a little bit.
25478 * The default starting interval value for automatic changes is
25481 * @see elm_calendar_interval_get()
25483 * @ingroup Calendar
25485 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25488 * Get the interval on time updates for an user mouse button hold
25489 * on calendar widgets' month selection.
25491 * @param obj The calendar object
25492 * @return The (first) interval value, in seconds, set on it
25494 * @see elm_calendar_interval_set() for more details
25496 * @ingroup Calendar
25498 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25505 * @defgroup Diskselector Diskselector
25506 * @ingroup Elementary
25508 * @image html img/widget/diskselector/preview-00.png
25509 * @image latex img/widget/diskselector/preview-00.eps
25511 * A diskselector is a kind of list widget. It scrolls horizontally,
25512 * and can contain label and icon objects. Three items are displayed
25513 * with the selected one in the middle.
25515 * It can act like a circular list with round mode and labels can be
25516 * reduced for a defined length for side items.
25518 * Smart callbacks one can listen to:
25519 * - "selected" - when item is selected, i.e. scroller stops.
25521 * Available styles for it:
25524 * List of examples:
25525 * @li @ref diskselector_example_01
25526 * @li @ref diskselector_example_02
25530 * @addtogroup Diskselector
25534 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(). */
25537 * Add a new diskselector widget to the given parent Elementary
25538 * (container) object.
25540 * @param parent The parent object.
25541 * @return a new diskselector widget handle or @c NULL, on errors.
25543 * This function inserts a new diskselector widget on the canvas.
25545 * @ingroup Diskselector
25547 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25550 * Enable or disable round mode.
25552 * @param obj The diskselector object.
25553 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25556 * Disabled by default. If round mode is enabled the items list will
25557 * work like a circle list, so when the user reaches the last item,
25558 * the first one will popup.
25560 * @see elm_diskselector_round_get()
25562 * @ingroup Diskselector
25564 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25567 * Get a value whether round mode is enabled or not.
25569 * @see elm_diskselector_round_set() for details.
25571 * @param obj The diskselector object.
25572 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25573 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25575 * @ingroup Diskselector
25577 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25580 * Get the side labels max length.
25582 * @deprecated use elm_diskselector_side_label_length_get() instead:
25584 * @param obj The diskselector object.
25585 * @return The max length defined for side labels, or 0 if not a valid
25588 * @ingroup Diskselector
25590 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25593 * Set the side labels max length.
25595 * @deprecated use elm_diskselector_side_label_length_set() instead:
25597 * @param obj The diskselector object.
25598 * @param len The max length defined for side labels.
25600 * @ingroup Diskselector
25602 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25605 * Get the side labels max length.
25607 * @see elm_diskselector_side_label_length_set() for details.
25609 * @param obj The diskselector object.
25610 * @return The max length defined for side labels, or 0 if not a valid
25613 * @ingroup Diskselector
25615 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25618 * Set the side labels max length.
25620 * @param obj The diskselector object.
25621 * @param len The max length defined for side labels.
25623 * Length is the number of characters of items' label that will be
25624 * visible when it's set on side positions. It will just crop
25625 * the string after defined size. E.g.:
25627 * An item with label "January" would be displayed on side position as
25628 * "Jan" if max length is set to 3, or "Janu", if this property
25631 * When it's selected, the entire label will be displayed, except for
25632 * width restrictions. In this case label will be cropped and "..."
25633 * will be concatenated.
25635 * Default side label max length is 3.
25637 * This property will be applyed over all items, included before or
25638 * later this function call.
25640 * @ingroup Diskselector
25642 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25645 * Set the number of items to be displayed.
25647 * @param obj The diskselector object.
25648 * @param num The number of items the diskselector will display.
25650 * Default value is 3, and also it's the minimun. If @p num is less
25651 * than 3, it will be set to 3.
25653 * Also, it can be set on theme, using data item @c display_item_num
25654 * on group "elm/diskselector/item/X", where X is style set.
25657 * group { name: "elm/diskselector/item/X";
25659 * item: "display_item_num" "5";
25662 * @ingroup Diskselector
25664 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25667 * Get the number of items in the diskselector object.
25669 * @param obj The diskselector object.
25671 * @ingroup Diskselector
25673 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25676 * Set bouncing behaviour when the scrolled content reaches an edge.
25678 * Tell the internal scroller object whether it should bounce or not
25679 * when it reaches the respective edges for each axis.
25681 * @param obj The diskselector object.
25682 * @param h_bounce Whether to bounce or not in the horizontal axis.
25683 * @param v_bounce Whether to bounce or not in the vertical axis.
25685 * @see elm_scroller_bounce_set()
25687 * @ingroup Diskselector
25689 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25692 * Get the bouncing behaviour of the internal scroller.
25694 * Get whether the internal scroller should bounce when the edge of each
25695 * axis is reached scrolling.
25697 * @param obj The diskselector object.
25698 * @param h_bounce Pointer where to store the bounce state of the horizontal
25700 * @param v_bounce Pointer where to store the bounce state of the vertical
25703 * @see elm_scroller_bounce_get()
25704 * @see elm_diskselector_bounce_set()
25706 * @ingroup Diskselector
25708 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25711 * Get the scrollbar policy.
25713 * @see elm_diskselector_scroller_policy_get() for details.
25715 * @param obj The diskselector object.
25716 * @param policy_h Pointer where to store horizontal scrollbar policy.
25717 * @param policy_v Pointer where to store vertical scrollbar policy.
25719 * @ingroup Diskselector
25721 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);
25724 * Set the scrollbar policy.
25726 * @param obj The diskselector object.
25727 * @param policy_h Horizontal scrollbar policy.
25728 * @param policy_v Vertical scrollbar policy.
25730 * This sets the scrollbar visibility policy for the given scroller.
25731 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
25732 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
25733 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
25734 * This applies respectively for the horizontal and vertical scrollbars.
25736 * The both are disabled by default, i.e., are set to
25737 * #ELM_SCROLLER_POLICY_OFF.
25739 * @ingroup Diskselector
25741 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
25744 * Remove all diskselector's items.
25746 * @param obj The diskselector object.
25748 * @see elm_diskselector_item_del()
25749 * @see elm_diskselector_item_append()
25751 * @ingroup Diskselector
25753 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25756 * Get a list of all the diskselector items.
25758 * @param obj The diskselector object.
25759 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
25760 * or @c NULL on failure.
25762 * @see elm_diskselector_item_append()
25763 * @see elm_diskselector_item_del()
25764 * @see elm_diskselector_clear()
25766 * @ingroup Diskselector
25768 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25771 * Appends a new item to the diskselector object.
25773 * @param obj The diskselector object.
25774 * @param label The label of the diskselector item.
25775 * @param icon The icon object to use at left side of the item. An
25776 * icon can be any Evas object, but usually it is an icon created
25777 * with elm_icon_add().
25778 * @param func The function to call when the item is selected.
25779 * @param data The data to associate with the item for related callbacks.
25781 * @return The created item or @c NULL upon failure.
25783 * A new item will be created and appended to the diskselector, i.e., will
25784 * be set as last item. Also, if there is no selected item, it will
25785 * be selected. This will always happens for the first appended item.
25787 * If no icon is set, label will be centered on item position, otherwise
25788 * the icon will be placed at left of the label, that will be shifted
25791 * Items created with this method can be deleted with
25792 * elm_diskselector_item_del().
25794 * Associated @p data can be properly freed when item is deleted if a
25795 * callback function is set with elm_diskselector_item_del_cb_set().
25797 * If a function is passed as argument, it will be called everytime this item
25798 * is selected, i.e., the user stops the diskselector with this
25799 * item on center position. If such function isn't needed, just passing
25800 * @c NULL as @p func is enough. The same should be done for @p data.
25802 * Simple example (with no function callback or data associated):
25804 * disk = elm_diskselector_add(win);
25805 * ic = elm_icon_add(win);
25806 * elm_icon_file_set(ic, "path/to/image", NULL);
25807 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25808 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
25811 * @see elm_diskselector_item_del()
25812 * @see elm_diskselector_item_del_cb_set()
25813 * @see elm_diskselector_clear()
25814 * @see elm_icon_add()
25816 * @ingroup Diskselector
25818 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);
25822 * Delete them item from the diskselector.
25824 * @param it The item of diskselector to be deleted.
25826 * If deleting all diskselector items is required, elm_diskselector_clear()
25827 * should be used instead of getting items list and deleting each one.
25829 * @see elm_diskselector_clear()
25830 * @see elm_diskselector_item_append()
25831 * @see elm_diskselector_item_del_cb_set()
25833 * @ingroup Diskselector
25835 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25838 * Set the function called when a diskselector item is freed.
25840 * @param it The item to set the callback on
25841 * @param func The function called
25843 * If there is a @p func, then it will be called prior item's memory release.
25844 * That will be called with the following arguments:
25846 * @li item's Evas object;
25849 * This way, a data associated to a diskselector item could be properly
25852 * @ingroup Diskselector
25854 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
25857 * Get the data associated to the item.
25859 * @param it The diskselector item
25860 * @return The data associated to @p it
25862 * The return value is a pointer to data associated to @p item when it was
25863 * created, with function elm_diskselector_item_append(). If no data
25864 * was passed as argument, it will return @c NULL.
25866 * @see elm_diskselector_item_append()
25868 * @ingroup Diskselector
25870 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25873 * Set the icon associated to the item.
25875 * @param it The diskselector item
25876 * @param icon The icon object to associate with @p it
25878 * The icon object to use at left side of the item. An
25879 * icon can be any Evas object, but usually it is an icon created
25880 * with elm_icon_add().
25882 * Once the icon object is set, a previously set one will be deleted.
25883 * @warning Setting the same icon for two items will cause the icon to
25884 * dissapear from the first item.
25886 * If an icon was passed as argument on item creation, with function
25887 * elm_diskselector_item_append(), it will be already
25888 * associated to the item.
25890 * @see elm_diskselector_item_append()
25891 * @see elm_diskselector_item_icon_get()
25893 * @ingroup Diskselector
25895 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
25898 * Get the icon associated to the item.
25900 * @param it The diskselector item
25901 * @return The icon associated to @p it
25903 * The return value is a pointer to the icon associated to @p item when it was
25904 * created, with function elm_diskselector_item_append(), or later
25905 * with function elm_diskselector_item_icon_set. If no icon
25906 * was passed as argument, it will return @c NULL.
25908 * @see elm_diskselector_item_append()
25909 * @see elm_diskselector_item_icon_set()
25911 * @ingroup Diskselector
25913 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25916 * Set the label of item.
25918 * @param it The item of diskselector.
25919 * @param label The label of item.
25921 * The label to be displayed by the item.
25923 * If no icon is set, label will be centered on item position, otherwise
25924 * the icon will be placed at left of the label, that will be shifted
25927 * An item with label "January" would be displayed on side position as
25928 * "Jan" if max length is set to 3 with function
25929 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
25932 * When this @p item is selected, the entire label will be displayed,
25933 * except for width restrictions.
25934 * In this case label will be cropped and "..." will be concatenated,
25935 * but only for display purposes. It will keep the entire string, so
25936 * if diskselector is resized the remaining characters will be displayed.
25938 * If a label was passed as argument on item creation, with function
25939 * elm_diskselector_item_append(), it will be already
25940 * displayed by the item.
25942 * @see elm_diskselector_side_label_lenght_set()
25943 * @see elm_diskselector_item_label_get()
25944 * @see elm_diskselector_item_append()
25946 * @ingroup Diskselector
25948 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
25951 * Get the label of item.
25953 * @param it The item of diskselector.
25954 * @return The label of item.
25956 * The return value is a pointer to the label associated to @p item when it was
25957 * created, with function elm_diskselector_item_append(), or later
25958 * with function elm_diskselector_item_label_set. If no label
25959 * was passed as argument, it will return @c NULL.
25961 * @see elm_diskselector_item_label_set() for more details.
25962 * @see elm_diskselector_item_append()
25964 * @ingroup Diskselector
25966 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25969 * Get the selected item.
25971 * @param obj The diskselector object.
25972 * @return The selected diskselector item.
25974 * The selected item can be unselected with function
25975 * elm_diskselector_item_selected_set(), and the first item of
25976 * diskselector will be selected.
25978 * The selected item always will be centered on diskselector, with
25979 * full label displayed, i.e., max lenght set to side labels won't
25980 * apply on the selected item. More details on
25981 * elm_diskselector_side_label_length_set().
25983 * @ingroup Diskselector
25985 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25988 * Set the selected state of an item.
25990 * @param it The diskselector item
25991 * @param selected The selected state
25993 * This sets the selected state of the given item @p it.
25994 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
25996 * If a new item is selected the previosly selected will be unselected.
25997 * Previoulsy selected item can be get with function
25998 * elm_diskselector_selected_item_get().
26000 * If the item @p it is unselected, the first item of diskselector will
26003 * Selected items will be visible on center position of diskselector.
26004 * So if it was on another position before selected, or was invisible,
26005 * diskselector will animate items until the selected item reaches center
26008 * @see elm_diskselector_item_selected_get()
26009 * @see elm_diskselector_selected_item_get()
26011 * @ingroup Diskselector
26013 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26016 * Get whether the @p item is selected or not.
26018 * @param it The diskselector item.
26019 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26020 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26022 * @see elm_diskselector_selected_item_set() for details.
26023 * @see elm_diskselector_item_selected_get()
26025 * @ingroup Diskselector
26027 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26030 * Get the first item of the diskselector.
26032 * @param obj The diskselector object.
26033 * @return The first item, or @c NULL if none.
26035 * The list of items follows append order. So it will return the first
26036 * item appended to the widget that wasn't deleted.
26038 * @see elm_diskselector_item_append()
26039 * @see elm_diskselector_items_get()
26041 * @ingroup Diskselector
26043 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26046 * Get the last item of the diskselector.
26048 * @param obj The diskselector object.
26049 * @return The last item, or @c NULL if none.
26051 * The list of items follows append order. So it will return last first
26052 * item appended to the widget that wasn't deleted.
26054 * @see elm_diskselector_item_append()
26055 * @see elm_diskselector_items_get()
26057 * @ingroup Diskselector
26059 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26062 * Get the item before @p item in diskselector.
26064 * @param it The diskselector item.
26065 * @return The item before @p item, or @c NULL if none or on failure.
26067 * The list of items follows append order. So it will return item appended
26068 * just before @p item and that wasn't deleted.
26070 * If it is the first item, @c NULL will be returned.
26071 * First item can be get by elm_diskselector_first_item_get().
26073 * @see elm_diskselector_item_append()
26074 * @see elm_diskselector_items_get()
26076 * @ingroup Diskselector
26078 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26081 * Get the item after @p item in diskselector.
26083 * @param it The diskselector item.
26084 * @return The item after @p item, or @c NULL if none or on failure.
26086 * The list of items follows append order. So it will return item appended
26087 * just after @p item and that wasn't deleted.
26089 * If it is the last item, @c NULL will be returned.
26090 * Last item can be get by elm_diskselector_last_item_get().
26092 * @see elm_diskselector_item_append()
26093 * @see elm_diskselector_items_get()
26095 * @ingroup Diskselector
26097 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26100 * Set the text to be shown in the diskselector item.
26102 * @param item Target item
26103 * @param text The text to set in the content
26105 * Setup the text as tooltip to object. The item can have only one tooltip,
26106 * so any previous tooltip data is removed.
26108 * @see elm_object_tooltip_text_set() for more details.
26110 * @ingroup Diskselector
26112 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26115 * Set the content to be shown in the tooltip item.
26117 * Setup the tooltip to item. The item can have only one tooltip,
26118 * so any previous tooltip data is removed. @p func(with @p data) will
26119 * be called every time that need show the tooltip and it should
26120 * return a valid Evas_Object. This object is then managed fully by
26121 * tooltip system and is deleted when the tooltip is gone.
26123 * @param item the diskselector item being attached a tooltip.
26124 * @param func the function used to create the tooltip contents.
26125 * @param data what to provide to @a func as callback data/context.
26126 * @param del_cb called when data is not needed anymore, either when
26127 * another callback replaces @p func, the tooltip is unset with
26128 * elm_diskselector_item_tooltip_unset() or the owner @a item
26129 * dies. This callback receives as the first parameter the
26130 * given @a data, and @c event_info is the item.
26132 * @see elm_object_tooltip_content_cb_set() for more details.
26134 * @ingroup Diskselector
26136 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);
26139 * Unset tooltip from item.
26141 * @param item diskselector item to remove previously set tooltip.
26143 * Remove tooltip from item. The callback provided as del_cb to
26144 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26145 * it is not used anymore.
26147 * @see elm_object_tooltip_unset() for more details.
26148 * @see elm_diskselector_item_tooltip_content_cb_set()
26150 * @ingroup Diskselector
26152 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26156 * Sets a different style for this item tooltip.
26158 * @note before you set a style you should define a tooltip with
26159 * elm_diskselector_item_tooltip_content_cb_set() or
26160 * elm_diskselector_item_tooltip_text_set()
26162 * @param item diskselector item with tooltip already set.
26163 * @param style the theme style to use (default, transparent, ...)
26165 * @see elm_object_tooltip_style_set() for more details.
26167 * @ingroup Diskselector
26169 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26172 * Get the style for this item tooltip.
26174 * @param item diskselector item with tooltip already set.
26175 * @return style the theme style in use, defaults to "default". If the
26176 * object does not have a tooltip set, then NULL is returned.
26178 * @see elm_object_tooltip_style_get() for more details.
26179 * @see elm_diskselector_item_tooltip_style_set()
26181 * @ingroup Diskselector
26183 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26186 * Set the cursor to be shown when mouse is over the diskselector item
26188 * @param item Target item
26189 * @param cursor the cursor name to be used.
26191 * @see elm_object_cursor_set() for more details.
26193 * @ingroup Diskselector
26195 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26198 * Get the cursor to be shown when mouse is over the diskselector item
26200 * @param item diskselector item with cursor already set.
26201 * @return the cursor name.
26203 * @see elm_object_cursor_get() for more details.
26204 * @see elm_diskselector_cursor_set()
26206 * @ingroup Diskselector
26208 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26212 * Unset the cursor to be shown when mouse is over the diskselector item
26214 * @param item Target item
26216 * @see elm_object_cursor_unset() for more details.
26217 * @see elm_diskselector_cursor_set()
26219 * @ingroup Diskselector
26221 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26224 * Sets a different style for this item cursor.
26226 * @note before you set a style you should define a cursor with
26227 * elm_diskselector_item_cursor_set()
26229 * @param item diskselector item with cursor already set.
26230 * @param style the theme style to use (default, transparent, ...)
26232 * @see elm_object_cursor_style_set() for more details.
26234 * @ingroup Diskselector
26236 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26240 * Get the style for this item cursor.
26242 * @param item diskselector item with cursor already set.
26243 * @return style the theme style in use, defaults to "default". If the
26244 * object does not have a cursor set, then @c NULL is returned.
26246 * @see elm_object_cursor_style_get() for more details.
26247 * @see elm_diskselector_item_cursor_style_set()
26249 * @ingroup Diskselector
26251 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26255 * Set if the cursor set should be searched on the theme or should use
26256 * the provided by the engine, only.
26258 * @note before you set if should look on theme you should define a cursor
26259 * with elm_diskselector_item_cursor_set().
26260 * By default it will only look for cursors provided by the engine.
26262 * @param item widget item with cursor already set.
26263 * @param engine_only boolean to define if cursors set with
26264 * elm_diskselector_item_cursor_set() should be searched only
26265 * between cursors provided by the engine or searched on widget's
26268 * @see elm_object_cursor_engine_only_set() for more details.
26270 * @ingroup Diskselector
26272 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26275 * Get the cursor engine only usage for this item cursor.
26277 * @param item widget item with cursor already set.
26278 * @return engine_only boolean to define it cursors should be looked only
26279 * between the provided by the engine or searched on widget's theme as well.
26280 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26282 * @see elm_object_cursor_engine_only_get() for more details.
26283 * @see elm_diskselector_item_cursor_engine_only_set()
26285 * @ingroup Diskselector
26287 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26294 * @defgroup Colorselector Colorselector
26298 * @image html img/widget/colorselector/preview-00.png
26299 * @image latex img/widget/colorselector/preview-00.eps
26301 * @brief Widget for user to select a color.
26303 * Signals that you can add callbacks for are:
26304 * "changed" - When the color value changes(event_info is NULL).
26306 * See @ref tutorial_colorselector.
26309 * @brief Add a new colorselector to the parent
26311 * @param parent The parent object
26312 * @return The new object or NULL if it cannot be created
26314 * @ingroup Colorselector
26316 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26318 * Set a color for the colorselector
26320 * @param obj Colorselector object
26321 * @param r r-value of color
26322 * @param g g-value of color
26323 * @param b b-value of color
26324 * @param a a-value of color
26326 * @ingroup Colorselector
26328 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26330 * Get a color from the colorselector
26332 * @param obj Colorselector object
26333 * @param r integer pointer for r-value of color
26334 * @param g integer pointer for g-value of color
26335 * @param b integer pointer for b-value of color
26336 * @param a integer pointer for a-value of color
26338 * @ingroup Colorselector
26340 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26346 * @defgroup Ctxpopup Ctxpopup
26348 * @image html img/widget/ctxpopup/preview-00.png
26349 * @image latex img/widget/ctxpopup/preview-00.eps
26351 * @brief Context popup widet.
26353 * A ctxpopup is a widget that, when shown, pops up a list of items.
26354 * It automatically chooses an area inside its parent object's view
26355 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26356 * optimally fit into it. In the default theme, it will also point an
26357 * arrow to it's top left position at the time one shows it. Ctxpopup
26358 * items have a label and/or an icon. It is intended for a small
26359 * number of items (hence the use of list, not genlist).
26361 * @note Ctxpopup is a especialization of @ref Hover.
26363 * Signals that you can add callbacks for are:
26364 * "dismissed" - the ctxpopup was dismissed
26366 * Default contents parts of the ctxpopup widget that you can use for are:
26367 * @li "elm.swallow.content" - A content of the ctxpopup
26369 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26372 typedef enum _Elm_Ctxpopup_Direction
26374 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26376 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26377 the clicked area */
26378 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26379 the clicked area */
26380 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26382 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26383 } Elm_Ctxpopup_Direction;
26384 #define Elm_Ctxpopup_Item Elm_Object_Item
26387 * @brief Add a new Ctxpopup object to the parent.
26389 * @param parent Parent object
26390 * @return New object or @c NULL, if it cannot be created
26392 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26394 * @brief Set the Ctxpopup's parent
26396 * @param obj The ctxpopup object
26397 * @param area The parent to use
26399 * Set the parent object.
26401 * @note elm_ctxpopup_add() will automatically call this function
26402 * with its @c parent argument.
26404 * @see elm_ctxpopup_add()
26405 * @see elm_hover_parent_set()
26407 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26409 * @brief Get the Ctxpopup's parent
26411 * @param obj The ctxpopup object
26413 * @see elm_ctxpopup_hover_parent_set() for more information
26415 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26417 * @brief Clear all items in the given ctxpopup object.
26419 * @param obj Ctxpopup object
26421 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26423 * @brief Change the ctxpopup's orientation to horizontal or vertical.
26425 * @param obj Ctxpopup object
26426 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26428 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26430 * @brief Get the value of current ctxpopup object's orientation.
26432 * @param obj Ctxpopup object
26433 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26435 * @see elm_ctxpopup_horizontal_set()
26437 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26439 * @brief Add a new item to a ctxpopup object.
26441 * @param obj Ctxpopup object
26442 * @param icon Icon to be set on new item
26443 * @param label The Label of the new item
26444 * @param func Convenience function called when item selected
26445 * @param data Data passed to @p func
26446 * @return A handle to the item added or @c NULL, on errors
26448 * @warning Ctxpopup can't hold both an item list and a content at the same
26449 * time. When an item is added, any previous content will be removed.
26451 * @see elm_ctxpopup_content_set()
26453 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);
26455 * @brief Delete the given item in a ctxpopup object.
26457 * @param it Ctxpopup item to be deleted
26459 * @see elm_ctxpopup_item_append()
26461 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26463 * @brief Set the ctxpopup item's state as disabled or enabled.
26465 * @param it Ctxpopup item to be enabled/disabled
26466 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26468 * When disabled the item is greyed out to indicate it's state.
26470 EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26472 * @brief Get the ctxpopup item's disabled/enabled state.
26474 * @param it Ctxpopup item to be enabled/disabled
26475 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26477 * @see elm_ctxpopup_item_disabled_set()
26479 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26481 * @brief Get the icon object for the given ctxpopup item.
26483 * @param it Ctxpopup item
26484 * @return icon object or @c NULL, if the item does not have icon or an error
26487 * @see elm_ctxpopup_item_append()
26488 * @see elm_ctxpopup_item_icon_set()
26490 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26492 * @brief Sets the side icon associated with the ctxpopup item
26494 * @param it Ctxpopup item
26495 * @param icon Icon object to be set
26497 * Once the icon object is set, a previously set one will be deleted.
26498 * @warning Setting the same icon for two items will cause the icon to
26499 * dissapear from the first item.
26501 * @see elm_ctxpopup_item_append()
26503 EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26505 * @brief Get the label for the given ctxpopup item.
26507 * @param it Ctxpopup item
26508 * @return label string or @c NULL, if the item does not have label or an
26511 * @see elm_ctxpopup_item_append()
26512 * @see elm_ctxpopup_item_label_set()
26514 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26516 * @brief (Re)set the label on the given ctxpopup item.
26518 * @param it Ctxpopup item
26519 * @param label String to set as label
26521 EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26523 * @brief Set an elm widget as the content of the ctxpopup.
26525 * @param obj Ctxpopup object
26526 * @param content Content to be swallowed
26528 * If the content object is already set, a previous one will bedeleted. If
26529 * you want to keep that old content object, use the
26530 * elm_ctxpopup_content_unset() function.
26532 * @deprecated use elm_object_content_set()
26534 * @warning Ctxpopup can't hold both a item list and a content at the same
26535 * time. When a content is set, any previous items will be removed.
26537 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26539 * @brief Unset the ctxpopup content
26541 * @param obj Ctxpopup object
26542 * @return The content that was being used
26544 * Unparent and return the content object which was set for this widget.
26546 * @deprecated use elm_object_content_unset()
26548 * @see elm_ctxpopup_content_set()
26550 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26552 * @brief Set the direction priority of a ctxpopup.
26554 * @param obj Ctxpopup object
26555 * @param first 1st priority of direction
26556 * @param second 2nd priority of direction
26557 * @param third 3th priority of direction
26558 * @param fourth 4th priority of direction
26560 * This functions gives a chance to user to set the priority of ctxpopup
26561 * showing direction. This doesn't guarantee the ctxpopup will appear in the
26562 * requested direction.
26564 * @see Elm_Ctxpopup_Direction
26566 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);
26568 * @brief Get the direction priority of a ctxpopup.
26570 * @param obj Ctxpopup object
26571 * @param first 1st priority of direction to be returned
26572 * @param second 2nd priority of direction to be returned
26573 * @param third 3th priority of direction to be returned
26574 * @param fourth 4th priority of direction to be returned
26576 * @see elm_ctxpopup_direction_priority_set() for more information.
26578 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);
26581 * @brief Get the current direction of a ctxpopup.
26583 * @param obj Ctxpopup object
26584 * @return current direction of a ctxpopup
26586 * @warning Once the ctxpopup showed up, the direction would be determined
26588 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26597 * @defgroup Transit Transit
26598 * @ingroup Elementary
26600 * Transit is designed to apply various animated transition effects to @c
26601 * Evas_Object, such like translation, rotation, etc. For using these
26602 * effects, create an @ref Elm_Transit and add the desired transition effects.
26604 * Once the effects are added into transit, they will be automatically
26605 * managed (their callback will be called until the duration is ended, and
26606 * they will be deleted on completion).
26610 * Elm_Transit *trans = elm_transit_add();
26611 * elm_transit_object_add(trans, obj);
26612 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26613 * elm_transit_duration_set(transit, 1);
26614 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26615 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26616 * elm_transit_repeat_times_set(transit, 3);
26619 * Some transition effects are used to change the properties of objects. They
26621 * @li @ref elm_transit_effect_translation_add
26622 * @li @ref elm_transit_effect_color_add
26623 * @li @ref elm_transit_effect_rotation_add
26624 * @li @ref elm_transit_effect_wipe_add
26625 * @li @ref elm_transit_effect_zoom_add
26626 * @li @ref elm_transit_effect_resizing_add
26628 * Other transition effects are used to make one object disappear and another
26629 * object appear on its old place. These effects are:
26631 * @li @ref elm_transit_effect_flip_add
26632 * @li @ref elm_transit_effect_resizable_flip_add
26633 * @li @ref elm_transit_effect_fade_add
26634 * @li @ref elm_transit_effect_blend_add
26636 * It's also possible to make a transition chain with @ref
26637 * elm_transit_chain_transit_add.
26639 * @warning We strongly recommend to use elm_transit just when edje can not do
26640 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26641 * animations can be manipulated inside the theme.
26643 * List of examples:
26644 * @li @ref transit_example_01_explained
26645 * @li @ref transit_example_02_explained
26646 * @li @ref transit_example_03_c
26647 * @li @ref transit_example_04_c
26653 * @enum Elm_Transit_Tween_Mode
26655 * The type of acceleration used in the transition.
26659 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26660 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26661 over time, then decrease again
26663 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26665 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26667 } Elm_Transit_Tween_Mode;
26670 * @enum Elm_Transit_Effect_Flip_Axis
26672 * The axis where flip effect should be applied.
26676 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26677 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26678 } Elm_Transit_Effect_Flip_Axis;
26680 * @enum Elm_Transit_Effect_Wipe_Dir
26682 * The direction where the wipe effect should occur.
26686 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26687 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26688 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26689 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26690 } Elm_Transit_Effect_Wipe_Dir;
26691 /** @enum Elm_Transit_Effect_Wipe_Type
26693 * Whether the wipe effect should show or hide the object.
26697 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26699 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26701 } Elm_Transit_Effect_Wipe_Type;
26704 * @typedef Elm_Transit
26706 * The Transit created with elm_transit_add(). This type has the information
26707 * about the objects which the transition will be applied, and the
26708 * transition effects that will be used. It also contains info about
26709 * duration, number of repetitions, auto-reverse, etc.
26711 typedef struct _Elm_Transit Elm_Transit;
26712 typedef void Elm_Transit_Effect;
26714 * @typedef Elm_Transit_Effect_Transition_Cb
26716 * Transition callback called for this effect on each transition iteration.
26718 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
26720 * Elm_Transit_Effect_End_Cb
26722 * Transition callback called for this effect when the transition is over.
26724 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
26727 * Elm_Transit_Del_Cb
26729 * A callback called when the transit is deleted.
26731 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
26736 * @note Is not necessary to delete the transit object, it will be deleted at
26737 * the end of its operation.
26738 * @note The transit will start playing when the program enter in the main loop, is not
26739 * necessary to give a start to the transit.
26741 * @return The transit object.
26745 EAPI Elm_Transit *elm_transit_add(void);
26748 * Stops the animation and delete the @p transit object.
26750 * Call this function if you wants to stop the animation before the duration
26751 * time. Make sure the @p transit object is still alive with
26752 * elm_transit_del_cb_set() function.
26753 * All added effects will be deleted, calling its repective data_free_cb
26754 * functions. The function setted by elm_transit_del_cb_set() will be called.
26756 * @see elm_transit_del_cb_set()
26758 * @param transit The transit object to be deleted.
26761 * @warning Just call this function if you are sure the transit is alive.
26763 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26766 * Add a new effect to the transit.
26768 * @note The cb function and the data are the key to the effect. If you try to
26769 * add an already added effect, nothing is done.
26770 * @note After the first addition of an effect in @p transit, if its
26771 * effect list become empty again, the @p transit will be killed by
26772 * elm_transit_del(transit) function.
26776 * Elm_Transit *transit = elm_transit_add();
26777 * elm_transit_effect_add(transit,
26778 * elm_transit_effect_blend_op,
26779 * elm_transit_effect_blend_context_new(),
26780 * elm_transit_effect_blend_context_free);
26783 * @param transit The transit object.
26784 * @param transition_cb The operation function. It is called when the
26785 * animation begins, it is the function that actually performs the animation.
26786 * It is called with the @p data, @p transit and the time progression of the
26787 * animation (a double value between 0.0 and 1.0).
26788 * @param effect The context data of the effect.
26789 * @param end_cb The function to free the context data, it will be called
26790 * at the end of the effect, it must finalize the animation and free the
26794 * @warning The transit free the context data at the and of the transition with
26795 * the data_free_cb function, do not use the context data in another transit.
26797 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);
26800 * Delete an added effect.
26802 * This function will remove the effect from the @p transit, calling the
26803 * data_free_cb to free the @p data.
26805 * @see elm_transit_effect_add()
26807 * @note If the effect is not found, nothing is done.
26808 * @note If the effect list become empty, this function will call
26809 * elm_transit_del(transit), that is, it will kill the @p transit.
26811 * @param transit The transit object.
26812 * @param transition_cb The operation function.
26813 * @param effect The context data of the effect.
26817 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);
26820 * Add new object to apply the effects.
26822 * @note After the first addition of an object in @p transit, if its
26823 * object list become empty again, the @p transit will be killed by
26824 * elm_transit_del(transit) function.
26825 * @note If the @p obj belongs to another transit, the @p obj will be
26826 * removed from it and it will only belong to the @p transit. If the old
26827 * transit stays without objects, it will die.
26828 * @note When you add an object into the @p transit, its state from
26829 * evas_object_pass_events_get(obj) is saved, and it is applied when the
26830 * transit ends, if you change this state whith evas_object_pass_events_set()
26831 * after add the object, this state will change again when @p transit stops to
26834 * @param transit The transit object.
26835 * @param obj Object to be animated.
26838 * @warning It is not allowed to add a new object after transit begins to go.
26840 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26843 * Removes an added object from the transit.
26845 * @note If the @p obj is not in the @p transit, nothing is done.
26846 * @note If the list become empty, this function will call
26847 * elm_transit_del(transit), that is, it will kill the @p transit.
26849 * @param transit The transit object.
26850 * @param obj Object to be removed from @p transit.
26853 * @warning It is not allowed to remove objects after transit begins to go.
26855 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26858 * Get the objects of the transit.
26860 * @param transit The transit object.
26861 * @return a Eina_List with the objects from the transit.
26865 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26868 * Enable/disable keeping up the objects states.
26869 * If it is not kept, the objects states will be reset when transition ends.
26871 * @note @p transit can not be NULL.
26872 * @note One state includes geometry, color, map data.
26874 * @param transit The transit object.
26875 * @param state_keep Keeping or Non Keeping.
26879 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
26882 * Get a value whether the objects states will be reset or not.
26884 * @note @p transit can not be NULL
26886 * @see elm_transit_objects_final_state_keep_set()
26888 * @param transit The transit object.
26889 * @return EINA_TRUE means the states of the objects will be reset.
26890 * If @p transit is NULL, EINA_FALSE is returned
26894 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26897 * Set the event enabled when transit is operating.
26899 * If @p enabled is EINA_TRUE, the objects of the transit will receives
26900 * events from mouse and keyboard during the animation.
26901 * @note When you add an object with elm_transit_object_add(), its state from
26902 * evas_object_pass_events_get(obj) is saved, and it is applied when the
26903 * transit ends, if you change this state with evas_object_pass_events_set()
26904 * after adding the object, this state will change again when @p transit stops
26907 * @param transit The transit object.
26908 * @param enabled Events are received when enabled is @c EINA_TRUE, and
26909 * ignored otherwise.
26913 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26916 * Get the value of event enabled status.
26918 * @see elm_transit_event_enabled_set()
26920 * @param transit The Transit object
26921 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
26922 * EINA_FALSE is returned
26926 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26929 * Set the user-callback function when the transit is deleted.
26931 * @note Using this function twice will overwrite the first function setted.
26932 * @note the @p transit object will be deleted after call @p cb function.
26934 * @param transit The transit object.
26935 * @param cb Callback function pointer. This function will be called before
26936 * the deletion of the transit.
26937 * @param data Callback funtion user data. It is the @p op parameter.
26941 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
26944 * Set reverse effect automatically.
26946 * If auto reverse is setted, after running the effects with the progress
26947 * parameter from 0 to 1, it will call the effecs again with the progress
26948 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
26949 * where the duration was setted with the function elm_transit_add and
26950 * the repeat with the function elm_transit_repeat_times_set().
26952 * @param transit The transit object.
26953 * @param reverse EINA_TRUE means the auto_reverse is on.
26957 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
26960 * Get if the auto reverse is on.
26962 * @see elm_transit_auto_reverse_set()
26964 * @param transit The transit object.
26965 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
26966 * EINA_FALSE is returned
26970 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26973 * Set the transit repeat count. Effect will be repeated by repeat count.
26975 * This function sets the number of repetition the transit will run after
26976 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
26977 * If the @p repeat is a negative number, it will repeat infinite times.
26979 * @note If this function is called during the transit execution, the transit
26980 * will run @p repeat times, ignoring the times it already performed.
26982 * @param transit The transit object
26983 * @param repeat Repeat count
26987 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
26990 * Get the transit repeat count.
26992 * @see elm_transit_repeat_times_set()
26994 * @param transit The Transit object.
26995 * @return The repeat count. If @p transit is NULL
27000 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27003 * Set the transit animation acceleration type.
27005 * This function sets the tween mode of the transit that can be:
27006 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27007 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27008 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27009 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27011 * @param transit The transit object.
27012 * @param tween_mode The tween type.
27016 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27019 * Get the transit animation acceleration type.
27021 * @note @p transit can not be NULL
27023 * @param transit The transit object.
27024 * @return The tween type. If @p transit is NULL
27025 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27029 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27032 * Set the transit animation time
27034 * @note @p transit can not be NULL
27036 * @param transit The transit object.
27037 * @param duration The animation time.
27041 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27044 * Get the transit animation time
27046 * @note @p transit can not be NULL
27048 * @param transit The transit object.
27050 * @return The transit animation time.
27054 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27057 * Starts the transition.
27058 * Once this API is called, the transit begins to measure the time.
27060 * @note @p transit can not be NULL
27062 * @param transit The transit object.
27066 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27069 * Pause/Resume the transition.
27071 * If you call elm_transit_go again, the transit will be started from the
27072 * beginning, and will be unpaused.
27074 * @note @p transit can not be NULL
27076 * @param transit The transit object.
27077 * @param paused Whether the transition should be paused or not.
27081 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27084 * Get the value of paused status.
27086 * @see elm_transit_paused_set()
27088 * @note @p transit can not be NULL
27090 * @param transit The transit object.
27091 * @return EINA_TRUE means transition is paused. If @p transit is NULL
27092 * EINA_FALSE is returned
27096 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27099 * Get the time progression of the animation (a double value between 0.0 and 1.0).
27101 * The value returned is a fraction (current time / total time). It
27102 * represents the progression position relative to the total.
27104 * @note @p transit can not be NULL
27106 * @param transit The transit object.
27108 * @return The time progression value. If @p transit is NULL
27113 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27116 * Makes the chain relationship between two transits.
27118 * @note @p transit can not be NULL. Transit would have multiple chain transits.
27119 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27121 * @param transit The transit object.
27122 * @param chain_transit The chain transit object. This transit will be operated
27123 * after transit is done.
27125 * This function adds @p chain_transit transition to a chain after the @p
27126 * transit, and will be started as soon as @p transit ends. See @ref
27127 * transit_example_02_explained for a full example.
27131 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27134 * Cut off the chain relationship between two transits.
27136 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27137 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27139 * @param transit The transit object.
27140 * @param chain_transit The chain transit object.
27142 * This function remove the @p chain_transit transition from the @p transit.
27146 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27149 * Get the current chain transit list.
27151 * @note @p transit can not be NULL.
27153 * @param transit The transit object.
27154 * @return chain transit list.
27158 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
27161 * Add the Resizing Effect to Elm_Transit.
27163 * @note This API is one of the facades. It creates resizing effect context
27164 * and add it's required APIs to elm_transit_effect_add.
27166 * @see elm_transit_effect_add()
27168 * @param transit Transit object.
27169 * @param from_w Object width size when effect begins.
27170 * @param from_h Object height size when effect begins.
27171 * @param to_w Object width size when effect ends.
27172 * @param to_h Object height size when effect ends.
27173 * @return Resizing effect context data.
27177 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);
27180 * Add the Translation Effect to Elm_Transit.
27182 * @note This API is one of the facades. It creates translation effect context
27183 * and add it's required APIs to elm_transit_effect_add.
27185 * @see elm_transit_effect_add()
27187 * @param transit Transit object.
27188 * @param from_dx X Position variation when effect begins.
27189 * @param from_dy Y Position variation when effect begins.
27190 * @param to_dx X Position variation when effect ends.
27191 * @param to_dy Y Position variation when effect ends.
27192 * @return Translation effect context data.
27195 * @warning It is highly recommended just create a transit with this effect when
27196 * the window that the objects of the transit belongs has already been created.
27197 * This is because this effect needs the geometry information about the objects,
27198 * and if the window was not created yet, it can get a wrong information.
27200 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);
27203 * Add the Zoom Effect to Elm_Transit.
27205 * @note This API is one of the facades. It creates zoom effect context
27206 * and add it's required APIs to elm_transit_effect_add.
27208 * @see elm_transit_effect_add()
27210 * @param transit Transit object.
27211 * @param from_rate Scale rate when effect begins (1 is current rate).
27212 * @param to_rate Scale rate when effect ends.
27213 * @return Zoom effect context data.
27216 * @warning It is highly recommended just create a transit with this effect when
27217 * the window that the objects of the transit belongs has already been created.
27218 * This is because this effect needs the geometry information about the objects,
27219 * and if the window was not created yet, it can get a wrong information.
27221 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27224 * Add the Flip Effect to Elm_Transit.
27226 * @note This API is one of the facades. It creates flip effect context
27227 * and add it's required APIs to elm_transit_effect_add.
27228 * @note This effect is applied to each pair of objects in the order they are listed
27229 * in the transit list of objects. The first object in the pair will be the
27230 * "front" object and the second will be the "back" object.
27232 * @see elm_transit_effect_add()
27234 * @param transit Transit object.
27235 * @param axis Flipping Axis(X or Y).
27236 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27237 * @return Flip effect context data.
27240 * @warning It is highly recommended just create a transit with this effect when
27241 * the window that the objects of the transit belongs has already been created.
27242 * This is because this effect needs the geometry information about the objects,
27243 * and if the window was not created yet, it can get a wrong information.
27245 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27248 * Add the Resizable Flip Effect to Elm_Transit.
27250 * @note This API is one of the facades. It creates resizable flip effect context
27251 * and add it's required APIs to elm_transit_effect_add.
27252 * @note This effect is applied to each pair of objects in the order they are listed
27253 * in the transit list of objects. The first object in the pair will be the
27254 * "front" object and the second will be the "back" object.
27256 * @see elm_transit_effect_add()
27258 * @param transit Transit object.
27259 * @param axis Flipping Axis(X or Y).
27260 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27261 * @return Resizable flip effect context data.
27264 * @warning It is highly recommended just create a transit with this effect when
27265 * the window that the objects of the transit belongs has already been created.
27266 * This is because this effect needs the geometry information about the objects,
27267 * and if the window was not created yet, it can get a wrong information.
27269 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27272 * Add the Wipe Effect to Elm_Transit.
27274 * @note This API is one of the facades. It creates wipe effect context
27275 * and add it's required APIs to elm_transit_effect_add.
27277 * @see elm_transit_effect_add()
27279 * @param transit Transit object.
27280 * @param type Wipe type. Hide or show.
27281 * @param dir Wipe Direction.
27282 * @return Wipe effect context data.
27285 * @warning It is highly recommended just create a transit with this effect when
27286 * the window that the objects of the transit belongs has already been created.
27287 * This is because this effect needs the geometry information about the objects,
27288 * and if the window was not created yet, it can get a wrong information.
27290 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27293 * Add the Color Effect to Elm_Transit.
27295 * @note This API is one of the facades. It creates color effect context
27296 * and add it's required APIs to elm_transit_effect_add.
27298 * @see elm_transit_effect_add()
27300 * @param transit Transit object.
27301 * @param from_r RGB R when effect begins.
27302 * @param from_g RGB G when effect begins.
27303 * @param from_b RGB B when effect begins.
27304 * @param from_a RGB A when effect begins.
27305 * @param to_r RGB R when effect ends.
27306 * @param to_g RGB G when effect ends.
27307 * @param to_b RGB B when effect ends.
27308 * @param to_a RGB A when effect ends.
27309 * @return Color effect context data.
27313 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);
27316 * Add the Fade Effect to Elm_Transit.
27318 * @note This API is one of the facades. It creates fade effect context
27319 * and add it's required APIs to elm_transit_effect_add.
27320 * @note This effect is applied to each pair of objects in the order they are listed
27321 * in the transit list of objects. The first object in the pair will be the
27322 * "before" object and the second will be the "after" object.
27324 * @see elm_transit_effect_add()
27326 * @param transit Transit object.
27327 * @return Fade effect context data.
27330 * @warning It is highly recommended just create a transit with this effect when
27331 * the window that the objects of the transit belongs has already been created.
27332 * This is because this effect needs the color information about the objects,
27333 * and if the window was not created yet, it can get a wrong information.
27335 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27338 * Add the Blend Effect to Elm_Transit.
27340 * @note This API is one of the facades. It creates blend effect context
27341 * and add it's required APIs to elm_transit_effect_add.
27342 * @note This effect is applied to each pair of objects in the order they are listed
27343 * in the transit list of objects. The first object in the pair will be the
27344 * "before" object and the second will be the "after" object.
27346 * @see elm_transit_effect_add()
27348 * @param transit Transit object.
27349 * @return Blend effect context data.
27352 * @warning It is highly recommended just create a transit with this effect when
27353 * the window that the objects of the transit belongs has already been created.
27354 * This is because this effect needs the color information about the objects,
27355 * and if the window was not created yet, it can get a wrong information.
27357 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27360 * Add the Rotation Effect to Elm_Transit.
27362 * @note This API is one of the facades. It creates rotation effect context
27363 * and add it's required APIs to elm_transit_effect_add.
27365 * @see elm_transit_effect_add()
27367 * @param transit Transit object.
27368 * @param from_degree Degree when effect begins.
27369 * @param to_degree Degree when effect is ends.
27370 * @return Rotation effect context data.
27373 * @warning It is highly recommended just create a transit with this effect when
27374 * the window that the objects of the transit belongs has already been created.
27375 * This is because this effect needs the geometry information about the objects,
27376 * and if the window was not created yet, it can get a wrong information.
27378 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27381 * Add the ImageAnimation Effect to Elm_Transit.
27383 * @note This API is one of the facades. It creates image animation effect context
27384 * and add it's required APIs to elm_transit_effect_add.
27385 * The @p images parameter is a list images paths. This list and
27386 * its contents will be deleted at the end of the effect by
27387 * elm_transit_effect_image_animation_context_free() function.
27391 * char buf[PATH_MAX];
27392 * Eina_List *images = NULL;
27393 * Elm_Transit *transi = elm_transit_add();
27395 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27396 * images = eina_list_append(images, eina_stringshare_add(buf));
27398 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27399 * images = eina_list_append(images, eina_stringshare_add(buf));
27400 * elm_transit_effect_image_animation_add(transi, images);
27404 * @see elm_transit_effect_add()
27406 * @param transit Transit object.
27407 * @param images Eina_List of images file paths. This list and
27408 * its contents will be deleted at the end of the effect by
27409 * elm_transit_effect_image_animation_context_free() function.
27410 * @return Image Animation effect context data.
27414 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27420 typedef struct _Elm_Store Elm_Store;
27421 typedef struct _Elm_Store_DBsystem Elm_Store_DBsystem;
27422 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
27423 typedef struct _Elm_Store_Item Elm_Store_Item;
27424 typedef struct _Elm_Store_Item_DBsystem Elm_Store_Item_DBsystem;
27425 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
27426 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
27427 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27428 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
27429 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
27430 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
27431 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
27432 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
27434 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27435 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27436 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27437 typedef void (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
27438 typedef int (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
27439 typedef void (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
27440 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27444 ELM_STORE_ITEM_MAPPING_NONE = 0,
27445 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27446 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27447 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27448 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27449 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27450 // can add more here as needed by common apps
27451 ELM_STORE_ITEM_MAPPING_LAST
27452 } Elm_Store_Item_Mapping_Type;
27454 struct _Elm_Store_Item_Mapping_Icon
27456 // FIXME: allow edje file icons
27458 Elm_Icon_Lookup_Order lookup_order;
27459 Eina_Bool standard_name : 1;
27460 Eina_Bool no_scale : 1;
27461 Eina_Bool smooth : 1;
27462 Eina_Bool scale_up : 1;
27463 Eina_Bool scale_down : 1;
27466 struct _Elm_Store_Item_Mapping_Empty
27471 struct _Elm_Store_Item_Mapping_Photo
27476 struct _Elm_Store_Item_Mapping_Custom
27478 Elm_Store_Item_Mapping_Cb func;
27481 struct _Elm_Store_Item_Mapping
27483 Elm_Store_Item_Mapping_Type type;
27488 Elm_Store_Item_Mapping_Empty empty;
27489 Elm_Store_Item_Mapping_Icon icon;
27490 Elm_Store_Item_Mapping_Photo photo;
27491 Elm_Store_Item_Mapping_Custom custom;
27492 // add more types here
27496 struct _Elm_Store_Item_Info
27501 Eina_Bool rec_item;
27502 int pre_group_index;
27504 Elm_Genlist_Item_Class *item_class;
27505 const Elm_Store_Item_Mapping *mapping;
27510 struct _Elm_Store_Item_Info_Filesystem
27512 Elm_Store_Item_Info base;
27516 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27517 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27519 EAPI Elm_Store *elm_store_dbsystem_new(void);
27520 EAPI void elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
27521 EAPI void elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
27522 EAPI void elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
27523 EAPI void elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
27524 EAPI int elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27525 EAPI void *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27526 EAPI void elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
27527 EAPI int elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27528 EAPI Elm_Store_Item *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
27529 EAPI void elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27530 EAPI void elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
27531 EAPI void elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27532 EAPI void elm_store_free(Elm_Store *st);
27533 EAPI Elm_Store *elm_store_filesystem_new(void);
27534 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27535 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27536 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27538 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27540 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27541 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27542 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27543 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27544 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27545 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27547 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27548 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27549 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27550 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27551 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27552 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27553 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27556 * @defgroup SegmentControl SegmentControl
27557 * @ingroup Elementary
27559 * @image html img/widget/segment_control/preview-00.png
27560 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27562 * @image html img/segment_control.png
27563 * @image latex img/segment_control.eps width=\textwidth
27565 * Segment control widget is a horizontal control made of multiple segment
27566 * items, each segment item functioning similar to discrete two state button.
27567 * A segment control groups the items together and provides compact
27568 * single button with multiple equal size segments.
27570 * Segment item size is determined by base widget
27571 * size and the number of items added.
27572 * Only one segment item can be at selected state. A segment item can display
27573 * combination of Text and any Evas_Object like Images or other widget.
27575 * Smart callbacks one can listen to:
27576 * - "changed" - When the user clicks on a segment item which is not
27577 * previously selected and get selected. The event_info parameter is the
27578 * segment item pointer.
27580 * Available styles for it:
27583 * Here is an example on its usage:
27584 * @li @ref segment_control_example
27588 * @addtogroup SegmentControl
27592 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27595 * Add a new segment control widget to the given parent Elementary
27596 * (container) object.
27598 * @param parent The parent object.
27599 * @return a new segment control widget handle or @c NULL, on errors.
27601 * This function inserts a new segment control widget on the canvas.
27603 * @ingroup SegmentControl
27605 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27608 * Append a new item to the segment control object.
27610 * @param obj The segment control object.
27611 * @param icon The icon object to use for the left side of the item. An
27612 * icon can be any Evas object, but usually it is an icon created
27613 * with elm_icon_add().
27614 * @param label The label of the item.
27615 * Note that, NULL is different from empty string "".
27616 * @return The created item or @c NULL upon failure.
27618 * A new item will be created and appended to the segment control, i.e., will
27619 * be set as @b last item.
27621 * If it should be inserted at another position,
27622 * elm_segment_control_item_insert_at() should be used instead.
27624 * Items created with this function can be deleted with function
27625 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27627 * @note @p label set to @c NULL is different from empty string "".
27629 * only has icon, it will be displayed bigger and centered. If it has
27630 * icon and label, even that an empty string, icon will be smaller and
27631 * positioned at left.
27635 * sc = elm_segment_control_add(win);
27636 * ic = elm_icon_add(win);
27637 * elm_icon_file_set(ic, "path/to/image", NULL);
27638 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27639 * elm_segment_control_item_add(sc, ic, "label");
27640 * evas_object_show(sc);
27643 * @see elm_segment_control_item_insert_at()
27644 * @see elm_segment_control_item_del()
27646 * @ingroup SegmentControl
27648 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27651 * Insert a new item to the segment control object at specified position.
27653 * @param obj The segment control object.
27654 * @param icon The icon object to use for the left side of the item. An
27655 * icon can be any Evas object, but usually it is an icon created
27656 * with elm_icon_add().
27657 * @param label The label of the item.
27658 * @param index Item position. Value should be between 0 and items count.
27659 * @return The created item or @c NULL upon failure.
27661 * Index values must be between @c 0, when item will be prepended to
27662 * segment control, and items count, that can be get with
27663 * elm_segment_control_item_count_get(), case when item will be appended
27664 * to segment control, just like elm_segment_control_item_add().
27666 * Items created with this function can be deleted with function
27667 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27669 * @note @p label set to @c NULL is different from empty string "".
27671 * only has icon, it will be displayed bigger and centered. If it has
27672 * icon and label, even that an empty string, icon will be smaller and
27673 * positioned at left.
27675 * @see elm_segment_control_item_add()
27676 * @see elm_segment_control_item_count_get()
27677 * @see elm_segment_control_item_del()
27679 * @ingroup SegmentControl
27681 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);
27684 * Remove a segment control item from its parent, deleting it.
27686 * @param it The item to be removed.
27688 * Items can be added with elm_segment_control_item_add() or
27689 * elm_segment_control_item_insert_at().
27691 * @ingroup SegmentControl
27693 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27696 * Remove a segment control item at given index from its parent,
27699 * @param obj The segment control object.
27700 * @param index The position of the segment control item to be deleted.
27702 * Items can be added with elm_segment_control_item_add() or
27703 * elm_segment_control_item_insert_at().
27705 * @ingroup SegmentControl
27707 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27710 * Get the Segment items count from segment control.
27712 * @param obj The segment control object.
27713 * @return Segment items count.
27715 * It will just return the number of items added to segment control @p obj.
27717 * @ingroup SegmentControl
27719 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27722 * Get the item placed at specified index.
27724 * @param obj The segment control object.
27725 * @param index The index of the segment item.
27726 * @return The segment control item or @c NULL on failure.
27728 * Index is the position of an item in segment control widget. Its
27729 * range is from @c 0 to <tt> count - 1 </tt>.
27730 * Count is the number of items, that can be get with
27731 * elm_segment_control_item_count_get().
27733 * @ingroup SegmentControl
27735 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27738 * Get the label of item.
27740 * @param obj The segment control object.
27741 * @param index The index of the segment item.
27742 * @return The label of the item at @p index.
27744 * The return value is a pointer to the label associated to the item when
27745 * it was created, with function elm_segment_control_item_add(), or later
27746 * with function elm_segment_control_item_label_set. If no label
27747 * was passed as argument, it will return @c NULL.
27749 * @see elm_segment_control_item_label_set() for more details.
27750 * @see elm_segment_control_item_add()
27752 * @ingroup SegmentControl
27754 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27757 * Set the label of item.
27759 * @param it The item of segment control.
27760 * @param text The label of item.
27762 * The label to be displayed by the item.
27763 * Label will be at right of the icon (if set).
27765 * If a label was passed as argument on item creation, with function
27766 * elm_control_segment_item_add(), it will be already
27767 * displayed by the item.
27769 * @see elm_segment_control_item_label_get()
27770 * @see elm_segment_control_item_add()
27772 * @ingroup SegmentControl
27774 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
27777 * Get the icon associated to the item.
27779 * @param obj The segment control object.
27780 * @param index The index of the segment item.
27781 * @return The left side icon associated to the item at @p index.
27783 * The return value is a pointer to the icon associated to the item when
27784 * it was created, with function elm_segment_control_item_add(), or later
27785 * with function elm_segment_control_item_icon_set(). If no icon
27786 * was passed as argument, it will return @c NULL.
27788 * @see elm_segment_control_item_add()
27789 * @see elm_segment_control_item_icon_set()
27791 * @ingroup SegmentControl
27793 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27796 * Set the icon associated to the item.
27798 * @param it The segment control item.
27799 * @param icon The icon object to associate with @p it.
27801 * The icon object to use at left side of the item. An
27802 * icon can be any Evas object, but usually it is an icon created
27803 * with elm_icon_add().
27805 * Once the icon object is set, a previously set one will be deleted.
27806 * @warning Setting the same icon for two items will cause the icon to
27807 * dissapear from the first item.
27809 * If an icon was passed as argument on item creation, with function
27810 * elm_segment_control_item_add(), it will be already
27811 * associated to the item.
27813 * @see elm_segment_control_item_add()
27814 * @see elm_segment_control_item_icon_get()
27816 * @ingroup SegmentControl
27818 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27821 * Get the index of an item.
27823 * @param it The segment control item.
27824 * @return The position of item in segment control widget.
27826 * Index is the position of an item in segment control widget. Its
27827 * range is from @c 0 to <tt> count - 1 </tt>.
27828 * Count is the number of items, that can be get with
27829 * elm_segment_control_item_count_get().
27831 * @ingroup SegmentControl
27833 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27836 * Get the base object of the item.
27838 * @param it The segment control item.
27839 * @return The base object associated with @p it.
27841 * Base object is the @c Evas_Object that represents that item.
27843 * @ingroup SegmentControl
27845 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27848 * Get the selected item.
27850 * @param obj The segment control object.
27851 * @return The selected item or @c NULL if none of segment items is
27854 * The selected item can be unselected with function
27855 * elm_segment_control_item_selected_set().
27857 * The selected item always will be highlighted on segment control.
27859 * @ingroup SegmentControl
27861 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27864 * Set the selected state of an item.
27866 * @param it The segment control item
27867 * @param select The selected state
27869 * This sets the selected state of the given item @p it.
27870 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27872 * If a new item is selected the previosly selected will be unselected.
27873 * Previoulsy selected item can be get with function
27874 * elm_segment_control_item_selected_get().
27876 * The selected item always will be highlighted on segment control.
27878 * @see elm_segment_control_item_selected_get()
27880 * @ingroup SegmentControl
27882 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
27889 * @defgroup Grid Grid
27891 * The grid is a grid layout widget that lays out a series of children as a
27892 * fixed "grid" of widgets using a given percentage of the grid width and
27893 * height each using the child object.
27895 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
27896 * widgets size itself. The default is 100 x 100, so that means the
27897 * position and sizes of children will effectively be percentages (0 to 100)
27898 * of the width or height of the grid widget
27904 * Add a new grid to the parent
27906 * @param parent The parent object
27907 * @return The new object or NULL if it cannot be created
27911 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
27914 * Set the virtual size of the grid
27916 * @param obj The grid object
27917 * @param w The virtual width of the grid
27918 * @param h The virtual height of the grid
27922 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
27925 * Get the virtual size of the grid
27927 * @param obj The grid object
27928 * @param w Pointer to integer to store the virtual width of the grid
27929 * @param h Pointer to integer to store the virtual height of the grid
27933 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
27936 * Pack child at given position and size
27938 * @param obj The grid object
27939 * @param subobj The child to pack
27940 * @param x The virtual x coord at which to pack it
27941 * @param y The virtual y coord at which to pack it
27942 * @param w The virtual width at which to pack it
27943 * @param h The virtual height at which to pack it
27947 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
27950 * Unpack a child from a grid object
27952 * @param obj The grid object
27953 * @param subobj The child to unpack
27957 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
27960 * Faster way to remove all child objects from a grid object.
27962 * @param obj The grid object
27963 * @param clear If true, it will delete just removed children
27967 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
27970 * Set packing of an existing child at to position and size
27972 * @param subobj The child to set packing of
27973 * @param x The virtual x coord at which to pack it
27974 * @param y The virtual y coord at which to pack it
27975 * @param w The virtual width at which to pack it
27976 * @param h The virtual height at which to pack it
27980 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
27983 * get packing of a child
27985 * @param subobj The child to query
27986 * @param x Pointer to integer to store the virtual x coord
27987 * @param y Pointer to integer to store the virtual y coord
27988 * @param w Pointer to integer to store the virtual width
27989 * @param h Pointer to integer to store the virtual height
27993 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
27999 EAPI Evas_Object *elm_genscroller_add(Evas_Object *parent);
28000 EAPI void elm_genscroller_world_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
28002 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28003 EINA_DEPRECATED EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28004 EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28005 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28006 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
28007 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
28011 * @defgroup Video Video
28013 * @addtogroup Video
28016 * Elementary comes with two object that help design application that need
28017 * to display video. The main one, Elm_Video, display a video by using Emotion.
28018 * It does embedded the video inside an Edje object, so you can do some
28019 * animation depending on the video state change. It does also implement a
28020 * ressource management policy to remove this burden from the application writer.
28022 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28023 * It take care of updating its content according to Emotion event and provide a
28024 * way to theme itself. It also does automatically raise the priority of the
28025 * linked Elm_Video so it will use the video decoder if available. It also does
28026 * activate the remember function on the linked Elm_Video object.
28028 * Signals that you can add callback for are :
28030 * "forward,clicked" - the user clicked the forward button.
28031 * "info,clicked" - the user clicked the info button.
28032 * "next,clicked" - the user clicked the next button.
28033 * "pause,clicked" - the user clicked the pause button.
28034 * "play,clicked" - the user clicked the play button.
28035 * "prev,clicked" - the user clicked the prev button.
28036 * "rewind,clicked" - the user clicked the rewind button.
28037 * "stop,clicked" - the user clicked the stop button.
28039 * To set the video of the player, you can use elm_object_content_set() API.
28044 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28046 * @param parent The parent object
28047 * @return a new player widget handle or @c NULL, on errors.
28049 * This function inserts a new player widget on the canvas.
28051 * @see elm_object_content_set()
28055 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28058 * @brief Link a Elm_Payer with an Elm_Video object.
28060 * @param player the Elm_Player object.
28061 * @param video The Elm_Video object.
28063 * This mean that action on the player widget will affect the
28064 * video object and the state of the video will be reflected in
28065 * the player itself.
28067 * @see elm_player_add()
28068 * @see elm_video_add()
28072 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28075 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28077 * @param parent The parent object
28078 * @return a new video widget handle or @c NULL, on errors.
28080 * This function inserts a new video widget on the canvas.
28082 * @seeelm_video_file_set()
28083 * @see elm_video_uri_set()
28087 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28090 * @brief Define the file that will be the video source.
28092 * @param video The video object to define the file for.
28093 * @param filename The file to target.
28095 * This function will explicitly define a filename as a source
28096 * for the video of the Elm_Video object.
28098 * @see elm_video_uri_set()
28099 * @see elm_video_add()
28100 * @see elm_player_add()
28104 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28107 * @brief Define the uri that will be the video source.
28109 * @param video The video object to define the file for.
28110 * @param uri The uri to target.
28112 * This function will define an uri as a source for the video of the
28113 * Elm_Video object. URI could be remote source of video, like http:// or local source
28114 * like for example WebCam who are most of the time v4l2:// (but that depend and
28115 * you should use Emotion API to request and list the available Webcam on your system).
28117 * @see elm_video_file_set()
28118 * @see elm_video_add()
28119 * @see elm_player_add()
28123 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28126 * @brief Get the underlying Emotion object.
28128 * @param video The video object to proceed the request on.
28129 * @return the underlying Emotion object.
28133 EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28136 * @brief Start to play the video
28138 * @param video The video object to proceed the request on.
28140 * Start to play the video and cancel all suspend state.
28144 EAPI void elm_video_play(Evas_Object *video);
28147 * @brief Pause the video
28149 * @param video The video object to proceed the request on.
28151 * Pause the video and start a timer to trigger suspend mode.
28155 EAPI void elm_video_pause(Evas_Object *video);
28158 * @brief Stop the video
28160 * @param video The video object to proceed the request on.
28162 * Stop the video and put the emotion in deep sleep mode.
28166 EAPI void elm_video_stop(Evas_Object *video);
28169 * @brief Is the video actually playing.
28171 * @param video The video object to proceed the request on.
28172 * @return EINA_TRUE if the video is actually playing.
28174 * You should consider watching event on the object instead of polling
28175 * the object state.
28179 EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28182 * @brief Is it possible to seek inside the video.
28184 * @param video The video object to proceed the request on.
28185 * @return EINA_TRUE if is possible to seek inside the video.
28189 EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28192 * @brief Is the audio muted.
28194 * @param video The video object to proceed the request on.
28195 * @return EINA_TRUE if the audio is muted.
28199 EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28202 * @brief Change the mute state of the Elm_Video object.
28204 * @param video The video object to proceed the request on.
28205 * @param mute The new mute state.
28209 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28212 * @brief Get the audio level of the current video.
28214 * @param video The video object to proceed the request on.
28215 * @return the current audio level.
28219 EAPI double elm_video_audio_level_get(const Evas_Object *video);
28222 * @brief Set the audio level of anElm_Video object.
28224 * @param video The video object to proceed the request on.
28225 * @param volume The new audio volume.
28229 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28231 EAPI double elm_video_play_position_get(const Evas_Object *video);
28232 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28233 EAPI double elm_video_play_length_get(const Evas_Object *video);
28234 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28235 EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28236 EAPI const char *elm_video_title_get(const Evas_Object *video);
28241 // FIXME: incomplete - carousel. don't use this until this comment is removed
28242 typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
28243 EAPI Evas_Object *elm_carousel_add(Evas_Object *parent);
28244 EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
28245 EAPI void elm_carousel_item_del(Elm_Carousel_Item *item);
28246 EAPI void elm_carousel_item_select(Elm_Carousel_Item *item);
28247 /* smart callbacks called:
28248 * "clicked" - when the user clicks on a carousel item and becomes selected
28253 typedef enum _Elm_Datefield_ItemType
28255 ELM_DATEFIELD_YEAR = 0,
28256 ELM_DATEFIELD_MONTH,
28257 ELM_DATEFIELD_DATE,
28258 ELM_DATEFIELD_HOUR,
28259 ELM_DATEFIELD_MINUTE,
28261 } Elm_Datefield_ItemType;
28263 EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
28264 EAPI void elm_datefield_format_set(Evas_Object *obj, const char *fmt);
28265 EAPI char *elm_datefield_format_get(const Evas_Object *obj);
28266 EAPI void elm_datefield_item_enabled_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, Eina_Bool enable);
28267 EAPI Eina_Bool elm_datefield_item_enabled_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28268 EAPI void elm_datefield_item_value_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value);
28269 EAPI int elm_datefield_item_value_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28270 EAPI void elm_datefield_item_min_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28271 EAPI int elm_datefield_item_min_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28272 EAPI Eina_Bool elm_datefield_item_min_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28273 EAPI void elm_datefield_item_max_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28274 EAPI int elm_datefield_item_max_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28275 EAPI Eina_Bool elm_datefield_item_max_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28277 /* smart callbacks called:
28278 * "changed" - when datefield value is changed, this signal is sent.
28281 ////////////////////// DEPRECATED ///////////////////////////////////
28283 typedef enum _Elm_Datefield_Layout
28285 ELM_DATEFIELD_LAYOUT_TIME,
28286 ELM_DATEFIELD_LAYOUT_DATE,
28287 ELM_DATEFIELD_LAYOUT_DATEANDTIME
28288 } Elm_Datefield_Layout;
28290 EINA_DEPRECATED EAPI void elm_datefield_layout_set(Evas_Object *obj, Elm_Datefield_Layout layout);
28291 EINA_DEPRECATED EAPI Elm_Datefield_Layout elm_datefield_layout_get(const Evas_Object *obj);
28292 EINA_DEPRECATED EAPI void elm_datefield_date_format_set(Evas_Object *obj, const char *fmt);
28293 EINA_DEPRECATED EAPI const char *elm_datefield_date_format_get(const Evas_Object *obj);
28294 EINA_DEPRECATED EAPI void elm_datefield_time_mode_set(Evas_Object *obj, Eina_Bool mode);
28295 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_time_mode_get(const Evas_Object *obj);
28296 EINA_DEPRECATED EAPI void elm_datefield_date_set(Evas_Object *obj, int year, int month, int day, int hour, int min);
28297 EINA_DEPRECATED EAPI void elm_datefield_date_get(const Evas_Object *obj, int *year, int *month, int *day, int *hour, int *min);
28298 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_max_set(Evas_Object *obj, int year, int month, int day);
28299 EINA_DEPRECATED EAPI void elm_datefield_date_max_get(const Evas_Object *obj, int *year, int *month, int *day);
28300 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_min_set(Evas_Object *obj, int year, int month, int day);
28301 EINA_DEPRECATED EAPI void elm_datefield_date_min_get(const Evas_Object *obj, int *year, int *month, int *day);
28302 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);
28303 EINA_DEPRECATED EAPI void elm_datefield_input_panel_state_callback_del(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value));
28304 /////////////////////////////////////////////////////////////////////
28307 typedef enum _Elm_Popup_Response
28309 ELM_POPUP_RESPONSE_NONE = -1,
28310 ELM_POPUP_RESPONSE_TIMEOUT = -2,
28311 ELM_POPUP_RESPONSE_OK = -3,
28312 ELM_POPUP_RESPONSE_CANCEL = -4,
28313 ELM_POPUP_RESPONSE_CLOSE = -5
28314 } Elm_Popup_Response;
28316 typedef enum _Elm_Popup_Mode
28318 ELM_POPUP_TYPE_NONE = 0,
28319 ELM_POPUP_TYPE_ALERT = (1 << 0)
28322 typedef enum _Elm_Popup_Orient
28324 ELM_POPUP_ORIENT_TOP,
28325 ELM_POPUP_ORIENT_CENTER,
28326 ELM_POPUP_ORIENT_BOTTOM,
28327 ELM_POPUP_ORIENT_LEFT,
28328 ELM_POPUP_ORIENT_RIGHT,
28329 ELM_POPUP_ORIENT_TOP_LEFT,
28330 ELM_POPUP_ORIENT_TOP_RIGHT,
28331 ELM_POPUP_ORIENT_BOTTOM_LEFT,
28332 ELM_POPUP_ORIENT_BOTTOM_RIGHT
28333 } Elm_Popup_Orient;
28335 /* smart callbacks called:
28336 * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
28339 EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
28340 EAPI void elm_popup_desc_set(Evas_Object *obj, const char *text);
28341 EAPI const char *elm_popup_desc_get(Evas_Object *obj);
28342 EAPI void elm_popup_title_label_set(Evas_Object *obj, const char *text);
28343 EAPI const char *elm_popup_title_label_get(Evas_Object *obj);
28344 EAPI void elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
28345 EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
28346 EAPI void elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
28347 EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
28348 EAPI void elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text, ...);
28349 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, ... );
28350 EAPI void elm_popup_timeout_set(Evas_Object *obj, double timeout);
28351 EAPI void elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
28352 EAPI void elm_popup_response(Evas_Object *obj, int response_id);
28353 EAPI void elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
28354 EAPI int elm_popup_run(Evas_Object *obj);
28356 /* NavigationBar */
28357 #define NAVIBAR_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28358 #define NAVIBAR_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28362 ELM_NAVIGATIONBAR_FUNCTION_BUTTON1,
28363 ELM_NAVIGATIONBAR_FUNCTION_BUTTON2,
28364 ELM_NAVIGATIONBAR_FUNCTION_BUTTON3,
28365 ELM_NAVIGATIONBAR_BACK_BUTTON
28366 } Elm_Navi_Button_Type;
28368 EAPI Evas_Object *elm_navigationbar_add(Evas_Object *parent);
28369 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);
28370 EAPI void elm_navigationbar_pop(Evas_Object *obj);
28371 EAPI void elm_navigationbar_to_content_pop(Evas_Object *obj, Evas_Object *content);
28372 EAPI void elm_navigationbar_title_label_set(Evas_Object *obj, Evas_Object *content, const char *title);
28373 EAPI const char *elm_navigationbar_title_label_get(Evas_Object *obj, Evas_Object *content);
28374 EAPI void elm_navigationbar_title_object_add(Evas_Object *obj, Evas_Object *content, Evas_Object *title_obj);
28375 EAPI Evas_Object *elm_navigationbar_title_object_get(Evas_Object *obj, Evas_Object *content);
28376 EAPI Eina_List *elm_navigationbar_title_object_list_get(Evas_Object *obj, Evas_Object *content);
28377 EAPI Evas_Object *elm_navigationbar_content_top_get(Evas_Object *obj);
28378 EAPI Evas_Object *elm_navigationbar_content_bottom_get(Evas_Object *obj);
28379 EAPI void elm_navigationbar_hidden_set(Evas_Object *obj, Eina_Bool hidden);
28380 EAPI void elm_navigationbar_title_button_set(Evas_Object *obj, Evas_Object *content, Evas_Object *button, Elm_Navi_Button_Type button_type);
28381 EAPI Evas_Object *elm_navigationbar_title_button_get(Evas_Object *obj, Evas_Object *content, Elm_Navi_Button_Type button_type);
28382 EAPI const char *elm_navigationbar_subtitle_label_get(Evas_Object *obj, Evas_Object *content);
28383 EAPI void elm_navigationbar_subtitle_label_set(Evas_Object *obj, Evas_Object *content, const char *subtitle);
28384 EAPI void elm_navigationbar_title_object_list_unset(Evas_Object *obj, Evas_Object *content, Eina_List **list);
28385 EAPI void elm_navigationbar_animation_disabled_set(Evas_Object *obj, Eina_Bool disable);
28386 EAPI void elm_navigationbar_title_object_visible_set(Evas_Object *obj, Evas_Object *content, Eina_Bool visible);
28387 Eina_Bool elm_navigationbar_title_object_visible_get(Evas_Object *obj, Evas_Object *content);
28388 EAPI void elm_navigationbar_title_icon_set(Evas_Object *obj, Evas_Object *content, Evas_Object *icon);
28389 EAPI Evas_Object *elm_navigationbar_title_icon_get(Evas_Object *obj, Evas_Object *content);
28391 /* NavigationBar */
28392 #define NAVIBAR_EX_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28393 #define NAVIBAR_EX_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28397 ELM_NAVIGATIONBAR_EX_BACK_BUTTON,
28398 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON1,
28399 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON2,
28400 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON3,
28401 ELM_NAVIGATIONBAR_EX_MAX
28402 } Elm_Navi_ex_Button_Type;
28403 typedef struct _Elm_Navigationbar_ex_Item Elm_Navigationbar_ex_Item;
28405 EAPI Evas_Object *elm_navigationbar_ex_add(Evas_Object *parent);
28406 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_push(Evas_Object *obj, Evas_Object *content, const char *item_style);
28407 EAPI void elm_navigationbar_ex_item_pop(Evas_Object *obj);
28408 EAPI void elm_navigationbar_ex_item_promote(Elm_Navigationbar_ex_Item* item);
28409 EAPI void elm_navigationbar_ex_to_item_pop(Elm_Navigationbar_ex_Item* item);
28410 EAPI void elm_navigationbar_ex_item_title_label_set(Elm_Navigationbar_ex_Item *item, const char *title);
28411 EAPI const char *elm_navigationbar_ex_item_title_label_get(Elm_Navigationbar_ex_Item* item);
28412 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_top_get(const Evas_Object *obj);
28413 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_bottom_get(const Evas_Object *obj);
28414 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);
28415 EAPI Evas_Object *elm_navigationbar_ex_item_title_button_get(Elm_Navigationbar_ex_Item* item, int button_type);
28416 EAPI void elm_navigationbar_ex_item_title_object_set(Elm_Navigationbar_ex_Item* item, Evas_Object *title_obj);
28417 EAPI Evas_Object *elm_navigationbar_ex_item_title_object_unset(Elm_Navigationbar_ex_Item* item);
28418 EAPI void elm_navigationbar_ex_item_title_hidden_set(Elm_Navigationbar_ex_Item* item, Eina_Bool hidden);
28419 EAPI Evas_Object *elm_navigationbar_ex_item_title_object_get(Elm_Navigationbar_ex_Item* item);
28420 EAPI const char *elm_navigationbar_ex_item_subtitle_label_get(Elm_Navigationbar_ex_Item* item);
28421 EAPI void elm_navigationbar_ex_item_subtitle_label_set( Elm_Navigationbar_ex_Item* item, const char *subtitle);
28422 EAPI void elm_navigationbar_ex_item_style_set(Elm_Navigationbar_ex_Item* item, const char* item_style);
28423 EAPI const char *elm_navigationbar_ex_item_style_get(Elm_Navigationbar_ex_Item* item);
28424 EAPI Evas_Object *elm_navigationbar_ex_item_content_unset(Elm_Navigationbar_ex_Item* item);
28425 EAPI Evas_Object *elm_navigationbar_ex_item_content_get(Elm_Navigationbar_ex_Item* item);
28426 EAPI void elm_navigationbar_ex_delete_on_pop_set(Evas_Object *obj, Eina_Bool del_on_pop);
28427 EAPI Evas_Object *elm_navigationbar_ex_item_icon_get(Elm_Navigationbar_ex_Item* item);
28428 EAPI void elm_navigationbar_ex_item_icon_set(Elm_Navigationbar_ex_Item* item, Evas_Object *icon);
28429 EAPI Evas_Object *elm_navigationbar_ex_item_title_button_unset(Elm_Navigationbar_ex_Item* item, int button_type);
28430 EAPI void elm_navigationbar_ex_animation_disable_set(Evas_Object *obj, Eina_Bool disable);
28431 EAPI void elm_navigationbar_ex_title_object_visible_set(Elm_Navigationbar_ex_Item* item, Eina_Bool visible);
28432 Eina_Bool elm_navigationbar_ex_title_object_visible_get(Elm_Navigationbar_ex_Item* item);
28435 * @defgroup Naviframe Naviframe
28436 * @ingroup Elementary
28438 * @brief Naviframe is a kind of view manager for the applications.
28440 * Naviframe provides functions to switch different pages with stack
28441 * mechanism. It means if one page(item) needs to be changed to the new one,
28442 * then naviframe would push the new page to it's internal stack. Of course,
28443 * it can be back to the previous page by popping the top page. Naviframe
28444 * provides some transition effect while the pages are switching (same as
28447 * Since each item could keep the different styles, users could keep the
28448 * same look & feel for the pages or different styles for the items in it's
28451 * Signals that you can add callback for are:
28452 * @li "transition,finished" - When the transition is finished in changing
28454 * @li "title,clicked" - User clicked title area
28456 * Default contents parts of the naviframe items that you can use for are:
28457 * @li "elm.swallow.content" - A main content of the page
28458 * @li "elm.swallow.icon" - A icon in the title area
28459 * @li "elm.swallow.prev_btn" - A button to go to the previous page
28460 * @li "elm.swallow.next_btn" - A button to go to the next page
28462 * Default text parts of the naviframe items that you can use for are:
28463 * @li "elm.text.title" - Title label in the title area
28464 * @li "elm.text.subtitle" - Sub-title label in the title area
28466 * @ref tutorial_naviframe gives a good overview of the usage of the API.
28469 //Available commonly
28470 #define ELM_NAVIFRAME_ITEM_CONTENT "elm.swallow.content"
28471 #define ELM_NAVIFRAME_ITEM_ICON "elm.swallow.icon"
28472 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER "elm.swallow.optionheader"
28473 #define ELM_NAVIFRAME_ITEM_TITLE_LABEL "elm.text.title"
28474 #define ELM_NAVIFRAME_ITEM_PREV_BTN "elm.swallow.prev_btn"
28475 #define ELM_NAVIFRAME_ITEM_TITLE_LEFT_BTN "elm.swallow.left_btn"
28476 #define ELM_NAVIFRAME_ITEM_TITLE_RIGHT_BTN "elm.swallow.right_btn"
28477 #define ELM_NAVIFRAME_ITEM_TITLE_MORE_BTN "elm.swallow.more_btn"
28478 #define ELM_NAVIFRAME_ITEM_CONTROLBAR "elm.swallow.controlbar"
28479 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_CLOSE "elm,state,optionheader,close", ""
28480 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_OPEN "elm,state,optionheader,open", ""
28481 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_CLOSE "elm,state,optionheader,instant_close", ""
28482 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_OPEN "elm,state,optionheader,instant_open", ""
28484 //Available only in a style - "2line"
28485 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER2 "elm.swallow.optionheader2"
28487 //Available only in a style - "segment"
28488 #define ELM_NAVIFRAME_ITEM_SEGMENT2 "elm.swallow.segment2"
28489 #define ELM_NAVIFRAME_ITEM_SEGMENT3 "elm.swallow.segment3"
28492 * @addtogroup Naviframe
28497 * @brief Add a new Naviframe object to the parent.
28499 * @param parent Parent object
28500 * @return New object or @c NULL, if it cannot be created
28502 * @ingroup Naviframe
28504 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28506 * @brief Push a new item to the top of the naviframe stack (and show it).
28508 * @param obj The naviframe object
28509 * @param title_label The label in the title area. The name of the title
28510 * label part is "elm.text.title"
28511 * @param prev_btn The button to go to the previous item. If it is NULL,
28512 * then naviframe will create a back button automatically. The name of
28513 * the prev_btn part is "elm.swallow.prev_btn"
28514 * @param next_btn The button to go to the next item. Or It could be just an
28515 * extra function button. The name of the next_btn part is
28516 * "elm.swallow.next_btn"
28517 * @param content The main content object. The name of content part is
28518 * "elm.swallow.content"
28519 * @param item_style The current item style name. @c NULL would be default.
28520 * @return The created item or @c NULL upon failure.
28522 * The item pushed becomes one page of the naviframe, this item will be
28523 * deleted when it is popped.
28525 * @see also elm_naviframe_item_style_set()
28526 * @see also elm_naviframe_item_insert_before()
28527 * @see also elm_naviframe_item_insert_after()
28529 * The following styles are available for this item:
28532 * @ingroup Naviframe
28534 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);
28536 * @brief Insert a new item into the naviframe before item @p before.
28538 * @param before The naviframe item to insert before.
28539 * @param title_label The label in the title area. The name of the title
28540 * label part is "elm.text.title"
28541 * @param prev_btn The button to go to the previous item. If it is NULL,
28542 * then naviframe will create a back button automatically. The name of
28543 * the prev_btn part is "elm.swallow.prev_btn"
28544 * @param next_btn The button to go to the next item. Or It could be just an
28545 * extra function button. The name of the next_btn part is
28546 * "elm.swallow.next_btn"
28547 * @param content The main content object. The name of content part is
28548 * "elm.swallow.content"
28549 * @param item_style The current item style name. @c NULL would be default.
28550 * @return The created item or @c NULL upon failure.
28552 * The item is inserted into the naviframe straight away without any
28553 * transition operations. This item will be deleted when it is popped.
28555 * @see also elm_naviframe_item_style_set()
28556 * @see also elm_naviframe_item_push()
28557 * @see also elm_naviframe_item_insert_after()
28559 * The following styles are available for this item:
28562 * @ingroup Naviframe
28564 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);
28566 * @brief Insert a new item into the naviframe after item @p after.
28568 * @param after The naviframe item to insert after.
28569 * @param title_label The label in the title area. The name of the title
28570 * label part is "elm.text.title"
28571 * @param prev_btn The button to go to the previous item. If it is NULL,
28572 * then naviframe will create a back button automatically. The name of
28573 * the prev_btn part is "elm.swallow.prev_btn"
28574 * @param next_btn The button to go to the next item. Or It could be just an
28575 * extra function button. The name of the next_btn part is
28576 * "elm.swallow.next_btn"
28577 * @param content The main content object. The name of content part is
28578 * "elm.swallow.content"
28579 * @param item_style The current item style name. @c NULL would be default.
28580 * @return The created item or @c NULL upon failure.
28582 * The item is inserted into the naviframe straight away without any
28583 * transition operations. This item will be deleted when it is popped.
28585 * @see also elm_naviframe_item_style_set()
28586 * @see also elm_naviframe_item_push()
28587 * @see also elm_naviframe_item_insert_before()
28589 * The following styles are available for this item:
28592 * @ingroup Naviframe
28594 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);
28596 * @brief Pop an item that is on top of the stack
28598 * @param obj The naviframe object
28599 * @return @c NULL or the content object(if the
28600 * elm_naviframe_content_preserve_on_pop_get is true).
28602 * This pops an item that is on the top(visible) of the naviframe, makes it
28603 * disappear, then deletes the item. The item that was underneath it on the
28604 * stack will become visible.
28606 * @see also elm_naviframe_content_preserve_on_pop_get()
28608 * @ingroup Naviframe
28610 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28612 * @brief Pop the items between the top and the above one on the given item.
28614 * @param it The naviframe item
28616 * @ingroup Naviframe
28618 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28620 * Promote an item already in the naviframe stack to the top of the stack
28622 * @param it The naviframe item
28624 * This will take the indicated item and promote it to the top of the stack
28625 * as if it had been pushed there. The item must already be inside the
28626 * naviframe stack to work.
28629 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28631 * @brief Delete the given item instantly.
28633 * @param it The naviframe item
28635 * This just deletes the given item from the naviframe item list instantly.
28636 * So this would not emit any signals for view transitions but just change
28637 * the current view if the given item is a top one.
28639 * @ingroup Naviframe
28641 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28643 * @brief preserve the content objects when items are popped.
28645 * @param obj The naviframe object
28646 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28648 * @see also elm_naviframe_content_preserve_on_pop_get()
28650 * @ingroup Naviframe
28652 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28654 * @brief Get a value whether preserve mode is enabled or not.
28656 * @param obj The naviframe object
28657 * @return If @c EINA_TRUE, preserve mode is enabled
28659 * @see also elm_naviframe_content_preserve_on_pop_set()
28661 * @ingroup Naviframe
28663 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28665 * @brief Get a top item on the naviframe stack
28667 * @param obj The naviframe object
28668 * @return The top item on the naviframe stack or @c NULL, if the stack is
28671 * @ingroup Naviframe
28673 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28675 * @brief Get a bottom item on the naviframe stack
28677 * @param obj The naviframe object
28678 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28681 * @ingroup Naviframe
28683 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28685 * @brief Set an item style
28687 * @param obj The naviframe item
28688 * @param item_style The current item style name. @c NULL would be default
28690 * The following styles are available for this item:
28693 * @see also elm_naviframe_item_style_get()
28695 * @ingroup Naviframe
28697 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28699 * @brief Get an item style
28701 * @param obj The naviframe item
28702 * @return The current item style name
28704 * @see also elm_naviframe_item_style_set()
28706 * @ingroup Naviframe
28708 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28710 * @brief Show/Hide the title area
28712 * @param it The naviframe item
28713 * @param visible If @c EINA_TRUE, title area will be visible, hidden
28716 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
28718 * @see also elm_naviframe_item_title_visible_get()
28720 * @ingroup Naviframe
28722 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28724 * @brief Get a value whether title area is visible or not.
28726 * @param it The naviframe item
28727 * @return If @c EINA_TRUE, title area is visible
28729 * @see also elm_naviframe_item_title_visible_set()
28731 * @ingroup Naviframe
28733 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28736 * @brief Set creating prev button automatically or not
28738 * @param obj The naviframe object
28739 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28740 * be created internally when you pass the @c NULL to the prev_btn
28741 * parameter in elm_naviframe_item_push
28743 * @see also elm_naviframe_item_push()
28745 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28747 * @brief Get a value whether prev button(back button) will be auto pushed or
28750 * @param obj The naviframe object
28751 * @return If @c EINA_TRUE, prev button will be auto pushed.
28753 * @see also elm_naviframe_item_push()
28754 * elm_naviframe_prev_btn_auto_pushed_set()
28756 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28758 * @brief Get a list of all the naviframe items.
28760 * @param obj The naviframe object
28761 * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
28762 * or @c NULL on failure.
28764 EAPI Eina_Inlist *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28771 #define CONTROLBAR_SYSTEM_ICON_ALBUMS "controlbar_albums"
28772 #define CONTROLBAR_SYSTEM_ICON_ARTISTS "controlbar_artists"
28773 #define CONTROLBAR_SYSTEM_ICON_SONGS "controlbar_songs"
28774 #define CONTROLBAR_SYSTEM_ICON_PLAYLIST "controlbar_playlist"
28775 #define CONTROLBAR_SYSTEM_ICON_MORE "controlbar_more"
28776 #define CONTROLBAR_SYSTEM_ICON_CONTACTS "controlbar_contacts"
28777 #define CONTROLBAR_SYSTEM_ICON_DIALER "controlbar_dialer"
28778 #define CONTROLBAR_SYSTEM_ICON_FAVORITES "controlbar_favorites"
28779 #define CONTROLBAR_SYSTEM_ICON_LOGS "controlbar_logs"
28781 typedef enum _Elm_Controlbar_Mode_Type
28783 ELM_CONTROLBAR_MODE_DEFAULT = 0,
28784 ELM_CONTROLBAR_MODE_TRANSLUCENCE,
28785 ELM_CONTROLBAR_MODE_TRANSPARENCY,
28786 ELM_CONTROLBAR_MODE_LARGE,
28787 ELM_CONTROLBAR_MODE_SMALL,
28788 ELM_CONTROLBAR_MODE_LEFT,
28789 ELM_CONTROLBAR_MODE_RIGHT
28790 } Elm_Controlbar_Mode_Type;
28792 typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
28793 EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
28794 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
28795 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
28796 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);
28797 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);
28798 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);
28799 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);
28800 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);
28801 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);
28802 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
28803 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
28804 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
28805 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
28806 EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
28807 EAPI void elm_controlbar_item_del(Elm_Controlbar_Item *it);
28808 EAPI void elm_controlbar_item_select(Elm_Controlbar_Item *it);
28809 EAPI void elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
28810 EAPI Eina_Bool elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
28811 EAPI void elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
28812 EAPI Eina_Bool elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
28813 EAPI void elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
28814 EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
28815 EAPI void elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
28816 EAPI const char *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
28817 EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
28818 EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
28819 EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
28820 EAPI const Eina_List *elm_controlbar_items_get(const Evas_Object *obj);
28821 EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
28822 EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
28823 EAPI void elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
28824 EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
28825 EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
28826 EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
28827 EAPI void elm_controlbar_mode_set(Evas_Object *obj, int mode);
28828 EAPI void elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
28829 EAPI void elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
28830 EAPI void elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
28833 EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
28834 EAPI void elm_searchbar_text_set(Evas_Object *obj, const char *entry);
28835 EAPI const char *elm_searchbar_text_get(Evas_Object *obj);
28836 EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
28837 EAPI Evas_Object *elm_searchbar_editfield_get(Evas_Object *obj);
28838 EAPI void elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
28839 EAPI void elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
28840 EAPI void elm_searchbar_clear(Evas_Object *obj);
28841 EAPI void elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);
28843 EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
28844 EAPI void elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
28845 EAPI void elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
28846 EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
28849 EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
28850 EAPI void elm_nocontents_label_set(Evas_Object *obj, const char *label);
28851 EAPI const char *elm_nocontents_label_get(const Evas_Object *obj);
28852 EAPI void elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
28853 EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
28858 ELM_TICKERNOTI_ORIENT_TOP = 0,
28859 ELM_TICKERNOTI_ORIENT_BOTTOM,
28860 ELM_TICKERNOTI_ORIENT_LAST
28861 } Elm_Tickernoti_Orient;
28863 EAPI Evas_Object *elm_tickernoti_add (Evas_Object *parent);
28864 EAPI void elm_tickernoti_orient_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
28865 EAPI Elm_Tickernoti_Orient elm_tickernoti_orient_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28866 EAPI int elm_tickernoti_rotation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28867 EAPI void elm_tickernoti_rotation_set (Evas_Object *obj, int angle) EINA_ARG_NONNULL(1);
28868 EAPI Evas_Object *elm_tickernoti_win_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28869 /* #### Below APIs and data structures are going to be deprecated, announcment will be made soon ####*/
28872 ELM_TICKERNOTI_DEFAULT,
28873 ELM_TICKERNOTI_DETAILVIEW
28874 } Elm_Tickernoti_Mode;
28875 EAPI void elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
28876 EAPI const char *elm_tickernoti_detailview_label_get (const Evas_Object *obj)EINA_ARG_NONNULL(1);
28877 EAPI void elm_tickernoti_detailview_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(2);
28878 EAPI Evas_Object *elm_tickernoti_detailview_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28879 EAPI void elm_tickernoti_detailview_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
28880 EAPI Evas_Object *elm_tickernoti_detailview_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28881 EAPI Evas_Object *elm_tickernoti_detailview_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28882 EAPI void elm_tickernoti_mode_set (Evas_Object *obj, Elm_Tickernoti_Mode mode) EINA_ARG_NONNULL(1);
28883 EAPI Elm_Tickernoti_Mode elm_tickernoti_mode_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28884 EAPI void elm_tickernoti_orientation_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
28885 EAPI Elm_Tickernoti_Orient elm_tickernoti_orientation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28886 EAPI void elm_tickernoti_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
28887 EAPI const char *elm_tickernoti_label_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28888 EAPI void elm_tickernoti_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
28889 EAPI Evas_Object *elm_tickernoti_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28890 EAPI void elm_tickernoti_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(1);
28891 EAPI Evas_Object *elm_tickernoti_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28892 /* ############################################################################### */
28894 * Parts which can be used with elm_object_text_part_set() and
28895 * elm_object_text_part_get():
28897 * @li NULL/"default" - Operates on tickernoti content-text
28899 * Parts which can be used with elm_object_content_part_set() and
28900 * elm_object_content_part_get():
28902 * @li "icon" - Operates on tickernoti's icon
28903 * @li "button" - Operates on tickernoti's button
28905 * smart callbacks called:
28906 * @li "clicked" - emitted when tickernoti is clicked, except at the
28907 * swallow/button region, if any.
28908 * @li "hide" - emitted when the tickernoti is completely hidden. In case of
28909 * any hide animation, this signal is emitted after the animation.
28913 typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
28915 struct _Colorpalette_Color
28917 unsigned int r, g, b;
28920 EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
28921 EAPI void elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
28922 EAPI void elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
28923 /* smart callbacks called:
28924 * "clicked" - when image clicked
28928 EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
28929 EAPI void elm_editfield_label_set(Evas_Object *obj, const char *label);
28930 EAPI const char *elm_editfield_label_get(Evas_Object *obj);
28931 EAPI void elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
28932 EAPI const char *elm_editfield_guide_text_get(Evas_Object *obj);
28933 EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
28934 // EAPI Evas_Object *elm_editfield_clear_button_show(Evas_Object *obj, Eina_Bool show);
28935 EAPI void elm_editfield_right_icon_set(Evas_Object *obj, Evas_Object *icon);
28936 EAPI Evas_Object *elm_editfield_right_icon_get(Evas_Object *obj);
28937 EAPI void elm_editfield_left_icon_set(Evas_Object *obj, Evas_Object *icon);
28938 EAPI Evas_Object *elm_editfield_left_icon_get(Evas_Object *obj);
28939 EAPI void elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
28940 EAPI Eina_Bool elm_editfield_entry_single_line_get(Evas_Object *obj);
28941 EAPI void elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
28942 EAPI Eina_Bool elm_editfield_eraser_get(Evas_Object *obj);
28943 /* smart callbacks called:
28944 * "clicked" - when an editfield is clicked
28945 * "unfocused" - when an editfield is unfocused
28949 /* Sliding Drawer */
28950 typedef enum _Elm_SlidingDrawer_Pos
28952 ELM_SLIDINGDRAWER_BOTTOM,
28953 ELM_SLIDINGDRAWER_LEFT,
28954 ELM_SLIDINGDRAWER_RIGHT,
28955 ELM_SLIDINGDRAWER_TOP
28956 } Elm_SlidingDrawer_Pos;
28958 typedef struct _Elm_SlidingDrawer_Drag_Value
28961 } Elm_SlidingDrawer_Drag_Value;
28963 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_add(Evas_Object *parent);
28964 EINA_DEPRECATED EAPI void elm_slidingdrawer_content_set (Evas_Object *obj, Evas_Object *content);
28965 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_content_unset(Evas_Object *obj);
28966 EINA_DEPRECATED EAPI void elm_slidingdrawer_pos_set(Evas_Object *obj, Elm_SlidingDrawer_Pos pos);
28967 EINA_DEPRECATED EAPI void elm_slidingdrawer_max_drag_value_set(Evas_Object *obj, double dw, double dh);
28968 EINA_DEPRECATED EAPI void elm_slidingdrawer_drag_value_set(Evas_Object *obj, double dx, double dy);
28970 /* multibuttonentry */
28971 typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
28972 typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
28973 EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent);
28974 EAPI const char *elm_multibuttonentry_label_get(Evas_Object *obj);
28975 EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
28976 EAPI Evas_Object *elm_multibuttonentry_entry_get(Evas_Object *obj);
28977 EAPI const char * elm_multibuttonentry_guide_text_get(Evas_Object *obj);
28978 EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
28979 EAPI int elm_multibuttonentry_contracted_state_get(Evas_Object *obj);
28980 EAPI void elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
28981 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
28982 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
28983 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
28984 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
28985 EAPI const Eina_List *elm_multibuttonentry_items_get(Evas_Object *obj);
28986 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(Evas_Object *obj);
28987 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(Evas_Object *obj);
28988 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(Evas_Object *obj);
28989 EAPI void elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
28990 EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
28991 EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
28992 EAPI void elm_multibuttonentry_items_del(Evas_Object *obj);
28993 EAPI const char *elm_multibuttonentry_item_label_get(Elm_Multibuttonentry_Item *item);
28994 EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
28995 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
28996 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
28997 EAPI void *elm_multibuttonentry_item_data_get(Elm_Multibuttonentry_Item *item);
28998 EAPI void elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
28999 EAPI void elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
29000 /* smart callback called:
29001 * "selected" - This signal is emitted when the selected item of multibuttonentry is changed.
29002 * "added" - This signal is emitted when a new multibuttonentry item is added.
29003 * "deleted" - This signal is emitted when a multibuttonentry item is deleted.
29004 * "expanded" - This signal is emitted when a multibuttonentry is expanded.
29005 * "contracted" - This signal is emitted when a multibuttonentry is contracted.
29006 * "contracted,state,changed" - This signal is emitted when the contracted state of multibuttonentry is changed.
29007 * "item,selected" - This signal is emitted when the selected item of multibuttonentry is changed.
29008 * "item,added" - This signal is emitted when a new multibuttonentry item is added.
29009 * "item,deleted" - This signal is emitted when a multibuttonentry item is deleted.
29010 * "item,clicked" - This signal is emitted when a multibuttonentry item is clicked.
29011 * "clicked" - This signal is emitted when a multibuttonentry is clicked.
29012 * "unfocused" - This signal is emitted when a multibuttonentry is unfocused.
29014 /* available styles:
29019 typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
29020 EAPI Evas_Object *elm_stackedicon_add(Evas_Object *parent);
29021 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
29022 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
29023 EAPI void elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
29024 EAPI Eina_List *elm_stackedicon_item_list_get(Evas_Object *obj);
29025 /* smart callback called:
29026 * "expanded" - This signal is emitted when a stackedicon is expanded.
29027 * "clicked" - This signal is emitted when a stackedicon is clicked.
29029 /* available styles:
29033 /* dialoguegroup */
29034 typedef struct _Dialogue_Item Dialogue_Item;
29036 typedef enum _Elm_Dialoguegourp_Item_Style
29038 ELM_DIALOGUEGROUP_ITEM_STYLE_DEFAULT = 0,
29039 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD = (1 << 0),
29040 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD_WITH_TITLE = (1 << 1),
29041 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_TITLE = (1 << 2),
29042 ELM_DIALOGUEGROUP_ITEM_STYLE_HIDDEN = (1 << 3),
29043 ELM_DIALOGUEGROUP_ITEM_STYLE_DATAVIEW = (1 << 4),
29044 ELM_DIALOGUEGROUP_ITEM_STYLE_NO_BG = (1 << 5),
29045 ELM_DIALOGUEGROUP_ITEM_STYLE_SUB = (1 << 6),
29046 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT = (1 << 7),
29047 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_MERGE = (1 << 8),
29048 ELM_DIALOGUEGROUP_ITEM_STYLE_LAST = (1 << 9)
29049 } Elm_Dialoguegroup_Item_Style;
29051 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_add(Evas_Object *parent);
29052 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_append(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
29053 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_prepend(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
29054 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_after(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *after, Elm_Dialoguegroup_Item_Style style);
29055 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_before(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *before, Elm_Dialoguegroup_Item_Style style);
29056 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove(Dialogue_Item *item);
29057 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove_all(Evas_Object *obj);
29058 EINA_DEPRECATED EAPI void elm_dialoguegroup_title_set(Evas_Object *obj, const char *title);
29059 EINA_DEPRECATED EAPI const char *elm_dialoguegroup_title_get(Evas_Object *obj);
29060 EINA_DEPRECATED EAPI void elm_dialoguegroup_press_effect_set(Dialogue_Item *item, Eina_Bool press);
29061 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_press_effect_get(Dialogue_Item *item);
29062 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_item_content_get(Dialogue_Item *item);
29063 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_style_set(Dialogue_Item *item, Elm_Dialoguegroup_Item_Style style);
29064 EINA_DEPRECATED EAPI Elm_Dialoguegroup_Item_Style elm_dialoguegroup_item_style_get(Dialogue_Item *item);
29065 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_disabled_set(Dialogue_Item *item, Eina_Bool disabled);
29066 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_item_disabled_get(Dialogue_Item *item);
29071 ELM_DAYSELECTOR_SUN,
29072 ELM_DAYSELECTOR_MON,
29073 ELM_DAYSELECTOR_TUE,
29074 ELM_DAYSELECTOR_WED,
29075 ELM_DAYSELECTOR_THU,
29076 ELM_DAYSELECTOR_FRI,
29077 ELM_DAYSELECTOR_SAT
29078 } Elm_DaySelector_Day;
29080 EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
29081 EAPI Eina_Bool elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
29082 EAPI void elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
29085 typedef struct _Imageslider_Item Elm_Imageslider_Item;
29086 typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
29087 EAPI Evas_Object *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
29088 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);
29089 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);
29090 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);
29091 EAPI void elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29092 EAPI Elm_Imageslider_Item *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
29093 EAPI Eina_Bool elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29094 EAPI void elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29095 EAPI const char *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29096 EAPI Elm_Imageslider_Item *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29097 EAPI Elm_Imageslider_Item *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29098 EAPI void elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
29099 EAPI void elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
29100 EAPI void elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
29101 EAPI void elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);